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

Interface	osid.subscription.rules.DispatchProcessorEnablerPublisherAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods to re-assign `DispatchProcessorEnabler` to `Publisher` mappings. A `DispatchProcessorEnabler` may appear in multiple `Publisher` catalogs and removing the last reference to a `DispatchProcessorEnabler` is the equivalent of deleting it. Each `Publisher` may have its own authorizations governing who is allowed to operate on it. Adding a reference of a `DispatchProcessorEnabler` to another `Publisher is n` ot a copy operation (eg: does not change its `Id`).
Method	canAssignDispatchProcessorEnablers
Description	Tests if this user can alter dispatch processor enabler/publisher 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. T` his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canAssignDispatchProcessorEnablerToPublisher
Description	Tests if this user can alter dispatch processor enabler/publisher 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. T` his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`boolean`		`false` if mapping is not authorized, `true` otherwise
Errors	NULL_ARGUMENT		`publisherId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAssignablePublisherIds
Description	Gets a list of publishers including and under the given publisher node in which any dispatch processor enabler can be assigned.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`osid.id.IdList`		list of assignable publisher `Ids`
Errors	NULL_ARGUMENT		`publisherId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getAssignablePublisherIdsForDispatchProcessorEnabler
Description	Gets a list of publishers including and under the given publisher node in which a specific dispatch processor enabler can be assigned.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Parameters	`osid.id.Id`	`dispatchProcessorEnablerId`	the `Id` of the `DispatchProcessorEnabler`
Return	`osid.id.IdList`		list of assignable publisher `Ids`
Errors	NULL_ARGUMENT		`publisherId` or `dispatchProcessorEnablerId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignDispatchProcessorEnablerToPublisher
Description	Adds an existing `DispatchProcessorEnabler` to a `Publisher`.
Parameters	`osid.id.Id`	`dispatchProcessorEnablerId`	the `Id` of the `DispatchProcessorEnabler`
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Errors	ALREADY_EXISTS		`dispatchProcessorEnablerId` is already assigned to `publisherId`
	NOT_FOUND		`dispatchProcessorEnablerId` or `publisherId` not found
	NULL_ARGUMENT		`dispatchProcessorEnablerId` or `publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignDispatchProcessorEnablerFromPublisher
Description	Removes a `DispatchProcessorEnabler` from a `Publisher`.
Parameters	`osid.id.Id`	`dispatchProcessorEnablerId`	the `Id` of the `DispatchProcessorEnabler`
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Errors	NOT_FOUND		`dispatchProcessorEnablerId` or `publisherId` not found or `dispatchProcessorEnablerId` not assigned to `publisherId`
	NULL_ARGUMENT		`dispatchProcessorEnablerId` or `publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignDispatchProcessorEnablerToPublisher
Description	Moves a `DispatchProcessorEnabler` from one `Publisher` to another. Mappings to other `Publishers` are unaffected.
Parameters	`osid.id.Id`	`dispatchProcessorEnablerId`	the `Id` of the `DispatchProcessorEnabler`
	`osid.id.Id`	`fromPublisherId`	the `Id` of the current `Publisher`
	`osid.id.Id`	`toPublisherId`	the `Id` of the destination `Publisher`
Errors	ALREADY_EXISTS		`dispatchProcessorEnablerId` already assigned to `toPublisherId`
	NOT_FOUND		`dispatchProcessorEnablerId, fromPublisherId`, or `toPublisherId` not found or `dispatchProcessorEnablerId` not mapped to `fromPublisherId`
	NULL_ARGUMENT		`dispatchProcessorEnablerId, fromPublisherId`, or `toPublisherId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.