OSID - osid.hold.rules.HoldEnablerRuleApplicationSession Service Interface Definition

Interface	osid.hold.rules.HoldEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.hold.rules.HoldRulesManager`
Used By	`osid.hold.rules.HoldRulesProxyManager`
Description	This session provides methods to apply `HoldEnablers` to `Holds`. A `Hold` with multiple `HoldEnablers` means any positive rule evaluation across the enablers result in an effective `Hold`.
Method	getOublietteId
Description	Gets the `Oubliette` `Id` associated with this session.
Return	`osid.id.Id`		the `Oubliette Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOubliette
Description	Gets the `Oubliette` associated with this session.
Return	`osid.hold.Oubliette`		the oubliette
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAssignHoldEnablers
Description	Tests if this user can alter hold enabler/hold 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	assignHoldEnablerToHold
Description	Adds an existing `HoldEnabler` to a `Hold`.
Parameters	`osid.id.Id`	`holdEnablerId`	the `Id` of the `HoldEnabler`
Parameters	`osid.id.Id`	`holdId`	the `Id` of the `Hold`
Errors	ALREADY_EXISTS		`holdEnablerId` is already applied to `holdId`
	NOT_FOUND		`holdEnablerId` or `holdId` not found
	NULL_ARGUMENT		`holdEnablerId` or `holdId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignHoldEnablerFromHold
Description	Removes a `HoldEnabler` from a `Hold`.
Parameters	`osid.id.Id`	`holdEnablerId`	the `Id` of the `HoldEnabler`
Parameters	`osid.id.Id`	`holdId`	the `Id` of the `Hold`
Errors	NOT_FOUND		`holdEnablerId` or `holdId` not found or `holdEnablerId` is not applied to `holdId`
	NULL_ARGUMENT		`holdEnablerId` or `holdId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceHoldEnablers
Description	Tests if this user can order `HoldEnablers` . 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 `HoldEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveHoldEnablerAhead
Description	Reorders hold enablers for a hold by moving the specified hold enabler in front of a reference hold enabler.
Parameters	`osid.id.Id`	`holdEnablerId`	the `Id` of a `HoldEnabler`
	`osid.id.Id`	`holdId`	the `Id` of a `Hold`
	`osid.id.Id`	`referenceId`	the reference hold enabler `Id`
Errors	NOT_FOUND		`holdEnablerId, holdId`, or `referenceId` not found or, `holdEnablerId` or `referenceId` not related to `holdId`
	NULL_ARGUMENT		`holdEnablerId, holdId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveHoldEnablerBehind
Description	Reorders hold enablers for a hold by moving the specified hold enabler behind a reference hold enabler.
Parameters	`osid.id.Id`	`holdEnablerId`	the `Id` of a `HoldEnabler`
	`osid.id.Id`	`holdId`	the `Id` of a `Hold`
	`osid.id.Id`	`referenceId`	the reference hold enabler `Id`
Errors	NOT_FOUND		`holdEnablerId, holdId`, or `referenceId` not found or, `holdEnablerId` or `referenceId` not related to `holdId`
	NULL_ARGUMENT		`holdEnablerId, holdId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderHoldEnablers
Description	Reorders a set of hold enablers for a hold.
Parameters	`osid.id.Id[]`	`holdEnablerId`	the `Ids` for a set of `HoldEnablers`
Parameters	`osid.id.Id`	`holdId`	the `Id` of a `Hold`
Errors	NOT_FOUND		`holdId` not found or, a `holdnEnablerId` not related to `holdId`
	NULL_ARGUMENT		`holdEnablerIds` or `holdId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.