org.osid.calendaring

Interface SupersedingEventCalendarAssignmentSession

All Superinterfaces:

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

public interface SupersedingEventCalendarAssignmentSession
extends OsidSession

This session provides methods to re-assign SupersedingEvents to Calendars. A SupersedingEvent may map to multiple Calendars and removing the last reference to a SupersedingEvent 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 SupersedingEvent to another Calendar is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignSupersedingEventToCalendar(Id supersedingEventId, Id calendarId) Adds an existing SupersedingEvent to a Calendar.
boolean	canAssignSupersedingEvents() Tests if this user can alter superseding event/calendar mappings.
boolean	canAssignSupersedingEventsToCalendar(Id calendarId) Tests if this user can alter superseding event/calendar mappings.
IdList	getAssignableCalendarIds(Id calendarId) Gets a list of calendars including and under the given calendar node in which any superseding event can be assigned.
IdList	getAssignableCalendarIdsForSupersedingEvent(Id calendarId, Id supersedingEventId) Gets a list of calendars including and under the given calendar node in which a specific superseding event can be assigned.
void	reassignSupersedingEventToCalendar(Id supersedingEventId, Id fromBillingId, Id toBiillingId) Moves a SupersedingEvent from one Calendar to another.
void	unassignSupersedingEventFromCalendar(Id supersedingEventId, Id calendarId) Removes a SupersedingEvent 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

canAssignSupersedingEvents

boolean canAssignSupersedingEvents()

Tests if this user can alter superseding event/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.

canAssignSupersedingEventsToCalendar

boolean canAssignSupersedingEventsToCalendar(Id calendarId)

Tests if this user can alter superseding event/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 superseding event 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.

getAssignableCalendarIdsForSupersedingEvent

IdList getAssignableCalendarIdsForSupersedingEvent(Id calendarId,
                                                 Id supersedingEventId)
                                                   throws OperationFailedException

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

Parameters:

calendarId - the Id of the Calendar

supersedingEventId - the Id of the supersedingEventId

Returns:

list of assignable calendar Ids

Throws:

NullArgumentException - calendarId or supersedingEventId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignSupersedingEventToCalendar

void assignSupersedingEventToCalendar(Id supersedingEventId,
                                    Id calendarId)
                                      throws AlreadyExistsException,
                                             NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Adds an existing SupersedingEvent to a Calendar.

Parameters:

supersedingEventId - the Id of the SupersedingEvent

calendarId - the Id of the Calendar

Throws:

AlreadyExistsException - supersedingEventId is already assigned to calendarId

NotFoundException - supersedingEventId or calendarId not found

NullArgumentException - supersedingEventId or calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignSupersedingEventFromCalendar

void unassignSupersedingEventFromCalendar(Id supersedingEventId,
                                        Id calendarId)
                                          throws NotFoundException,
                                                 OperationFailedException,
                                                 PermissionDeniedException

Removes a SupersedingEvent from a Calendar.

Parameters:

supersedingEventId - the Id of the SupersedingEvent

calendarId - the Id of the Calendar

Throws:

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

NullArgumentException - supersedingEventId or calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignSupersedingEventToCalendar

void reassignSupersedingEventToCalendar(Id supersedingEventId,
                                      Id fromBillingId,
                                      Id toBiillingId)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

supersedingEventId - the Id of the SupersedingeEvent

fromBillingId - the Id of the current Calendar

toBiillingId - the Id of the destination Calendar

Throws:

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

NullArgumentException - supersedingEventId, fromCalendarId, or toCalendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.