OSID - osid.repository.rules.CompositionEnablerRuleApplicationSession Service Interface Definition

Interface	osid.repository.rules.CompositionEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.repository.rules.RepositoryRulesManager`
Used By	`osid.repository.rules.RepositoryRulesProxyManager`
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`.
Method	getRepositoryId
Description	Gets the `Repository` `Id` associated with this session.
Return	`osid.id.Id`		the `Repository Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getRepository
Description	Gets the `Repository` associated with this session.
Return	`osid.repository.Repository`		the repository
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAssignCompositionEnablers
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.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	assignCompositionEnablerToComposition
Description	Adds an existing `CompositionEnabler` to a `Composition`.
Parameters	`osid.id.Id`	`compositionEnablerId`	the `Id` of the `CompositionEnabler`
Parameters	`osid.id.Id`	`compositionId`	the `Id` of the `Composition`
Errors	ALREADY_EXISTS		`compositionEnablerId` is already applied to `compositionId`
	NOT_FOUND		`compositionEnablerId` or `compositionId` not found
	NULL_ARGUMENT		`compositionEnablerId` or `compositionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignCompositionEnablerFromComposition
Description	Removes a `CompositionEnabler` from a `Composition`.
Parameters	`osid.id.Id`	`compositionEnablerId`	the `Id` of the `CompositionEnabler`
Parameters	`osid.id.Id`	`compositionId`	the `Id` of the `Composition`
Errors	NOT_FOUND		`compositionEnablerId` or `compositionId` not found or `compositionEnablerId` not applied to `compositionId`
	NULL_ARGUMENT		`compositionEnablerId` or `compositionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceCompositionEnablers
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.
Return	`boolean`		`false` if `CompositionEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveCompositionEnablerAhead
Description	Reorders composiiton enablers for a composiiton by moving the specified composiiton enabler in front of a reference composiiton enabler.
Parameters	`osid.id.Id`	`composiitonEnablerId`	the `Id` of a `CompositionEnabler`
	`osid.id.Id`	`composiitonId`	the `Id` of a `Composition`
	`osid.id.Id`	`referenceId`	the reference composiiton enabler `Id`
Errors	NOT_FOUND		`composiitonEnablerId, composiitonId`, or `referenceId` not found or, `composiitonEnablerId` or `referenceId` not related to `composiitonId`
	NULL_ARGUMENT		`composiitonEnablerId, composiitonId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveCompositionEnablerBehind
Description	Reorders composiiton enablers for a composiiton by moving the specified composiiton enabler behind a reference composiiton enabler.
Parameters	`osid.id.Id`	`composiitonEnablerId`	the `Id` of a `CompositionEnabler`
	`osid.id.Id`	`composiitonId`	the `Id` of a `Composition`
	`osid.id.Id`	`referenceId`	the reference composiiton enabler `Id`
Errors	NOT_FOUND		`composiitonEnablerId, composiitonId`, or `referenceId` not found or, `composiitonEnablerId` or `referenceId` not related to `composiitonId`
	NULL_ARGUMENT		`composiitonEnablerId, composiitonId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderCompositionEnablers
Description	Reorders a set of composiiton enablers for a composiiton.
Parameters	`osid.id.Id[]`	`composiitonEnablerIds`	the `Ids` for a set of `CompositionEnablers`
Parameters	`osid.id.Id`	`composiitonId`	the `Id` of a `Composition`
Errors	NOT_FOUND		`composiitonId` not found or, an `composiitonEnablerId` not related to `composiitonId`
	NULL_ARGUMENT		`composiitonEnablerIds` or `composiitonId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.