org.osid.calendaring

Interface ScheduleSlotCalendarAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface ScheduleSlotCalendarAssignmentSession
extends OsidSession

This session provides methods to re-assign ScheduleSlots to Calendars. A ScheduleSlot may map to multiple Calendars and removing the last reference to a ScheduleSlot is the equivalent of deleting it. Each Calendar may have its own authorizations governing who is allowed to operate on it.

Moving or adding a reference of a ScheduleSlot to another Calendar is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignScheduleSlotToCalendar(Id scheduleSlotId, Id calendarId) Adds an existing ScheduleSlot to a Calendar.
boolean	canAssignScheduleSlots() Tests if this user can alter schedule slot/calendar mappings.
boolean	canAssignScheduleSlotsToCalendar(Id calendarId) Tests if this user can alter schedule slot/calendar mappings.
IdList	getAssignableCalendarIds(Id calendarId) Gets a list of calendars including and under the given calendar node in which any schedule slot can be assigned.
IdList	getAssignableCalendarIdsForScheduleSlot(Id calendarId, Id scheduleSlotId) Gets a list of calendars including and under the given calendar node in which a specific schedule slot can be assigned.
void	reassignScheduleSlotToCalendar(Id scheduleSlotId, Id fromBillingId, Id toBiillingId) Moves a ScheduleSlot from one Calendar to another.
void	unassignScheduleSlotFromCalendar(Id scheduleSlotId, Id calendarId) Removes a ScheduleSlot from a Calendar.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canAssignScheduleSlots

boolean canAssignScheduleSlots()

Tests if this user can alter schedule slot/calendar mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignScheduleSlotsToCalendar

boolean canAssignScheduleSlotsToCalendar(Id calendarId)

Tests if this user can alter schedule slot/calendar mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parameters:

calendarId - the Id of the Calendar

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - calendarId is null

Compliance:

mandatory - This method must be implemented.

getAssignableCalendarIds

IdList getAssignableCalendarIds(Id calendarId)
                                throws OperationFailedException

Gets a list of calendars including and under the given calendar node in which any schedule slot can be assigned.

Parameters:

calendarId - the Id of the Calendar

Returns:

list of assignable calendar Ids

Throws:

NullArgumentException - calendarId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableCalendarIdsForScheduleSlot

IdList getAssignableCalendarIdsForScheduleSlot(Id calendarId,
                                             Id scheduleSlotId)
                                               throws OperationFailedException

Gets a list of calendars including and under the given calendar node in which a specific schedule slot can be assigned.

Parameters:

calendarId - the Id of the Calendar

scheduleSlotId - the Id of the ScheduleSlot

Returns:

list of assignable calendar Ids

Throws:

NullArgumentException - calendarId or scheduleSlotId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignScheduleSlotToCalendar

void assignScheduleSlotToCalendar(Id scheduleSlotId,
                                Id calendarId)
                                  throws AlreadyExistsException,
                                         NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Adds an existing ScheduleSlot to a Calendar.

Parameters:

scheduleSlotId - the Id of the ScheduleSlot

calendarId - the Id of the Calendar

Throws:

AlreadyExistsException - scheduleSlotId is already assigned to calendarId

NotFoundException - scheduleSlotId or calendarId not found

NullArgumentException - scheduleSlotId or calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignScheduleSlotFromCalendar

void unassignScheduleSlotFromCalendar(Id scheduleSlotId,
                                    Id calendarId)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Removes a ScheduleSlot from a Calendar.

Parameters:

scheduleSlotId - the Id of the ScheduleSlot

calendarId - the Id of the Calendar

Throws:

NotFoundException - scheduleSlotId or calendarId not found or scheduleSlotId not assigned to calendarId

NullArgumentException - scheduleSlotId or calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignScheduleSlotToCalendar

void reassignScheduleSlotToCalendar(Id scheduleSlotId,
                                  Id fromBillingId,
                                  Id toBiillingId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

Moves a ScheduleSlot from one Calendar to another. Mappings to other Calendars are unaffected.

Parameters:

scheduleSlotId - the Id of the ScheduleSlot

fromBillingId - the Id of the current Calendar

toBiillingId - the Id of the destination Calendar

Throws:

NotFoundException - scheduleSlotId, fromCalendarId, or toCalendarId not found or scheduleSlotId not mapped to fromCalendarId

NullArgumentException - scheduleSlotId, fromCalendarId, or toCalendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.