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

Interface	osid.subscription.rules.DispatchProcessorPublisherSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods to retrieve `DispatchProcessor` to `Publisher` mappings. A `DispatchProcessor` may appear in multiple `Publishers. Each pub` lisher may have its own authorizations governing who is allowed to look at it. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	canLookupDispatchProcessorPublisherMappings
Description	Tests if this user can perform lookups of dispatch processor/publisher mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeDispatchProcessorPublisherView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryDispatchProcessorPublisherView
Description	A complete view of the `DispatchProcessor` and `Publisher` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	getDispatchProcessorIdsByPublisher
Description	Gets the list of `DispatchProcessorIds` associated with a `Publisher` .
Parameters	`osid.id.Id`	`publisherId`	`Id` of the `Publisher`
Return	`osid.id.IdList`		list of related dispatch processor `Ids`
Errors	NOT_FOUND		`publisherId` is not found
	NULL_ARGUMENT		`publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchProcessorsByPublisher
Description	Gets the list of `DispatchProcessors` associated with a `Publisher` .
Parameters	`osid.id.Id`	`publisherId`	`Id` of the `Publisher`
Return	`osid.subscription.rules.DispatchProcessorList`		list of related dispatch processors
Errors	NOT_FOUND		`publisherId` is not found
	NULL_ARGUMENT		`publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchProcessorIdsByPublishers
Description	Gets the list of `DispatchConstrainerIds` corresponding to a list of `Publishers` .
Parameters	`osid.id.IdList`	`publisherIds`	list of publisher `Ids`
Return	`osid.id.IdList`		list of dispatch processor `Ids`
Errors	NULL_ARGUMENT		`publisherIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchProcessorsByPublishers
Description	Gets the list of `DispatchConstrainers` corresponding to a list of `Publishers` .
Parameters	`osid.id.IdList`	`publisherIds`	list of publisher `Ids`
Return	`osid.subscription.rules.DispatchProcessorList`		list of dispatch processors
Errors	NULL_ARGUMENT		`publisherIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPublisherIdsByDispatchProcessor
Description	Gets the `Publisher` `Ids` mapped to a `DispatchProcessor` .
Parameters	`osid.id.Id`	`dispatchProcessorId`	`Id` of a `DispatchProcessor`
Return	`osid.id.IdList`		list of publisher `Ids`
Errors	NOT_FOUND		`dispatchProcessorId` is not found
	NULL_ARGUMENT		`dispatchProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getPublishersByDispatchProcessor
Description	Gets the `Publishers` mapped to a `DispatchConstrainer` .
Parameters	`osid.id.Id`	`dispatchProcessorId`	`Id` of a `DispatchProcessor`
Return	`osid.subscription.PublisherList`		list of publishers
Errors	NOT_FOUND		`dispatchProcessorId` is not found
	NULL_ARGUMENT		`dispatchProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.