OSID Logo
OSID Specifications
repository rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.repository.rules.CompositionEnablerRuleApplicationSession
Implementsosid.OsidSession
Description

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.

MethodgetRepositoryId
Description

Gets the Repository Id associated with this session.

Returnosid.id.Idthe Repository Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetRepository
Description

Gets the Repository associated with this session.

Returnosid.repository.Repositorythe repository
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignCompositionEnablers
Description

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.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignCompositionEnablerToComposition
Description

Adds an existing CompositionEnabler to a Composition.

Parametersosid.id.IdcompositionEnablerIdthe Id of the CompositionEnabler
osid.id.IdcompositionIdthe Id of the Composition
ErrorsALREADY_EXISTS compositionEnablerId is already applied to compositionId
NOT_FOUND compositionEnablerId or compositionId not found
NULL_ARGUMENT compositionEnablerId or compositionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignCompositionEnablerFromComposition
Description

Removes a CompositionEnabler from a Composition.

Parametersosid.id.IdcompositionEnablerIdthe Id of the CompositionEnabler
osid.id.IdcompositionIdthe Id of the Composition
ErrorsNOT_FOUND compositionEnablerId or compositionId not found or compositionEnablerId not applied to compositionId
NULL_ARGUMENT compositionEnablerId or compositionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceCompositionEnablers
Description

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.

Returnboolean false if CompositionEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveCompositionEnablerAhead
Description

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

Parametersosid.id.IdcomposiitonEnablerIdthe Id of a CompositionEnabler
osid.id.IdcomposiitonIdthe Id of a Composition
osid.id.IdreferenceIdthe reference composiiton enabler Id
ErrorsNOT_FOUND composiitonEnablerId, composiitonId, or referenceId not found or, composiitonEnablerId or referenceId not related to composiitonId
NULL_ARGUMENT composiitonEnablerId, composiitonId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveCompositionEnablerBehind
Description

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

Parametersosid.id.IdcomposiitonEnablerIdthe Id of a CompositionEnabler
osid.id.IdcomposiitonIdthe Id of a Composition
osid.id.IdreferenceIdthe reference composiiton enabler Id
ErrorsNOT_FOUND composiitonEnablerId, composiitonId, or referenceId not found or, composiitonEnablerId or referenceId not related to composiitonId
NULL_ARGUMENT composiitonEnablerId, composiitonId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderCompositionEnablers
Description

Reorders a set of composiiton enablers for a composiiton.

Parametersosid.id.Id[]composiitonEnablerIdsthe Ids for a set of CompositionEnablers
osid.id.IdcomposiitonIdthe Id of a Composition
ErrorsNOT_FOUND composiitonId not found or, an composiitonEnablerId not related to composiitonId
NULL_ARGUMENT composiitonEnablerIds or composiitonId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.