org.osid.calendaring.rules

Interface RecurringEventEnablerAdminSession

All Superinterfaces:

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

public interface RecurringEventEnablerAdminSession
extends OsidSession

This session creates and removes recurring event enablers. The data for create and update is provided via the RecurringEventEnablerForm.

Method Summary

Methods

Modifier and Type	Method and Description
void	aliasEventEnabler(Id recurringEventEnablerId, Id aliasId) Adds an Id to a RecurringEventEnabler for the purpose of creating compatibility.
boolean	canCreateRecurringEventEnabler() Tests if this user can create recurring event enablers.
boolean	canCreateRecurringEventEnablerWithRecordTypes(Type[] recurringEventEnablerRecordTypes) Tests if this user can create a single RecurringEventEnabler using the desired record types.
boolean	canDeleteEventEnablers() Tests if this user can delete recurring event enablers.
boolean	canManageEventEnablerAliases() Tests if this user can manage Id aliases for recurring event enablers.
boolean	canUpdateRecurringEventEnablers() Tests if this user can update recurring event enablers.
RecurringEventEnabler	createRecurringEventEnabler(RecurringEventEnablerForm recurringEventEnablerForm) Creates a new RecurringEventEnabler.
void	deleteEventEnabler(Id recurringEventEnablerId) Deletes a RecurringEventEnabler.
Calendar	getCalendar() Gets the Calendar associated with this session.
Id	getCalendarId() Gets the Calendar Id associated with this session.
RecurringEventEnablerForm	getRecurringEventEnablerFormForCreate(Type[] recurringEventEnablerRecordTypes) Gets the recurring event enabler form for creating new recurring event enablers.
RecurringEventEnablerForm	getRecurringEventEnablerFormForUpdate(Id recurringEventEnablerId) Gets the recurring event enabler form for updating an existing recurring event enabler.
void	updateRecurringEventEnabler(RecurringEventEnablerForm recurringEventEnablerForm) Updates an existing recurring event enabler.

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

getCalendarId

Id getCalendarId()

Gets the Calendar Id associated with this session.

Returns:

the Calendar Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCalendar

Calendar getCalendar()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Calendar associated with this session.

Returns:

the calendar

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateRecurringEventEnabler

boolean canCreateRecurringEventEnabler()

Tests if this user can create recurring event enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a RecurringEventEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returns:

false if RecurringEventEnabler creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreateRecurringEventEnablerWithRecordTypes

boolean canCreateRecurringEventEnablerWithRecordTypes(Type[] recurringEventEnablerRecordTypes)

Tests if this user can create a single RecurringEventEnabler using the desired record types. While CalendarRulesManager.getRecurringEventEnablerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific RecurringEventEnabler. Providing an empty array tests if a RecurringEventEnabler can be created with no records.

Parameters:

recurringEventEnablerRecordTypes - array of recurring event enabler record types

Returns:

true if RecurringEventEnabler creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - recurringEventEnablerRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablerFormForCreate

RecurringEventEnablerForm getRecurringEventEnablerFormForCreate(Type[] recurringEventEnablerRecordTypes)
                                                                throws OperationFailedException,
                                                                       PermissionDeniedException

Gets the recurring event enabler form for creating new recurring event enablers. A new form should be requested for each create transaction.

Parameters:

recurringEventEnablerRecordTypes - array of recurring event enabler record types

Returns:

the recurring event enabler form

Throws:

NullArgumentException - recurringEventEnablerRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createRecurringEventEnabler

RecurringEventEnabler createRecurringEventEnabler(RecurringEventEnablerForm recurringEventEnablerForm)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Creates a new RecurringEventEnabler.

Parameters:

recurringEventEnablerForm - the form for this RecurringEventEnabler

Returns:

the new RecurringEventEnabler

Throws:

IllegalStateException - recurringEventEnablerForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - recurringEventEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - recurringEventEnablerForm did not originate from getRecurringEventEnablerFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateRecurringEventEnablers

boolean canUpdateRecurringEventEnablers()

Tests if this user can update recurring event enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a RecurringEventEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returns:

false if RecurringEventEnabler modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getRecurringEventEnablerFormForUpdate

RecurringEventEnablerForm getRecurringEventEnablerFormForUpdate(Id recurringEventEnablerId)
                                                                throws NotFoundException,
                                                                       OperationFailedException,
                                                                       PermissionDeniedException

Gets the recurring event enabler form for updating an existing recurring event enabler. A new recurring event enabler form should be requested for each update transaction.

Parameters:

recurringEventEnablerId - the Id of the RecurringEventEnabler

Returns:

the recurring event enabler form

Throws:

NotFoundException - recurringEventEnablerId is not found

NullArgumentException - recurringEventEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateRecurringEventEnabler

void updateRecurringEventEnabler(RecurringEventEnablerForm recurringEventEnablerForm)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Updates an existing recurring event enabler.

Parameters:

recurringEventEnablerForm - the form containing the elements to be updated

Throws:

IllegalStateException - recurringEventEnablerForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - recurringEventEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - recurringEventEnablerForm did not originate from getRecurringEventEnablerFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteEventEnablers

boolean canDeleteEventEnablers()

Tests if this user can delete recurring event enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a RecurringEventEnabler will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returns:

false if RecurringEventEnabler deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deleteEventEnabler

void deleteEventEnabler(Id recurringEventEnablerId)
                        throws NotFoundException,
                               OperationFailedException,
                               PermissionDeniedException

Deletes a RecurringEventEnabler.

Parameters:

recurringEventEnablerId - the Id of the RecurringEventEnabler to remove

Throws:

NotFoundException - recurrintEventEnablerId not found

NullArgumentException - recurringEventEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageEventEnablerAliases

boolean canManageEventEnablerAliases()

Tests if this user can manage Id aliases for recurring event enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returns:

true if RecurringEventEnabler aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasEventEnabler

void aliasEventEnabler(Id recurringEventEnablerId,
                     Id aliasId)
                       throws AlreadyExistsException,
                              NotFoundException,
                              OperationFailedException,
                              PermissionDeniedException

Adds an Id to a RecurringEventEnabler for the purpose of creating compatibility. The primary Id of the RecurringEventEnabler is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another recurring event enabler. it is reassigned to the given recurring event enabler Id.

Parameters:

recurringEventEnablerId - the Id of a RecurringEventEnabler

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - recurringEventEnablerId not found

NullArgumentException - recurringEventEnablerId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.