Interface CanonicalUnitEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CanonicalUnitEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply CanonicalUnitEnablers to CanonicalUnits . A CanonicalUnit with multiple CanonicalUnitEnablers means any positive rule evaluation across the enablers result in an active CanonicalUnit .

Method Summary

Modifier and Type	Method	Description
void	assignCanonicalUnitEnablerToCanonicalUnit(Id canonicalUnitEnablerId, Id canonicalUnitId)	Adds an existing CanonicalUnitEnabler to a CanonicalUnit .
boolean	canAssignCanonicalUnitEnablers()	Tests if this user can alter canonical unit enabler/canonical unit mappings.
boolean	canSequenceCanonicalUnitEnablers()	Tests if this user can order CanonicalUnitEnablers .
Catalogue	getCatalogue()	Gets the Catalogue associated with this session.
Id	getCatalogueId()	Gets the Catalogue Id associated with this session.
void	moveCanonicalUnitEnablerAhead(Id canonicalUnitEnablerId, Id canonicalUnitId, Id referenceId)	Reorders canonical unit enablers for a canonical unit by moving the specified canonical unit enabler in front of a reference canonical unit enabler.
void	moveCanonicalUnitEnablerBehind(Id canonicalUnitEnablerId, Id canonicalUnitId, Id referenceId)	Reorders canonical unit enablers for a canonical unit by moving the specified canonical unit enabler behind a reference canonical unit enabler.
void	orderCanonicalUnitEnablers(Id[] canonicalUnitEnablerIds, Id canonicalUnitId)	Reorders a set of canonical unit enablers for a canonical unit.
void	unassignCanonicalUnitEnablerFromCanonicalUnit(Id canonicalUnitEnablerId, Id canonicalUnitId)	Removes a CanonicalUnitEnabler 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.

canAssignCanonicalUnitEnablers

boolean canAssignCanonicalUnitEnablers()

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

assignCanonicalUnitEnablerToCanonicalUnit

void assignCanonicalUnitEnablerToCanonicalUnit(Id canonicalUnitEnablerId,
 Id canonicalUnitId)
                                        throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing CanonicalUnitEnabler to a CanonicalUnit .

Parameters:

canonicalUnitEnablerId - the Id of the CanonicalUnitEnabler

canonicalUnitId - the Id of the CanonicalUnit

Throws:

AlreadyExistsException - canonicalUnitEnablerId already applied to canonicalUnitId

NotFoundException - canonicalUnitEnablerId or canonicalUnitId not found

NullArgumentException - canonicalUnitEnablerId or canonicalUnitId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignCanonicalUnitEnablerFromCanonicalUnit

void unassignCanonicalUnitEnablerFromCanonicalUnit(Id canonicalUnitEnablerId,
 Id canonicalUnitId)
                                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a CanonicalUnitEnabler from a CanonicalUnit .

Parameters:

canonicalUnitEnablerId - the Id of the CanonicalUnitEnabler

canonicalUnitId - the Id of the CanonicalUnit

Throws:

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

NullArgumentException - canonicalUnitEnablerId or canonicalUnitId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceCanonicalUnitEnablers

boolean canSequenceCanonicalUnitEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveCanonicalUnitEnablerAhead

void moveCanonicalUnitEnablerAhead(Id canonicalUnitEnablerId,
 Id canonicalUnitId,
 Id referenceId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

canonicalUnitEnablerId - the Id of a CanonicalUnitEnabler

canonicalUnitId - the Id of a CanonicalUnit

referenceId - the reference canonical unit enabler Id

Throws:

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

NullArgumentException - canonicalUnitEnablerId, canonicalUnitId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveCanonicalUnitEnablerBehind

void moveCanonicalUnitEnablerBehind(Id canonicalUnitEnablerId,
 Id canonicalUnitId,
 Id referenceId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

canonicalUnitEnablerId - the Id of a CanonicalUnitEnabler

canonicalUnitId - the Id of a CanonicalUnit

referenceId - the reference canonical unit enabler Id

Throws:

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

NullArgumentException - canonicalUnitEnablerId, canonicalUnitId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderCanonicalUnitEnablers

void orderCanonicalUnitEnablers(Id[] canonicalUnitEnablerIds,
 Id canonicalUnitId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

canonicalUnitEnablerIds - the Ids for a set of CanonicalUnitEnablers

canonicalUnitId - the Id of a CanonicalUnit

Throws:

NotFoundException - canonicalUnitConstraienrId not found or, a canonicalUnitEnablerId not related to canonicalUnitId

NullArgumentException - canonicalUnitEnablerIds or canonicalUnitId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.