Interface RecurringEventEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface RecurringEventEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply RecurringEventEnablers to RecurringEvents . A RecurringEvent with multiple RecurringEventEnablers means any positive rule evaluation across the enablers result in an effective RecurringEvent .

Method Summary

Modifier and Type	Method	Description
void	assignRecurringEventEnablerToRecurringEvent(Id recurringEventEnablerId, Id recurringEventId)	Adds an existing RecurringEventEnabler to a RecurringEvent .
boolean	canAssignRecurringEventEnablerRules()	Tests if this user can alter recurring event enabler/recurring event mappings.
boolean	canSequenceRecurringEventEnablers()	Tests if this user can order RecurringEventEnablers .
Calendar	getCalendar()	Gets the Calendar associated with this session.
Id	getCalendarId()	Gets the Calendar Id associated with this session.
void	moveRecurringEventEnablerAhead(Id recurringEventEnablerId, Id recurringEventId, Id referenceId)	Reorders recurring event enablers for a recurring event by moving the specified recurring event enabler in front of a reference recurring event enabler.
void	moveRecurringEventEnablerBehind(Id recurringEventEnablerId, Id recurringEventId, Id referenceId)	Reorders recurring event enablers for a recurring event by moving the specified recurring event enabler behind a reference recurring event enabler.
void	orderRecurringEventEnablers(Id[] recurringEventEnablerIds, Id recurringEventId)	Reorders a set of recurring event enablers for a recurring event.
void	unassignRecurringEventEnablerFromRecurringEvent(Id recurringEventEnablerId, Id recurringEventId)	Removes a RecurringEventEnabler from a RecurringEvent .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.

canAssignRecurringEventEnablerRules

boolean canAssignRecurringEventEnablerRules()

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

assignRecurringEventEnablerToRecurringEvent

void assignRecurringEventEnablerToRecurringEvent(Id recurringEventEnablerId,
 Id recurringEventId)
                                          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing RecurringEventEnabler to a RecurringEvent .

Parameters:

recurringEventEnablerId - the Id of the RecurringEventEnabler

recurringEventId - the Id of the RecurringEvent

Throws:

AlreadyExistsException - recurringEventEnablerId already applied to recurringEventId

NotFoundException - recurringEventEnablerId or recurringEventId not found

NullArgumentException - recurringEventEnablerId or recurringEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignRecurringEventEnablerFromRecurringEvent

void unassignRecurringEventEnablerFromRecurringEvent(Id recurringEventEnablerId,
 Id recurringEventId)
                                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a RecurringEventEnabler from a RecurringEvent .

Parameters:

recurringEventEnablerId - the Id of the RecurringEventEnabler

recurringEventId - the Id of the RecurringEvent

Throws:

NotFoundException - recurringEventEnablerId or recurringEventId not found or recurringEventEnablerId not applied to recurringEventId

NullArgumentException - recurringEventEnablerId or recurringEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceRecurringEventEnablers

boolean canSequenceRecurringEventEnablers()

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

Returns:

false if RecurringEventEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveRecurringEventEnablerAhead

void moveRecurringEventEnablerAhead(Id recurringEventEnablerId,
 Id recurringEventId,
 Id referenceId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders recurring event enablers for a recurring event by moving the specified recurring event enabler in front of a reference recurring event enabler.

Parameters:

recurringEventEnablerId - the Id of a RecurringEventEnabler

recurringEventId - the Id of a RecurringEvent

referenceId - the reference recurring event enabler Id

Throws:

NotFoundException - recurringEventEnablerId, recurringEventId , or referenceId not found or, recurringEventEnablerId or referenceId not related to recurringEventId

NullArgumentException - recurringEventEnablerId, recurringEventId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveRecurringEventEnablerBehind

void moveRecurringEventEnablerBehind(Id recurringEventEnablerId,
 Id recurringEventId,
 Id referenceId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders recurring event enablers for a recurring event by moving the specified recurring event enabler behind a reference recurring event enabler.

Parameters:

recurringEventEnablerId - the Id of a RecurringEventEnabler

recurringEventId - the Id of a RecurringEvent

referenceId - the reference recurring event enabler Id

Throws:

NotFoundException - recurringEventEnablerId, recurringEventId , or referenceId not found or, recurringEventEnablerId or referenceId not related to recurringEventId

NullArgumentException - recurringEventEnablerId, recurringEventId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderRecurringEventEnablers

void orderRecurringEventEnablers(Id[] recurringEventEnablerIds,
 Id recurringEventId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of recurring event enablers for a recurring event.

Parameters:

recurringEventEnablerIds - the Ids for a set of RecurringEventEnablers

recurringEventId - the Id of a RecurringEvent

Throws:

NotFoundException - recurringEventEnablerId not related to recurringEventId

NullArgumentException - rceurringEventEnablerIds or recurringEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.