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

Interface	osid.subscription.rules.DispatchConstrainerEnablerRuleApplicationSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods to apply `DispatchConstrainerEnablers` to `DispatchConstrainers`. Multiple `DispatchConstrainerEnablers` applied to an `DispatchConstrainer` may be sequenced such that the first positive evaluation results in the `DispatchConstrainerEnabler` 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	canAssignDispatchConstrainerEnablers
Description	Tests if this user can alter dispatch constrainer enabler/dispatch constrainer 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	assignDispatchConstrainerEnablerToDispatchConstrainer
Description	Adds an existing `DispatchConstrainerEnabler` to a `DispatchConstrainer`.
Parameters	`osid.id.Id`	`dispatchConstrainerEnablerId`	the `Id` of the `DispatchConstrainerEnabler`
Parameters	`osid.id.Id`	`dispatchConstrainerId`	the `Id` of the `DispatchConstrainer`
Errors	ALREADY_EXISTS		`dispatchConstrainerEnablerId` already applied to `dispatchConstrainerId`
	NOT_FOUND		`dispatchConstrainerEnablerId` or `dispatchConstrainerId` not found
	NULL_ARGUMENT		`dispatchConstrainerEnablerId` or `dispatchConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignDispatchConstrainerEnablerFromDispatchConstrainer
Description	Removes an existing `DispatchConstrainerEnabler` from a `DispatchConstrainer`.
Parameters	`osid.id.Id`	`dispatchConstrainerEnablerId`	the `Id` of the `DispatchConstrainerEnabler`
Parameters	`osid.id.Id`	`dispatchConstrainerId`	the `Id` of the `DispatchConstrainer`
Errors	NOT_FOUND		`dispatchConstrainerEnablerId` or `dispatchConstrainerId` not found or `dispatchConstrainerEnablerId` already applied to `dispatchConstrainerId`
	NULL_ARGUMENT		`dispatchConstrainerEnablerId` or `dispatchConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canSequenceDispatchConstrainerEnablers
Description	Tests if this user can order `DispatchConstrainerEnablers`. 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 `DispatchConstrainerEnabler` ordering is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	moveDispatchConstrainerEnablerAhead
Description	Reorders dispatch constrainer enablers for a dispatch constrainer by moving the specified dispatch constrainer enabler in front of a reference dispatch constrainer enabler.
Parameters	`osid.id.Id`	`dispatchConstrainerEnablerId`	the `Id` of the `DispatchConstrainerEnabler`
	`osid.id.Id`	`dispatchConstrainerId`	the `Id` of the `DispatchConstrainer`
	`osid.id.Id`	`referenceId`	the reference dispatch constrainer enabler `Id`
Errors	NOT_FOUND		`dispatchConstrainerEnablerId dispatchConstrainerId`, or `referenceId` not found or, `dispatchConstrainerEnablerId` or `referenceId` not related to `dispatchConstrainerId`
	NULL_ARGUMENT		`dispatchConstrainerEnablerId, dispatchConstrainerId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	moveDispatchConstrainerEnablerBehind
Description	Reorders dispatch constrainer enablers for a dispatch constrainer by moving the specified dispatch constrainer enabler behind a reference dispatch constrainer enabler.
Parameters	`osid.id.Id`	`dispatchConstrainerEnablerId`	the `Id` of the `DispatchConstrainerEnabler`
	`osid.id.Id`	`dispatchConstrainerId`	the `Id` of the `DispatchConstrainer`
	`osid.id.Id`	`referenceId`	the reference dispatch constrainer `Id`
Errors	NOT_FOUND		`dispatchConstrainerEnablerId dispatchConstrainerId`, or `referenceId` not found or, `dispatchConstrainerEnablerId` or `referenceId` not related to `dispatchConstrainerId`
	NULL_ARGUMENT		`dispatchConstrainerEnablerId, dispatchConstrainerId`, or `referenceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	orderDispatchConstrainerEnablers
Description	Reorders a set of dispatch constrainer enablers for a dispatch constrainer.
Parameters	`osid.id.Id[]`	`dispatchConstrainerEnablerIds`	the `Ids` for a set of `DispatchConstrainerEnablers`
Parameters	`osid.id.Id`	`dispatchConstrainerId`	the `Id` of the `DispatchConstrainer`
Errors	NOT_FOUND		`dispatchConstrainerId` not found or, a `dispatchConstrainerEnablerId` not related to `dispatchConstrainerId`
	NULL_ARGUMENT		`dispatchConstrainerEnablerIds` or `dispatchConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.