Interface SequenceRuleEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface SequenceRuleEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply SequenceRuleEnablers to SequenceRules . a SequenceRule with multiple SequenceRuleEnablers means any positive rule evaluation across the enablers result in an effective SequenceRule .

Method Summary

Modifier and Type	Method	Description
void	assignSequenceRuleEnablerToSequenceRule(Id sequenceRuleEnablerId, Id sequenceRuleId)	Adds an existing SequenceRuleEnabler to a SequenceRule .
boolean	canAssignSequenceRuleEnablers()	Tests if this user can alter sequence rule enabler/sequence rule mappings.
boolean	canSequenceSequenceRuleEnablers()	Tests if this user can order SequenceRuleEnablers .
Bank	getBank()	Gets the Bank associated with this session.
Id	getBankId()	Gets the Bank Id associated with this session.
void	moveSequenceRuleEnablerAhead(Id sequenceRuleEnablerId, Id sequenceRuleId, Id referenceId)	Reorders sequence rule enablers for a sequence rule by moving the specified sequence rule enabler in front of a reference sequence rule enabler.
void	moveSequenceRuleEnablerBehind(Id sequenceRuleEnablerId, Id sequenceRuleId, Id referenceId)	Reorders sequence rule enablers for a sequence rule by moving the specified sequence rule enabler behind a reference sequence rule enabler.
void	orderSequenceRuleEnablers(Id[] sequenceRuleEnablerIds, Id sequenceRuleId)	Reorders a set of sequence rule enablers for a sequence rule.
void	unassignSequenceRuleEnablerFromSequenceRule(Id sequenceRuleEnablerId, Id sequenceRuleId)	Removes a SequenceRuleEnabler from a SequenceRule .

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

getBankId

Id getBankId()

Gets the Bank Id associated with this session.

Returns:

the Bank Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBank

Bank getBank()
      throws OperationFailedException,
PermissionDeniedException

Gets the Bank associated with this session.

Returns:

the bank

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignSequenceRuleEnablers

boolean canAssignSequenceRuleEnablers()

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

assignSequenceRuleEnablerToSequenceRule

void assignSequenceRuleEnablerToSequenceRule(Id sequenceRuleEnablerId,
 Id sequenceRuleId)
                                      throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing SequenceRuleEnabler to a SequenceRule .

Parameters:

sequenceRuleEnablerId - the Id of the SequenceRuleEnabler

sequenceRuleId - the Id of the SequenceRule

Throws:

AlreadyExistsException - sequenceRuleEnablerId is already applied to sequenceRuleId

NotFoundException - sequenceRuleEnablerId or sequenceRuleId not found

NullArgumentException - sequenceRuleEnablerId or sequenceRuleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignSequenceRuleEnablerFromSequenceRule

void unassignSequenceRuleEnablerFromSequenceRule(Id sequenceRuleEnablerId,
 Id sequenceRuleId)
                                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a SequenceRuleEnabler from a SequenceRule .

Parameters:

sequenceRuleEnablerId - the Id of the SequenceRuleEnabler

sequenceRuleId - the Id of the SequenceRule

Throws:

NotFoundException - sequenceRuleEnablerId or sequenceRuleId not found or sequenceRuleEnablerId not applied to sequenceRuleId

NullArgumentException - sequenceRuleEnablerId or sequenceRuleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceSequenceRuleEnablers

boolean canSequenceSequenceRuleEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveSequenceRuleEnablerAhead

void moveSequenceRuleEnablerAhead(Id sequenceRuleEnablerId,
 Id sequenceRuleId,
 Id referenceId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

sequenceRuleEnablerId - the Id of a SequenceRuleEnabler

sequenceRuleId - the Id of a SequenceRule

referenceId - the reference sequence rule enabler Id

Throws:

NotFoundException - sequenceRuleEnablerId, sequenceRuleId , or referenceId not found or, sequenceRuleEnablerId or referenceId not related to sequenceRuleId

NullArgumentException - sequenceRuleEnablerId, sequenceRuleId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveSequenceRuleEnablerBehind

void moveSequenceRuleEnablerBehind(Id sequenceRuleEnablerId,
 Id sequenceRuleId,
 Id referenceId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders sequence rule enablers for a sequence rule by moving the specified sequence rule enabler behind a reference sequence rule enabler.

Parameters:

sequenceRuleEnablerId - the Id of a SequenceRuleEnabler

sequenceRuleId - the Id of a SequenceRule

referenceId - the reference sequence rule enabler Id

Throws:

NotFoundException - sequenceRuleEnablerId, sequenceRuleId , or referenceId not found or, sequenceRuleEnablerId or referenceId not related to sequenceRuleId

NullArgumentException - sequenceRuleEnablerId, sequenceRuleId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderSequenceRuleEnablers

void orderSequenceRuleEnablers(Id[] sequenceRuleEnablerIds,
 Id sequenceRuleId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of sequence rule enablers for a sequence rule.

Parameters:

sequenceRuleEnablerIds - the Ids for a set of SequenceRuleEnablers

sequenceRuleId - the Id of a SequenceRule

Throws:

NotFoundException - sequenceRuleId not found or, an sequenceRuleEnablerId not related to sequenceRuleId

NullArgumentException - sequenceRuleEnablerIds or sequenceRuleId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.