org.osid.calendaring

Interface OffsetEventCalendarAssignmentSession

All Superinterfaces:

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

public interface OffsetEventCalendarAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignOffsetEventToCalendar(Id offsetEventId, Id calendarId) Adds an existing OffsetEvent to a Calendar.
boolean	canAssignOffsetEvents() Tests if this user can alter offset event/calendar mappings.
boolean	canAssignOffsetEventsToCalendar(Id calendarId) Tests if this user can alter offset event/calendar mappings.
IdList	getAssignableCalendarIds(Id calendarId) Gets a list of calendars including and under the given calendar node in which any offset event can be assigned.
IdList	getAssignableCalendarIdsForOffsetEvent(Id calendarId, Id offsetEventId) Gets a list of calendars including and under the given calendar node in which a specific offset event can be assigned.
void	unassignOffsetEventFromCalendar(Id offsetEventId, Id calendarId) Removes an OffsetEvent 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

canAssignOffsetEvents

boolean canAssignOffsetEvents()

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

canAssignOffsetEventsToCalendar

boolean canAssignOffsetEventsToCalendar(Id calendarId)

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

getAssignableCalendarIdsForOffsetEvent

IdList getAssignableCalendarIdsForOffsetEvent(Id calendarId,
                                            Id offsetEventId)
                                              throws OperationFailedException

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

Parameters:

calendarId - the Id of the Calendar

offsetEventId - the Id of the offsetEventId

Returns:

list of assignable calendar Ids

Throws:

NullArgumentException - calendarId or offsetEventId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignOffsetEventToCalendar

void assignOffsetEventToCalendar(Id offsetEventId,
                               Id calendarId)
                                 throws AlreadyExistsException,
                                        NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Adds an existing OffsetEvent to a Calendar.

Parameters:

offsetEventId - the Id of the OffsetEvent

calendarId - the Id of the Calendar

Throws:

AlreadyExistsException - offsetEventId is already assigned to calendarId

NotFoundException - offsetEventId or calendarId not found

NullArgumentException - offsetEventId or calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignOffsetEventFromCalendar

void unassignOffsetEventFromCalendar(Id offsetEventId,
                                   Id calendarId)
                                     throws NotFoundException,
                                            OperationFailedException,
                                            PermissionDeniedException

Removes an OffsetEvent from a Calendar.

Parameters:

offsetEventId - the Id of the OffsetEvent

calendarId - the Id of the Calendar

Throws:

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

NullArgumentException - offsetEventId or calendarId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.