OSID - osid.subscription.rules.DispatchConstrainerRuleApplicationSession Service Interface Definition

Interface	osid.subscription.rules.DispatchConstrainerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods to apply `DispatchConstrainers` to `Dispatches` . Multiple `DispatchConstrainers` applied to an `Dispatch` may be sequenced such that the first positive evaluation results in the `DispatchConstrainer` used.
Method	getPublisherId
Description	Gets the `Publisher` `Id` associated with this session.
Return	`osid.id.Id`		the `Publisher Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPublisher
Description	Gets the `Publisher` associated with this session.
Return	`osid.subscription.Publisher`		the publisher
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canAssignDispatchConstrainers
Description	Tests if this user can alter dispatch constrainer/dispatch 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	assignDispatchConstrainerToDispatch
Description	Adds an existing `DispatchConstrainer` to a `Dispatch` .
Parameters	`osid.id.Id`	`dispatchConstrainerId`	the `Id` of the `DispatchConstrainer`
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
Errors	ALREADY_EXISTS		`dispatchConstrainerId` already applied to `dispatchId`
	NOT_FOUND		`dispatchConstrainerId` or `dispatchId` not found
	NULL_ARGUMENT		`dispatchConstrainerId` or `dispatchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignDispatchConstrainerFromDispatch
Description	Removes an existing `DispatchConstrainer` from a `Dispatch` .
Parameters	`osid.id.Id`	`dispatchConstrainerId`	the `Id` of the `DispatchConstrainer`
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
Errors	NOT_FOUND		`dispatchConstrainerId` or `dispatchId` not found or `dispatchConstrainerId` already applied to `dispatchId`
	NULL_ARGUMENT		`dispatchConstrainerId` or `dispatchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceDispatchConstrainers
Description	Tests if this user can order `DispatchConstrainers` . 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 `DispatchConstrainer` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveDispatchConstrainerAhead
Description	Reorders dispatch constrainers for a dispatch by moving the specified dispatch constrainer in front of a reference dispatch constrainer.
Parameters	`osid.id.Id`	`dispatchConstrainerId`	the `Id` of the `DispatchConstrainer`
	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
	`osid.id.Id`	`referenceId`	the reference dispatch constrainer `Id`
Errors	NOT_FOUND		`dispatchConstrainerId, dispatchId` , or `referenceId` not found or, `dispatchConstrainerId` or `referenceId` not related to `dispatchId`
	NULL_ARGUMENT		`dispatchConstrainerId, dispatchId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveDispatchConstrainerBehind
Description	Reorders dispatch constrainers for a dispatch by moving the specified dispatch constrainer behind a reference dispatch constrainer.
Parameters	`osid.id.Id`	`dispatchConstrainerId`	the `Id` of the `DispatchConstrainer`
	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
	`osid.id.Id`	`referenceId`	the reference dispatch constrainer `Id`
Errors	NOT_FOUND		`dispatchConstrainerId, dispatchId` , or `referenceId` not found or, `dispatchConstrainerId` or `referenceId` not related to `dispatchId`
	NULL_ARGUMENT		`dispatchConstrainerId, dispatchId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderDispatchConstrainers
Description	Reorders a set of dispatch constrainers for a dispatch.
Parameters	`osid.id.Id[]`	`dispatchConstrainerIds`	the `Ids` for a set of `DispatchConstrainers`
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
Errors	NOT_FOUND		`dispatchId` not found or, a `dispatchConstrainerId` not related to `dispatchId`
	NULL_ARGUMENT		`dispatchConstrainerIds` or `dispatchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.