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

Interface	osid.subscription.rules.DispatchConstrainerRuleLookupSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods to retrieve `DispatchConstrainer` to `Dispatch` mappings. `Th` is 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 isolated publisher view: All methods in this session operate, retrieve and pertain to dispatch constrainers defined explicitly in the current publisher federated publisher view: All methods in this session operate, retrieve and pertain to all dispatch constrainers defined in this publisher and any other dispatch constrainers implicitly available in this publisher through publisher inheritence.
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	canLookupDispatchConstrainerRules
Description	Tests if this user can perform lookups of dispatch constrainer/dispatch 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` .This 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	useComparativeDispatchConstrainerRuleView
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	usePlenaryDispatchConstrainerRuleView
Description	A complete view of the `DispatchConstrainer` and `Dispatch` 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	useFederatedPublisherView
Description	Federates the view for methods in this session. A federated view will include dispatch constrainers in publishers which are children of this publisher in the publisher hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedPublisherView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this publisher only.
Compliance	`mandatory`		This method is must be implemented.
Method	getDispatchConstrainerIdsForDispatch
Description	Gets the `DispatchConstrainer Ids` associated with a `Dispatch` .
Parameters	`osid.id.Id`	`dispatchId`	`Id` of the `Dispatch`
Return	`osid.id.IdList`		the dispatch constrainer `Ids`
Errors	NOT_FOUND		`dispatchId` is not found
	NULL_ARGUMENT		`dispatchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchConstrainersForDispatch
Description	Gets the `DispatchConstrainers` associated with a `Dispatch` .
Parameters	`osid.id.Id`	`dispatchId`	`Id` of the `Dispatch`
Return	`osid.subscription.rules.DispatchConstrainerList`		the dispatch constrainers
Errors	NOT_FOUND		`dispatchId` is not found
	NULL_ARGUMENT		`dispatchId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchIdsForDispatchConstrainer
Description	Gets the `Dispatch` `Ids` mapped to a `DispatchConstrainer` .
Parameters	`osid.id.Id`	`dispatchConstrainerId`	`Id` of a `DispatchConstrainer`
Return	`osid.id.IdList`		list of dispatch `Ids`
Errors	NOT_FOUND		`dispatchConstrainerId` is not found
	NULL_ARGUMENT		`dispatchConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchesForDispatchConstrainer
Description	Gets the `Dispatches` mapped to a `DispatchConstrainer` .
Parameters	`osid.id.Id`	`dispatchConstrainerId`	`Id` of a `DispatchConstrainer`
Return	`osid.subscription.DispatchList`		list of dispatches
Errors	NOT_FOUND		`dispatchConstrainerId` is not found
	NULL_ARGUMENT		`dispatchConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.