org.osid.calendaring.rules

Interface RecurringEventEnablerCalendarAssignmentSession

All Superinterfaces:

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

public interface RecurringEventEnablerCalendarAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignRecurringEventEnablerToCalendar(Id recurringEventEnablerId, Id calendarId) Adds an existing RecurringEventEnabler to an Calendar.
boolean	canAssignRecurringEventEnablers() Tests if this user can alter recurring event enabler/calendar mappings.
boolean	canAssignRecurringEventEnablersToCalendar(Id calendarId) Tests if this user can alter recurring event enabler/calendar mappings.
IdList	getAssignableCalendarIds(Id calendarId) Gets a list of calendars including and under the given calendar node in which any recurring event enabler can be assigned.
IdList	getAssignableCalendarIdsForRecurringEventEnabler(Id calendarId, Id recuringEventEnablerId) Gets a list of calendars including and under the given calendar node in which a specific recurring event enabler can be assigned.
void	unassignRecurringEventEnablerFromCalendar(Id recurringEventEnablerId, Id calendarId) Removes a RecurringEventEnabler 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

canAssignRecurringEventEnablers

boolean canAssignRecurringEventEnablers()

Tests if this user can alter recurring 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.

canAssignRecurringEventEnablersToCalendar

boolean canAssignRecurringEventEnablersToCalendar(Id calendarId)

Tests if this user can alter recurring 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 recurring 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.

getAssignableCalendarIdsForRecurringEventEnabler

IdList getAssignableCalendarIdsForRecurringEventEnabler(Id calendarId,
                                                      Id recuringEventEnablerId)
                                                        throws OperationFailedException

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

Parameters:

calendarId - the Id of the Calendar

recuringEventEnablerId - the Id of the RecurringEventEnabler

Returns:

list of assignable calendar Ids

Throws:

NullArgumentException - calendarId or recurringEventEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignRecurringEventEnablerToCalendar

void assignRecurringEventEnablerToCalendar(Id recurringEventEnablerId,
                                         Id calendarId)
                                           throws AlreadyExistsException,
                                                  NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Adds an existing RecurringEventEnabler to an Calendar.

Parameters:

recurringEventEnablerId - the Id of the RecurringEventEnabler

calendarId - the Id of the Calendar

Throws:

AlreadyExistsException - recurringEventEnablerId already mapped to calendarId

NotFoundException - recurringEventEnablerId or calendarId not found

NullArgumentException - recurringEventEnablerId or calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignRecurringEventEnablerFromCalendar

void unassignRecurringEventEnablerFromCalendar(Id recurringEventEnablerId,
                                             Id calendarId)
                                               throws NotFoundException,
                                                      OperationFailedException,
                                                      PermissionDeniedException

Removes a RecurringEventEnabler from an Calendar.

Parameters:

recurringEventEnablerId - the Id of the RecurringEventEnabler

calendarId - the Id of the Calendar

Throws:

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

NullArgumentException - recurringEventEnablerId or calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.