OSID - osid.subscription.DispatchPublisherAssignmentSession Service Interface Definition

Interface	osid.subscription.DispatchPublisherAssignmentSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.SubscriptionManager`
Used By	`osid.subscription.SubscriptionProxyManager`
Description	This session provides methods to re-assign `Dispatches` to `Publishers` . A `Dispatch` may map to multiple `Publishers` and removing the last reference to a `Dispatch` 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 `Dispatch` to another `Publisher` is not a copy operation (eg: does not change its `Id` ).
Method	canAssignDispatches
Description	Tests if this user can alter dispatch/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` . This 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	canAssignDispatchesToPublisher
Description	Tests if this user can alter dispatch/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` . This 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 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	getAssignablePublisherIdsForDispatch
Description	Gets a list of publishers including and under the given publisher node in which a specific dispatch can be assigned.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
Return	`osid.id.IdList`		list of assignable publisher `Ids`
Errors	NULL_ARGUMENT		`publisherId` or `dispatchId` is `null`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	assignDispatchToPublisher
Description	Adds an existing `Dispatch` to a `Publisher` .
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Errors	ALREADY_EXISTS		`dispatchId` is already assigned to `publisherId`
	NOT_FOUND		`dispatchId` or `publisherId` not found
	NULL_ARGUMENT		`dispatchId` or `publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	unassignDispatchFromPublisher
Description	Removes a `Dispatch` from a `Publisher` .
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Errors	NOT_FOUND		`dispatchId` or `publisherId` not found or `dispatchId` not assigned to `publisherId`
	NULL_ARGUMENT		`dispatchId` or `publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	reassignDispatchToPublisher
Description	Moves a `Dispatch` from one `Publisher` to another. Mappings to other `Publishers` are unaffected.
Parameters	`osid.id.Id`	`dispatchId`	the `Id` of the `Dispatch`
	`osid.id.Id`	`fromPublisherId`	the `Id` of the current `Publisher`
	`osid.id.Id`	`toPublisherId`	the `Id` of the destination `Publisher`
Errors	ALREADY_EXISTS		`dispatchId` already assigned to `toPublisherId`
	NOT_FOUND		`dispatchId, fromPublisherId` , or `toPublisherId` not found or `dispatchId` , not mapped to `fromPublisherId`
	NULL_ARGUMENT		`dispatchId, fromPublisherId` , or `toPublisherId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.