Interface CanonicalUnitProcessorRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CanonicalUnitProcessorRuleApplicationSession
extends OsidSession

This session provides methods to apply CanonicalUnitProcessors to CanonicalUnits .

Method Summary

Modifier and Type	Method	Description
void	assignCanonicalUnitProcessorToCanonicalUnit(Id canonicalUnitProcessorId, Id canonicalUnitId)	Adds an existing CanonicalUnitProcessor to a CanonicalUnit .
boolean	canAssignCanonicalUnitProcessors()	Tests if this user can alter canonical unit processor/canonical unit mappings.
boolean	canSequenceCanonicalUnitProcessors()	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	moveCanonicalUnitProcessorAhead(Id canonicalUnitProcessorId, Id canonicalUnitId, Id referenceId)	Reorders canonical unit processors for a canonical unit by moving the specified canonical unit processor in front of a reference canonical unit processor.
void	moveCanonicalUnitProcessorBehind(Id canonicalUnitProcessorId, Id canonicalUnitId, Id referenceId)	Reorders canonical unit processors for a canonical unit by moving the specified canonical unit processor behind a reference canonical unit processor.
void	orderCanonicalUnitProcessors(Id[] canonicalUnitProcessorIds, Id canonicalUnitId)	Reorders a set of canonical unit processors for a canonical unit.
void	unassignCanonicalUnitProcessorFromCanonicalUnit(Id canonicalUnitProcessorId, Id canonicalUnitId)	Removes a CanonicalUnitProcessor from a CanonicalUnit .

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.

canAssignCanonicalUnitProcessors

boolean canAssignCanonicalUnitProcessors()

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

assignCanonicalUnitProcessorToCanonicalUnit

void assignCanonicalUnitProcessorToCanonicalUnit(Id canonicalUnitProcessorId,
 Id canonicalUnitId)
                                          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing CanonicalUnitProcessor to a CanonicalUnit .

Parameters:

canonicalUnitProcessorId - the Id of the CanonicalUnitProcessor

canonicalUnitId - the Id of the CanonicalUnit

Throws:

AlreadyExistsException - canonicalUnitProcessorId already applied to canonicalUnitId

NotFoundException - canonicalUnitProcessorId or canonicalUnitId not found

NullArgumentException - canonicalUnitProcessorId or canonicalUnitId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignCanonicalUnitProcessorFromCanonicalUnit

void unassignCanonicalUnitProcessorFromCanonicalUnit(Id canonicalUnitProcessorId,
 Id canonicalUnitId)
                                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a CanonicalUnitProcessor from a CanonicalUnit .

Parameters:

canonicalUnitProcessorId - the Id of the CanonicalUnitProcessor

canonicalUnitId - the Id of the CanonicalUnit

Throws:

NotFoundException - canonicalUnitProcessorId or canonicalUnitId not found or canonicalUnitProcessorId not applied to canonicalUnitId

NullArgumentException - canonicalUnitProcessorId or canonicalUnitId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceCanonicalUnitProcessors

boolean canSequenceCanonicalUnitProcessors()

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 CanonicalUnitProcessor ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveCanonicalUnitProcessorAhead

void moveCanonicalUnitProcessorAhead(Id canonicalUnitProcessorId,
 Id canonicalUnitId,
 Id referenceId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

canonicalUnitProcessorId - the Id of a CanonicalUnitProcessor

canonicalUnitId - the Id of a CanonicalUnit

referenceId - the reference canonical unit processor Id

Throws:

NotFoundException - canonicalUnitProcessorId, canonicalUnitId , or referenceId not found or, canonicalUnitProcessorId or referenceId not related to canonicalUnitId

NullArgumentException - canonicalUnitProcessorId, canonicalUnitId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveCanonicalUnitProcessorBehind

void moveCanonicalUnitProcessorBehind(Id canonicalUnitProcessorId,
 Id canonicalUnitId,
 Id referenceId)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

canonicalUnitProcessorId - the Id of a CanonicalUnitProcessor

canonicalUnitId - the Id of a CanonicalUnit

referenceId - the reference canonical unit processor Id

Throws:

NotFoundException - canonicalUnitProcessorId, canonicalUnitId , or referenceId not found or, canonicalUnitProcessorId or referenceId not related to canonicalUnitId

NullArgumentException - canonicalUnitProcessorId, canonicalUnitId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderCanonicalUnitProcessors

void orderCanonicalUnitProcessors(Id[] canonicalUnitProcessorIds,
 Id canonicalUnitId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of canonical unit processors for a canonical unit.

Parameters:

canonicalUnitProcessorIds - the Ids for a set of CanonicalUnitProcessors

canonicalUnitId - the Id of a CanonicalUnit

Throws:

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

NullArgumentException - canonicalUnitProcessorIds or canonicalUnitId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.