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

Interface	osid.subscription.rules.DispatchProcessorRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods to apply `DispatchProcessors` to `Dispatches` . Multiple `DispatchProcessors` applied to an `Dispatch` may be sequenced such that the first positive evaluation results in the `DispatchProcessor` 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	canAssignDispatchProcessors
Description	Tests if this user can alter dispatch processor/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	assignDispatchProcessorToDispatch
Description	Adds an existing `DispatchProcessor` to a `Dispatch` .
Parameters	`osid.id.Id`	`dispatchProcessorId`	the `Id` of the `DispatchProcessor`
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
Errors	ALREADY_EXISTS		`dispatchProcessorId` already applied to `dispatchId`
	NOT_FOUND		`dispatchProcessorId` or `dispatchId` not found
	NULL_ARGUMENT		`dispatchProcessorId` or `dispatchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignDispatchProcessorFromDispatch
Description	Removes an existing `DispatchProcessor` from a `Dispatch` .
Parameters	`osid.id.Id`	`dispatchProcessorId`	the `Id` of the `DispatchProcessor`
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
Errors	NOT_FOUND		`dispatchProcessorId` or `dispatchId` not found or `dispatchProcessorId` already applied to `dispatchId`
	NULL_ARGUMENT		`dispatchProcessorId` or `dispatchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceDispatchProcessors
Description	Tests if this user can order `DispatchProcessors` . 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 `DispatchProcessor` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveDispatchProcessorAhead
Description	Reorders dispatch processors for a dispatch by moving the specified dispatch processor in front of a reference dispatch processor.
Parameters	`osid.id.Id`	`dispatchProcessorId`	the `Id` of the `DispatchProcessor`
	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
	`osid.id.Id`	`referenceId`	the reference dispatch processor `Id`
Errors	NOT_FOUND		`dispatchProcessorId dispatchId` , or `referenceId` not found or, `dispatchProcessorId` or `referenceId` not related to `dispatchId`
	NULL_ARGUMENT		`dispatchProcessorId, dispatchId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveDispatchProcessorBehind
Description	Reorders dispatch processors for a dispatch by moving the specified dispatch processor behind a reference dispatch processor.
Parameters	`osid.id.Id`	`dispatchProcessorId`	the `Id` of the `DispatchProcessor`
	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
	`osid.id.Id`	`referenceId`	the reference dispatch processor `Id`
Errors	NOT_FOUND		`dispatchProcessorId, dispatchId` , or `referenceId` not found or, `dispatchProcessorId` or `referenceId` not related to `dispatchId`
	NULL_ARGUMENT		`dispatchProcessorId, dispatchId` , or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderDispatchProcessors
Description	Reorders a set of dispatch processors for a dispatch.
Parameters	`osid.id.Id[]`	`dispatchProcessorIds`	the `Ids` for a set of `DispatchProcessors`
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
Errors	NOT_FOUND		`dispatchId` not found or, a `dispatchProcessorId` not related to `dispatchId`
	NULL_ARGUMENT		`dispatchProcessorIds` or `dispatchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.