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

Interface	osid.subscription.rules.DispatchEnablerLookupSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.rules.SubscriptionRulesManager`
Used By	`osid.subscription.rules.SubscriptionRulesProxyManager`
Description	This session provides methods for retrieving `DispatchEnablers` . This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated publisher view: All dispatch enabler methods in this session operate, retrieve and pertain to dispatch enablers defined explicitly in the current publisher Using an isolated view is useful for managing `DispatchEnablers` with the `DispatchEnablerAdminSession` . federated publisher view: All dispatch enabler methods in this session operate, retrieve and pertain to all dispatch enablers defined in this publisher and any other dispatch enablers implicitly available in this publisher through publisher inheritence. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedPublisherView()` and `useIsolatedPublisherView() beha` ve as a radio group and one should be selected before invoking any lookup methods.
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	canLookupDispatchEnablers
Description	Tests if this user can perform `DispatchEnabler` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeDispatchEnablerView
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	usePlenaryDispatchEnablerView
Description	A complete view of the `DispatchEnabler` 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 enablers 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	getDispatchEnabler
Description	Gets the `DispatchEnabler` specified by its `Id` . In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `DispatchEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `DispatchEnabler and r` etained for compatibility.
Parameters	`osid.id.Id`	`dispatchEnablerId`	`Id` of the `DispatchEnabler`
Return	`osid.subscription.rules.DispatchEnabler`		the dispatch enabler
Errors	NOT_FOUND		`dispatchEnablerId` not found
	NULL_ARGUMENT		`dispatchEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getDispatchEnablersByIds
Description	Gets a `DispatchEnablerList` corresponding to the given `IdList` . In plenary mode, the returned list contains all of the dispatch enablers specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `DispatchEnablers may be` omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`dispatchEnablerIds`	the list of `Ids` to retrieve
Return	`osid.subscription.rules.DispatchEnablerList`		the returned `DispatchEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`dispatchEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchEnablersByGenusType
Description	Gets a `DispatchEnablerList` corresponding to the given dispatch enabler genus `Type` which does not include dispatch enablers of genus types derived from the specified `Type` . In plenary mode, the returned list contains all known dispatch enablers or an error results. Otherwise, the returned list may contain only those dispatch enablers that are accessible through this session.
Parameters	`osid.type.Type`	`dispatchEnablerGenusType`	a dispatch enabler genus type
Return	`osid.subscription.rules.DispatchEnablerList`		the returned `DispatchEnabler` list
Errors	NULL_ARGUMENT		`dispatchEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchEnablersByParentGenusType
Description	Gets a `DispatchEnablerList` corresponding to the given dispatch enabler genus `Type` and include any additional dispatch enablers with genus types derived from the specified `Type` . In plenary mode, the returned list contains all known dispatch enablers or an error results. Otherwise, the returned list may contain only those dispatch enablers that are accessible through this session.
Parameters	`osid.type.Type`	`dispatchEnablerGenusType`	a dispatch genus type
Return	`osid.subscription.rules.DispatchEnablerList`		the returned `DispatchEnabler` list
Errors	NULL_ARGUMENT		`dispatchEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchEnablersByRecordType
Description	Gets a `DispatchEnablerList` containing the given dispatch enabler record `Type` . In plenary mode, the returned list contains all known dispatch enablers or an error results. Otherwise, the returned list may contain only those dispatch enablers that are accessible through this session.
Parameters	`osid.type.Type`	`dispatchEnablerRecordType`	a dispatch enabler record type
Return	`osid.subscription.rules.DispatchEnablerList`		the returned `DispatchEnabler` list
Errors	NULL_ARGUMENT		`dispatchEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDispatchEnablers
Description	Gets all `DispatchEnablers` . In plenary mode, the returned list contains all known dispatch enablers or an error results. Otherwise, the returned list may contain only those dispatch enablers that are accessible through this session.
Return	`osid.subscription.rules.DispatchEnablerList`		a list of `DispatchEnablers`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.