Interface CompositionEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CompositionEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply CompositionEnablers to Compositions . A Composition with multiple CompositionEnablers means any positive rule evaluation across the enablers result in a visible Composition .

Method Summary

Modifier and Type	Method	Description
void	assignCompositionEnablerToComposition(Id compositionEnablerId, Id compositionId)	Adds an existing CompositionEnabler to a Composition .
boolean	canAssignCompositionEnablers()	Tests if this user can alter composition enabler/composition mappings.
boolean	canSequenceCompositionEnablers()	Tests if this user can order CompositionEnablers .
Repository	getRepository()	Gets the Repository associated with this session.
Id	getRepositoryId()	Gets the Repository Id associated with this session.
void	moveCompositionEnablerAhead(Id composiitonEnablerId, Id composiitonId, Id referenceId)	Reorders composiiton enablers for a composiiton by moving the specified composiiton enabler in front of a reference composiiton enabler.
void	moveCompositionEnablerBehind(Id composiitonEnablerId, Id composiitonId, Id referenceId)	Reorders composiiton enablers for a composiiton by moving the specified composiiton enabler behind a reference composiiton enabler.
void	orderCompositionEnablers(Id[] composiitonEnablerIds, Id composiitonId)	Reorders a set of composiiton enablers for a composiiton.
void	unassignCompositionEnablerFromComposition(Id compositionEnablerId, Id compositionId)	Removes a CompositionEnabler from a Composition .

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

getRepositoryId

Id getRepositoryId()

Gets the Repository Id associated with this session.

Returns:

the Repository Id associated with this session

Compliance:

mandatory - This method must be implemented.

getRepository

Repository getRepository()
                  throws OperationFailedException,
PermissionDeniedException

Gets the Repository associated with this session.

Returns:

the repository

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignCompositionEnablers

boolean canAssignCompositionEnablers()

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

assignCompositionEnablerToComposition

void assignCompositionEnablerToComposition(Id compositionEnablerId,
 Id compositionId)
                                    throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing CompositionEnabler to a Composition .

Parameters:

compositionEnablerId - the Id of the CompositionEnabler

compositionId - the Id of the Composition

Throws:

AlreadyExistsException - compositionEnablerId is already applied to compositionId

NotFoundException - compositionEnablerId or compositionId not found

NullArgumentException - compositionEnablerId or compositionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignCompositionEnablerFromComposition

void unassignCompositionEnablerFromComposition(Id compositionEnablerId,
 Id compositionId)
                                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a CompositionEnabler from a Composition .

Parameters:

compositionEnablerId - the Id of the CompositionEnabler

compositionId - the Id of the Composition

Throws:

NotFoundException - compositionEnablerId or compositionId not found or compositionEnablerId not applied to compositionId

NullArgumentException - compositionEnablerId or compositionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceCompositionEnablers

boolean canSequenceCompositionEnablers()

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

Compliance:

mandatory - This method must be implemented.

moveCompositionEnablerAhead

void moveCompositionEnablerAhead(Id composiitonEnablerId,
 Id composiitonId,
 Id referenceId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

composiitonEnablerId - the Id of a CompositionEnabler

composiitonId - the Id of a Composition

referenceId - the reference composiiton enabler Id

Throws:

NotFoundException - composiitonEnablerId, composiitonId , or referenceId not found or, composiitonEnablerId or referenceId not related to composiitonId

NullArgumentException - composiitonEnablerId, composiitonId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveCompositionEnablerBehind

void moveCompositionEnablerBehind(Id composiitonEnablerId,
 Id composiitonId,
 Id referenceId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

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

Parameters:

composiitonEnablerId - the Id of a CompositionEnabler

composiitonId - the Id of a Composition

referenceId - the reference composiiton enabler Id

Throws:

NotFoundException - composiitonEnablerId, composiitonId , or referenceId not found or, composiitonEnablerId or referenceId not related to composiitonId

NullArgumentException - composiitonEnablerId, composiitonId , or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderCompositionEnablers

void orderCompositionEnablers(Id[] composiitonEnablerIds,
 Id composiitonId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of composiiton enablers for a composiiton.

Parameters:

composiitonEnablerIds - the Ids for a set of CompositionEnablers

composiitonId - the Id of a Composition

Throws:

NotFoundException - composiitonId not found or, an composiitonEnablerId not related to composiitonId

NullArgumentException - composiitonEnablerIds or composiitonId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.