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

Interface	osid.subscription.rules.DispatchProcessorEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods to apply `DispatchProcessorEnablers` to `DispatchProcessors`. Multiple `DispatchProcessorEnablers` applied to an `DispatchProcessor` may be sequenced such that the first positive evaluation results in the `DispatchProcessorEnabler` 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	canAssignDispatchProcessorEnablers
Description	Tests if this user can alter dispatch processor enabler/dispatch processor 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	assignDispatchProcessorEnablerToDispatchProcessor
Description	Adds an existing `DispatchProcessorEnabler` to a `DispatchProcessor`.
Parameters	`osid.id.Id`	`dispatchProcessorEnablerId`	the `Id` of the `DispatchProcessorEnabler`
Parameters	`osid.id.Id`	`dispatchProcessorId`	the `Id` of the `DispatchProcessor`
Errors	ALREADY_EXISTS		`dispatchProcessorEnablerId` already applied to `dispatchProcessorId`
	NOT_FOUND		`dispatchProcessorEnablerId` or `dispatchProcessorId` not found
	NULL_ARGUMENT		`dispatchProcessorEnablerId` or `dispatchProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignDispatchProcessorEnablerFromDispatchProcessor
Description	Removes an existing `DispatchProcessorEnabler` from a `DispatchProcessor`.
Parameters	`osid.id.Id`	`dispatchProcessorEnablerId`	the `Id` of the `DispatchProcessorEnabler`
Parameters	`osid.id.Id`	`dispatchProcessorId`	the `Id` of the `DispatchProcessor`
Errors	NOT_FOUND		`dispatchProcessorEnablerId` or `dispatchProcessorId` not found or `dispatchProcessorEnablerId` already applied to `dispatchProcessorId`
	NULL_ARGUMENT		`dispatchProcessorEnablerId` or `dispatchProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceDispatchProcessorEnablers
Description	Tests if this user can order `DispatchProcessorEnablers`. 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 `DispatchProcessorEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveDispatchProcessorEnablerAhead
Description	Reorders dispatch processor enablers for a dispatch processor by moving the specified dispatch processor enabler in front of a reference dispatch processor enabler.
Parameters	`osid.id.Id`	`dispatchProcessorEnablerId`	the `Id` of the `DispatchProcessorEnabler`
	`osid.id.Id`	`dispatchProcessorId`	the `Id` of the `DispatchProcessor`
	`osid.id.Id`	`referenceId`	the reference dispatch processor enabler `Id`
Errors	NOT_FOUND		`dispatchProcessorEnablerId dispatchProcessorId`, or `referenceId` not found or, `dispatchProcessorEnablerId` or `referenceId` not related to `dispatchProcessorId`
	NULL_ARGUMENT		`dispatchProcessorEnablerId, dispatchProcessorId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveDispatchProcessorEnablerBehind
Description	Reorders dispatch processor enablers for a dispatch processor by moving the specified dispatch processor enabler behind a reference dispatch processor enabler.
Parameters	`osid.id.Id`	`dispatchProcessorEnablerId`	the `Id` of the `DispatchProcessorEnabler`
	`osid.id.Id`	`dispatchProcessorId`	the `Id` of the `DispatchProcessor`
	`osid.id.Id`	`referenceId`	the reference dispatch processor `Id`
Errors	NOT_FOUND		`dispatchProcessorEnablerId dispatchProcessorId`, or `referenceId` not found or, `dispatchProcessorEnablerId` or `referenceId` not related to `dispatchProcessorId`
	NULL_ARGUMENT		`dispatchProcessorEnablerId, dispatchProcessorId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderDispatchProcessorEnablers
Description	Reorders a set of dispatch processor enablers for a dispatch processor.
Parameters	`osid.id.Id[]`	`dispatchProcessorEnablerIds`	the `Ids` for a set of `DispatchProcessorEnablers`
Parameters	`osid.id.Id`	`dispatchProcessorId`	the `Id` of the `DispatchProcessor`
Errors	NOT_FOUND		`dispatchProcessorId` not found or, a `dispatchProcessorEnablerId` not related to `dispatchProcessorId`
	NULL_ARGUMENT		`dispatchProcessorEnablerIds` or `dispatchProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.