Interface OffsetEventEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface OffsetEventEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply OffsetEventEnablers to OffsetEvents . An OffsetEvent with multiple OffsetEventEnablers means any positive rule evaluation across the enablers result in an effective OffsetEvent .

Method Summary

Modifier and Type	Method	Description
void	assignOffsetEventEnablerToOffsetEvent(Id offsetEventEnablerId, Id offsetEventId)	Adds an existing OffsetEventEnabler to an OffsetEvents .
boolean	canAssignOffsetEventEnablerRules()	Tests if this user can alter offset event enabler/offset event mappings.
boolean	canSequenceOffsetEventEnablers()	Tests if this user can order OffsetEventEnablers .
Calendar	getCalendar()	Gets the Calendar associated with this session.
Id	getCalendarId()	Gets the Calendar Id associated with this session.
void	moveOffsetEventEnablerAhead(Id offsetEventEnablerId, Id offsetEventId, Id referenceId)	Reorders offset event enablers for an offset event by moving the specified offset event enabler in front of a reference offset event enabler.
void	moveOffsetEventEnablerBehind(Id offsetEventEnablerId, Id offsetEventId, Id referenceId)	Reorders offset event enablers for an offset event by moving the specified offset event enabler behind a reference offset event enabler.
void	orderOffsetEventEnablers(Id[] offsetEventEnablerIds, Id offsetEventId)	Reorders a set of offset event enablers for an offset event.
void	unassignOffsetEventEnablerFromOffsetEvent(Id offsetEventEnablerId, Id offsetEventId)	Removes an OffsetEventEnabler from an OffsetEvent .

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.

canAssignOffsetEventEnablerRules

boolean canAssignOffsetEventEnablerRules()

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

assignOffsetEventEnablerToOffsetEvent

void assignOffsetEventEnablerToOffsetEvent(Id offsetEventEnablerId,
 Id offsetEventId)
                                    throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing OffsetEventEnabler to an OffsetEvents .

Parameters:

offsetEventEnablerId - the Id of the OffsetEventEnabler

offsetEventId - the Id of the OffsetEvent

Throws:

AlreadyExistsException - offsetEventEnablerId already applied to offsetEventId

NotFoundException - offsetEventEnablerId or offsetEventId not found

NullArgumentException - offsetEventEnablerId or offsetEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignOffsetEventEnablerFromOffsetEvent

void unassignOffsetEventEnablerFromOffsetEvent(Id offsetEventEnablerId,
 Id offsetEventId)
                                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes an OffsetEventEnabler from an OffsetEvent .

Parameters:

offsetEventEnablerId - the Id of the OffsetEventEnabler

offsetEventId - the Id of the OffsetEvent

Throws:

NotFoundException - offsetEventEnablerId or offsetEventId not found or offsetEventEnablerId not applied to offsetEventId

NullArgumentException - offsetEventEnablerId or offsetEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceOffsetEventEnablers

boolean canSequenceOffsetEventEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveOffsetEventEnablerAhead

void moveOffsetEventEnablerAhead(Id offsetEventEnablerId,
 Id offsetEventId,
 Id referenceId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

offsetEventEnablerId - the Id of an OffsetEventEnabler

offsetEventId - the Id of an OffsetEvent

referenceId - the reference offset event enabler Id

Throws:

NotFoundException - offsetEventEnablerId, offsetEventId , or referenceId not found or, offsetEventEnablerId or referenceId not related to offsetEventId

NullArgumentException - offsetEventEnablerId, offsetEventId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveOffsetEventEnablerBehind

void moveOffsetEventEnablerBehind(Id offsetEventEnablerId,
 Id offsetEventId,
 Id referenceId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

offsetEventEnablerId - the Id of an OffsetEventEnabler

offsetEventId - the Id of an OffsetEvent

referenceId - the reference offset event enabler Id

Throws:

NotFoundException - offsetEventEnablerId, offsetEventId , or referenceId not found or, offsetEventEnablerId or referenceId not related to offsetEventId

NullArgumentException - offsetEventEnablerId, offsetEventId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderOffsetEventEnablers

void orderOffsetEventEnablers(Id[] offsetEventEnablerIds,
 Id offsetEventId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of offset event enablers for an offset event.

Parameters:

offsetEventEnablerIds - the Ids for a set of OffsetEventEnablers

offsetEventId - the Id of an OffsetEvent

Throws:

NotFoundException - offsetEventId not found or, an offsetEventEnablerId not related to offsetEventId

NullArgumentException - offsetEventEnablerIds or offsetEventId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.