org.osid.calendaring.rules

Interface SupersedingEventEnablerCalendarAssignmentSession

All Superinterfaces:

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

public interface SupersedingEventEnablerCalendarAssignmentSession
extends OsidSession

This session provides methods to re-assign SupersedingEventEnabler to Calendar mappings. A SupersedingEventEnabler may appear in multiple Calendar objects and removing the last reference to a SupersedingEventEnabler is the equivalent of deleting it. Each Calendar may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a SupersedingEventEnabler to another Calendar is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignSupersedingEventEnablerToCalendar(Id supersedingEventEnablerId, Id calendarId) Adds an existing SupersedingEventEnabler to an Calendar.
boolean	canAssignSupersedingEventEnablers() Tests if this user can alter superseding event enabler/calendar mappings.
boolean	canAssignSupersedingEventEnablersToCalendar(Id calendarId) Tests if this user can alter superseding event enabler/calendar mappings.
IdList	getAssignableCalendarIds(Id calendarId) Gets a list of calendars including and under the given calendar node in which any superseding event enabler can be assigned.
IdList	getAssignableCalendarIdsForSupersedingEventEnabler(Id calendarId, Id supersedingEventEnablerId) Gets a list of calendars including and under the given calendar node in which a specific superseding event enabler can be assigned.
void	reassignSupersedingEventEnablerToCalendar(Id supersedingEventEnablerId, Id fromCalendarId, Id toCalendarId) Moves a SupersedingEventEnabler from one Calendar to another.
void	unassignSupersedingEventEnablerFromCalendar(Id supersedingEventEnablerId, Id calendarId) Removes a SupersedingEventEnabler from an 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

canAssignSupersedingEventEnablers

boolean canAssignSupersedingEventEnablers()

Tests if this user can alter superseding event enabler/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 lookup operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignSupersedingEventEnablersToCalendar

boolean canAssignSupersedingEventEnablersToCalendar(Id calendarId)

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

getAssignableCalendarIdsForSupersedingEventEnabler

IdList getAssignableCalendarIdsForSupersedingEventEnabler(Id calendarId,
                                                        Id supersedingEventEnablerId)
                                                          throws OperationFailedException

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

Parameters:

calendarId - the Id of the Calendar

supersedingEventEnablerId - the Id of the SupersedingEventEnabler

Returns:

list of assignable calendar Ids

Throws:

NullArgumentException - calendarId or supersedingEventEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignSupersedingEventEnablerToCalendar

void assignSupersedingEventEnablerToCalendar(Id supersedingEventEnablerId,
                                           Id calendarId)
                                             throws AlreadyExistsException,
                                                    NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Adds an existing SupersedingEventEnabler to an Calendar.

Parameters:

supersedingEventEnablerId - the Id of the SupersedingEventEnabler

calendarId - the Id of the Calendar

Throws:

AlreadyExistsException - supersedingEventEnablerId already assigned to calendarId

NotFoundException - supersedingEventEnablerId or calendarId not found

NullArgumentException - supersedingEventEnablerId or calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignSupersedingEventEnablerFromCalendar

void unassignSupersedingEventEnablerFromCalendar(Id supersedingEventEnablerId,
                                               Id calendarId)
                                                 throws NotFoundException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Removes a SupersedingEventEnabler from an Calendar.

Parameters:

supersedingEventEnablerId - the Id of the SupersedingEventEnabler

calendarId - the Id of the Calendar

Throws:

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

NullArgumentException - supersedingEventEnablerId or calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignSupersedingEventEnablerToCalendar

void reassignSupersedingEventEnablerToCalendar(Id supersedingEventEnablerId,
                                             Id fromCalendarId,
                                             Id toCalendarId)
                                               throws NotFoundException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

supersedingEventEnablerId - the Id of the SupersedingEventEnabler

fromCalendarId - the Id of the current Calendar

toCalendarId - the Id of the destination Calendar

Throws:

NotFoundException - supersedingEventEnablerId, fromCalendarId, supersedingEventEnablerId not mapped to fromCalendarId

NullArgumentException - supersedingEventEnablerId, fromCalendarId, or toCalendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.