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

Interface	osid.subscription.rules.DispatchEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods to apply `DispatchEnablers` to `Dispatches`. Multiple `DispatchEnablers` applied to an `Dispatch` may be sequenced such that the first positive evaluation results in the `DispatchEnablers` 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	canAssignDispatchEnablers
Description	Tests if this user can alter dispatch enabler/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	assignDispatchEnablerToDispatch
Description	Adds an existing `DispatchEnabler` to a `Dispatch`.
Parameters	`osid.id.Id`	`dispatchEnablerId`	the `Id` of the `DispatchEnabler`
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
Errors	ALREADY_EXISTS		`dispatchEnablerId` already applied to `dispatchId`
	NOT_FOUND		`dispatchEnablerId` or `dispatchId` not found
	NULL_ARGUMENT		`dispatchEnablerId` or `dispatchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignDispatchEnablerFromDispatch
Description	Removes an existing `DispatchEnabler` from a `Dispatch`.
Parameters	`osid.id.Id`	`dispatchEnablerId`	the `Id` of the `DispatchEnabler`
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
Errors	NOT_FOUND		`dispatchEnablerId` or `dispatchId` not found or `dispatchEnablerId` already applied to `dispatchId`
	NULL_ARGUMENT		`dispatchEnablerId` or `dispatchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceDispatchEnablers
Description	Tests if this user can order `DispatchEnablers`. 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 `DispatchEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveDispatchEnablerAhead
Description	Reorders dispatch enablers for a dispatch by moving the specified dispatch enabler in front of a reference dispatch enabler.
Parameters	`osid.id.Id`	`dispatchEnablerId`	the `Id` of the `DispatchEnabler`
	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
	`osid.id.Id`	`referenceId`	the reference dispatch enabler `Id`
Errors	NOT_FOUND		`dispatchEnablerId, dispatchId`, or `referenceId` not found or, `dispatchEnablerId` or `referenceId` not related to `dispatchId`
	NULL_ARGUMENT		`dispatchEnablerId, dispatchId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveDispatchEnablerBehind
Description	Reorders dispatch enablers for a dispatch by moving the specified dispatch enabler behind a reference dispatch enabler.
Parameters	`osid.id.Id`	`dispatchEnablerId`	the `Id` of the `DispatchEnabler`
	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
	`osid.id.Id`	`referenceId`	the reference dispatch enabler `Id`
Errors	NOT_FOUND		`dispatchEnablerId, dispatchId`, or `referenceId` not found or, `dispatchEnablerId` or `referenceId` not related to `dispatchId`
	NULL_ARGUMENT		`dispatchEnablerId, dispatchId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderDispatchEnablers
Description	Reorders a set of dispatch enablers for a dispatch.
Parameters	`osid.id.Id[]`	`dispatchEnablerIds`	the `Ids` for a set of `DispatchEnablers`
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
Errors	NOT_FOUND		`dispatchEnablerId, dispatchId`, or `referenceId` not found or, `dispatchEnablerId` or `referenceId` not related to `dispatchId`
	NULL_ARGUMENT		`dispatchEnablerIds, dispatchId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.