Interface CommitmentEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CommitmentEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply CommitmentEnablers to Commitments . A Commitment with multiple CommitmentEnablers means any positive rule evaluation across the enablers result in an effective Commitment .

Method Summary

Modifier and Type	Method	Description
void	assignCommitmentEnablerToCommitment(Id commitmentEnablerId, Id commitmentId)	Adds an existing CommitmentEnabler to a Commitment .
boolean	canAssignCommitmentEnablers()	Tests if this user can alter commitment enabler/commitment mappings.
boolean	canSequenceCommitmentEnablers()	Tests if this user can order CommitmentEnablers .
Calendar	getCalendar()	Gets the Calendar associated with this session.
Id	getCalendarId()	Gets the Calendar Id associated with this session.
void	moveCommitmentEnablerAhead(Id commitmentEventEnablerId, Id commitmentEventId, Id referenceId)	Reorders commitment enablers for a commitment by moving the specified commitment enabler in front of a reference commitment enabler.
void	moveCommitmentEnablerBehind(Id commitmentEventEnablerId, Id commitmentEventId, Id referenceId)	Reorders commitment enablers for a commitment event by moving the specified commitment enabler behind a reference commitment enabler.
void	orderCommitmentEnablers(Id[] commitmentEventEnablerId, Id commitmentEventId)	Reorders a set of commitment enablers for a commitment.
void	unassignCommitmentEnablerFromCommitment(Id commitmentEnablerId, Id commitmentId)	Removes a CommitmentEnabler from a Commitment .

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.

canAssignCommitmentEnablers

boolean canAssignCommitmentEnablers()

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

assignCommitmentEnablerToCommitment

void assignCommitmentEnablerToCommitment(Id commitmentEnablerId,
 Id commitmentId)
                                  throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing CommitmentEnabler to a Commitment .

Parameters:

commitmentEnablerId - the Id of the CommitmentEnabler

commitmentId - the Id of the Commitment

Throws:

AlreadyExistsException - commitmentEnablerId already applied to commitmentId

NotFoundException - commitmentEnablerId or commitmentId not found

NullArgumentException - commitmentEnablerId or commitmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignCommitmentEnablerFromCommitment

void unassignCommitmentEnablerFromCommitment(Id commitmentEnablerId,
 Id commitmentId)
                                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a CommitmentEnabler from a Commitment .

Parameters:

commitmentEnablerId - the Id of the CommitmentEnabler

commitmentId - the Id of the Commitment

Throws:

NotFoundException - commitmentEnablerId or commitmentId not found or commitmentEnablerId not applied to commitmentId

NullArgumentException - commitmentEnablerId or commitmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceCommitmentEnablers

boolean canSequenceCommitmentEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveCommitmentEnablerAhead

void moveCommitmentEnablerAhead(Id commitmentEventEnablerId,
 Id commitmentEventId,
 Id referenceId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

commitmentEventEnablerId - the Id of a CommitmentEnabler

commitmentEventId - the Id of a Commitment

referenceId - the reference commitment enabler Id

Throws:

NotFoundException - commitmentEnablerId, commitmentId , or referenceId not found or, commitmentEnablerId or referenceId not related to commitmentId

NullArgumentException - commitmentEnablerId, commitmentId or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveCommitmentEnablerBehind

void moveCommitmentEnablerBehind(Id commitmentEventEnablerId,
 Id commitmentEventId,
 Id referenceId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

commitmentEventEnablerId - the Id of a CommitmentEnabler

commitmentEventId - the Id of a Commitment

referenceId - the reference commitment enabler Id

Throws:

NotFoundException - commitmentEnablerId, commitmentId , or referenceId not found or, commitmentEnablerId or referenceId not related to commitmentId

NullArgumentException - commitmentEnablerId, commitmentId or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderCommitmentEnablers

void orderCommitmentEnablers(Id[] commitmentEventEnablerId,
 Id commitmentEventId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of commitment enablers for a commitment.

Parameters:

commitmentEventEnablerId - the Ids for a set of CommitmentEnablerIds

commitmentEventId - the Id of a Commitment

Throws:

NotFoundException - commitmentId not found or, an commitmentEnablerId not related to commitmentId

NullArgumentException - commitmentEnablerIds or commitmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.