Interface CanonicalUnitProcessorEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CanonicalUnitProcessorEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply CanonicalUnitProcessorEnablers to CanonicalUnitProcessors . A CanonicalUnitProcessor with multiple CanonicalUnitProcessorEnablers means any positive rule evaluation across the enablers result in an effective CanonicalUnitProcessor .

Method Summary

Modifier and Type	Method	Description
void	assignCanonicalUnitProcessorEnablerToCanonicalUnitProcessor(Id canonicalUnitProcessorEnablerId, Id canonicalUnitProcessorId)	Adds an existing CanonicalUnitProcessorEnabler to a CanonicalUnitProcessor .
boolean	canAssignCanonicalUnitProcessorEnablers()	Tests if this user can alter canonical unit processor enabler/canonical unit processor mappings.
boolean	canSequenceCanonicalUnitProcessorEnablers()	Tests if this user can order CanonicalUnitProcessors .
Catalogue	getCatalogue()	Gets the Catalogue associated with this session.
Id	getCatalogueId()	Gets the Catalogue Id associated with this session.
void	moveCanonicalUnitProcessorEnablerAhead(Id canonicalUnitProcessorEnablerId, Id canonicalUnitProcessorId, Id referenceId)	Reorders canonical unit processor enablers for a canonical unit processor by moving the specified canonical unit processor enabler in front of a reference canonical unit processor enabler.
void	moveCanonicalUnitProcessorEnablerBehind(Id canonicalUnitProcessorEnablerId, Id canonicalUnitProcessorId, Id referenceId)	Reorders canonical unit processor enablers for a canonical unit processor by moving the specified canonical unit processor enabler behind a reference canonical unit processor enabler.
void	orderCanonicalUnitProcessorEnablers(Id[] canonicalUnitProcessorEnablerIds, Id canonicalUnitProcessorId)	Reorders a set of canonical unit processor enablers for a canonical unit processor.
void	unassignCanonicalUnitProcessorEnablerFromCanonicalUnitProcessor(Id canonicalUnitProcessorEnablerId, Id canonicalUnitProcessorId)	Removes a CanonicalUnitProcessorEnabler from a CanonicalUnitProcessor .

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

getCatalogueId

Id getCatalogueId()

Gets the Catalogue Id associated with this session.

Returns:

the Catalogue Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCatalogue

Catalogue getCatalogue()
                throws OperationFailedException,
PermissionDeniedException

Gets the Catalogue associated with this session.

Returns:

the catalogue

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignCanonicalUnitProcessorEnablers

boolean canAssignCanonicalUnitProcessorEnablers()

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

assignCanonicalUnitProcessorEnablerToCanonicalUnitProcessor

void assignCanonicalUnitProcessorEnablerToCanonicalUnitProcessor(Id canonicalUnitProcessorEnablerId,
 Id canonicalUnitProcessorId)
                                                          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing CanonicalUnitProcessorEnabler to a CanonicalUnitProcessor .

Parameters:

canonicalUnitProcessorEnablerId - the Id of the CanonicalUnitProcessorEnabler

canonicalUnitProcessorId - the Id of the CanonicalUnitProcessor

Throws:

AlreadyExistsException - canonicalUnitProcessorEnablerId already applied to canonicalUnitProcessorId

NotFoundException - canonicalUnitProcessorEnablerId or canonicalUnitProcessorId not found

NullArgumentException - canonicalUnitProcessorEnablerId or canonicalUnitProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignCanonicalUnitProcessorEnablerFromCanonicalUnitProcessor

void unassignCanonicalUnitProcessorEnablerFromCanonicalUnitProcessor(Id canonicalUnitProcessorEnablerId,
 Id canonicalUnitProcessorId)
                                                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a CanonicalUnitProcessorEnabler from a CanonicalUnitProcessor .

Parameters:

canonicalUnitProcessorEnablerId - the Id of the CanonicalUnitProcessorEnabler

canonicalUnitProcessorId - the Id of the CanonicalUnitProcessor

Throws:

NotFoundException - canonicalUnitProcessorEnablerId or canonicalUnitProcessorId not found or not mapped

NullArgumentException - canonicalUnitProcessorEnablerId or canonicalUnitProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceCanonicalUnitProcessorEnablers

boolean canSequenceCanonicalUnitProcessorEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveCanonicalUnitProcessorEnablerAhead

void moveCanonicalUnitProcessorEnablerAhead(Id canonicalUnitProcessorEnablerId,
 Id canonicalUnitProcessorId,
 Id referenceId)
                                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders canonical unit processor enablers for a canonical unit processor by moving the specified canonical unit processor enabler in front of a reference canonical unit processor enabler.

Parameters:

canonicalUnitProcessorEnablerId - the Id of a CanonicalUnitProcessorEnabler

canonicalUnitProcessorId - the Id of a CanonicalUnitProcessor

referenceId - the reference canonical unit processor Id

Throws:

NotFoundException - canonicalUnitProcessorEnablerId, canonicalUnitProcesorId , or referenceId not found or, canonicalUnitProcessorEnablerId or referenceId not related to canonicalUnitProcessorId

NullArgumentException - canonicalUnitProcessorEnablerId, canonicalUnitProcessorId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveCanonicalUnitProcessorEnablerBehind

void moveCanonicalUnitProcessorEnablerBehind(Id canonicalUnitProcessorEnablerId,
 Id canonicalUnitProcessorId,
 Id referenceId)
                                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders canonical unit processor enablers for a canonical unit processor by moving the specified canonical unit processor enabler behind a reference canonical unit processor enabler.

Parameters:

canonicalUnitProcessorEnablerId - the Id of a CanonicalUnitProcessorEnabler

canonicalUnitProcessorId - the Id of a CanonicalUnitProcessor

referenceId - the reference canonical unit processor Id

Throws:

NotFoundException - canonicalUnitProcessorEnablerId, canonicalUnitProcesorId , or referenceId not found or, canonicalUnitProcessorEnablerId or referenceId not related to canonicalUnitProcessorId

NullArgumentException - canonicalUnitProcessorEnablerId, canonicalUnitProcessorId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderCanonicalUnitProcessorEnablers

void orderCanonicalUnitProcessorEnablers(Id[] canonicalUnitProcessorEnablerIds,
 Id canonicalUnitProcessorId)
                                  throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of canonical unit processor enablers for a canonical unit processor.

Parameters:

canonicalUnitProcessorEnablerIds - the Ids for a set of CanonicalUnitProcessorEnablers

canonicalUnitProcessorId - the Id of a CanonicalUnitProcessor

Throws:

NotFoundException - canonicalUnitProcessorId not found or, a canonicalUnitProcessorEnablerId not related to canonicalUnitProcessorId

NullArgumentException - canonicalUnitProcessorEnablerIds or canonicalUnitProcessorId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.