Interface SupersedingEventEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface SupersedingEventEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply SupersedingEventEnablers to SupersedingEvents . A SupersedingEvent with multiple SupersedingEventEnablers means any positive rule evaluation across the enablers result in an effective SupersedingEvent .

Method Summary

Modifier and Type	Method	Description
void	assignSupersedingEventEnablerToSupersedingEvent(Id supersedingEventEnablerId, Id supersedingEventId)	Adds an existing SupersedingEventEnabler to a SupersedingEvent .
boolean	canAssignSupersedingEventEnablers()	Tests if this user can alter superseding event enabler/superseding event mappings.
boolean	canSequenceSupersedingEventEnablers()	Tests if this user can order SupersedingEventEnablers .
Calendar	getCalendar()	Gets the Calendar associated with this session.
Id	getCalendarId()	Gets the Calendar Id associated with this session.
void	moveSupersedingEventEnablerAhead(Id supersedingEventEnablerId, Id supersedingEventId, Id referenceId)	Reorders superseding event enablers for a superseding event by moving the specified superseding event enabler in front of a reference superseding event enabler.
void	moveSupersedingEventEnablerBehind(Id supersedingEventEnablerId, Id supersedingEventId, Id referenceId)	Reorders superseding event enablers for a superseding event by moving the specified superseding event enabler behind a reference superseding event enabler.
void	orderSupersedingEventEnablers(Id[] supersedingEventEnablerIds, Id supersedingEventId)	Reorders a set of superseding event enablers for a superseding event.
void	unassignSupersedingEventEnablerFromSupersedingEvent(Id supersedingEventEnablerId, Id supersedingEventId)	Removes a SupersedingEventEnabler from a SupersedingEvent .

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.

canAssignSupersedingEventEnablers

boolean canAssignSupersedingEventEnablers()

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

assignSupersedingEventEnablerToSupersedingEvent

void assignSupersedingEventEnablerToSupersedingEvent(Id supersedingEventEnablerId,
 Id supersedingEventId)
                                              throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing SupersedingEventEnabler to a SupersedingEvent .

Parameters:

supersedingEventEnablerId - the Id of the SupersedingEventEnabler

supersedingEventId - the Id of the SupersedingEvent

Throws:

AlreadyExistsException - supersedingEventEnablerId already applied to supersedingEventId

NotFoundException - supersedingEventEnablerId or supersedingEventId not found

NullArgumentException - supersedingEventEnablerId or supersedingEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignSupersedingEventEnablerFromSupersedingEvent

void unassignSupersedingEventEnablerFromSupersedingEvent(Id supersedingEventEnablerId,
 Id supersedingEventId)
                                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a SupersedingEventEnabler from a SupersedingEvent .

Parameters:

supersedingEventEnablerId - the Id of the SupersedingEventEnabler

supersedingEventId - the Id of the Calendar

Throws:

NotFoundException - supersedingEventEnablerId or supersedingEventId not found or supersedingEventEnablerId not applied to supersedingEventId

NullArgumentException - supersedingEventEnablerId or supersedingEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceSupersedingEventEnablers

boolean canSequenceSupersedingEventEnablers()

Tests if this user can order SupersedingEventEnablers . 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 SupersedingEventEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveSupersedingEventEnablerAhead

void moveSupersedingEventEnablerAhead(Id supersedingEventEnablerId,
 Id supersedingEventId,
 Id referenceId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

supersedingEventEnablerId - the Id of a SupersedingEventEnabler

supersedingEventId - the Id of a SupersedingEvent

referenceId - the reference superseding event enabler Id

Throws:

NotFoundException - supersedingEventEnablerId, supersedingEventId , or referenceId not found or, supersedingEventEnablerId or referenceId not related to supersedingEventId

NullArgumentException - supersedingEventEnablerId, supersedingEventId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveSupersedingEventEnablerBehind

void moveSupersedingEventEnablerBehind(Id supersedingEventEnablerId,
 Id supersedingEventId,
 Id referenceId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

supersedingEventEnablerId - the Id of a SupersedingEventEnabler

supersedingEventId - the Id of a SupersedingEvent

referenceId - the reference superseding event enabler Id

Throws:

NotFoundException - supersedingEventEnablerId, supersedingEventId , or referenceId not found or, supersedingEventEnablerId or referenceId not related to supersedingEventId

NullArgumentException - supersedingEventEnablerId, supersedingEventId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderSupersedingEventEnablers

void orderSupersedingEventEnablers(Id[] supersedingEventEnablerIds,
 Id supersedingEventId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

supersedingEventEnablerIds - the Ids for a set of SupersedingEventEnablerIds

supersedingEventId - the Id of a SupersedingEvent

Throws:

NotFoundException - supersedingEventId not found or, an supersedingEventEnablerId not related to supersedingEventId

NullArgumentException - supersedingEventEnablerIds or supersedingEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.