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

Interface	osid.subscription.rules.SubscriptionEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `SubscriptionEnablers.` 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 subscription enabler methods in this session operate, retrieve and pertain to subscription enablers defined explicitly in the current publisher. Using an isolated view is useful for managing `SubscriptionEnablers` with the `SubscriptionEnablerAdminSession.` federated publisher view: All subscription enabler methods in this session operate, retrieve and pertain to all subscription enablers defined in this publisher and any other subscription enablers implicitly available in this publisher through publisher inheritence. active subscription enabler view: All subscription enabler lookup methods return active subscription enablers. any status subscription enabler view: Subscription enablers of any active or inactive status are returned from 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	canLookupSubscriptionEnablers
Description	Tests if this user can perform `SubscriptionEnablers` 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	useComparativeSubscriptionEnablerView
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	usePlenarySubscriptionEnablerView
Description	A complete view of the `SubscriptionEnabler` 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 subscription 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	useActiveSubscriptionEnablerView
Description	Only active subscription enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusSubscriptionEnablerView
Description	All active and inactive subscription enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getSubscriptionEnabler
Description	Gets the `SubscriptionEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `SubscriptionEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `SubscriptionEnabler` and retained for compatibility. In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.
Parameters	`osid.id.Id`	`subscriptionEnablerId`	`Id` of the `SubscriptionEnabler`
Return	`osid.subscription.rules.SubscriptionEnabler`		the subscription enabler
Errors	NOT_FOUND		`subscriptionEnablerId` not found
	NULL_ARGUMENT		`subscriptionEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getSubscriptionEnablersByIds
Description	Gets a `SubscriptionEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the subscription 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 `SubscriptionEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.
Parameters	`osid.id.IdList`	`subscriptionEnablerIds`	the list of `Ids` to retrieve
Return	`osid.subscription.rules.SubscriptionEnablerList`		the returned `SubscriptionEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`subscriptionEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionEnablersByGenusType
Description	Gets a `SubscriptionEnablerList` corresponding to the given subscription enabler genus `Type` which does not include subscription enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session. In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.
Parameters	`osid.type.Type`	`subscriptionEnablerGenusType`	a subscription enabler genus type
Return	`osid.subscription.rules.SubscriptionEnablerList`		the returned `SubscriptionEnabler` list
Errors	NULL_ARGUMENT		`subscriptionEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionEnablersByParentGenusType
Description	Gets a `SubscriptionEnablerList` corresponding to the given subscription enabler genus `Type` and include any additional subscription enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session. In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.
Parameters	`osid.type.Type`	`subscriptionEnablerGenusType`	a subscription enabler genus type
Return	`osid.subscription.rules.SubscriptionEnablerList`		the returned `SubscriptionEnabler` list
Errors	NULL_ARGUMENT		`subscriptionEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionEnablersByRecordType
Description	Gets a `SubscriptionEnablerList` containing the given subscription enabler record `Type.` In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session. In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.
Parameters	`osid.type.Type`	`subscriptionEnablerRecordType`	a subscription enabler record type
Return	`osid.subscription.rules.SubscriptionEnablerList`		the returned `SubscriptionEnabler` list
Errors	NULL_ARGUMENT		`subscriptionEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionEnablersOnDate
Description	Gets a `SubscriptionEnablerList` that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session. In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.subscription.rules.SubscriptionEnablerList`		the returned `SubscriptionEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionEnablersOnDateWithAgent
Description	Gets a `SubscriptionEnablerList` that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session. In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.
Parameters	`osid.id.Id`	`agentId`	an agent Id
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.subscription.rules.SubscriptionEnablerList`		the returned `SubscriptionEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agentId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionEnablers
Description	Gets all `SubscriptionEnablers.` In plenary mode, the returned list contains all known subscription enablers or an error results. Otherwise, the returned list may contain only those subscription enablers that are accessible through this session. In active mode, subscription are returned that are currently active. In any status mode, active and inactive subscription are returned.
Return	`osid.subscription.rules.SubscriptionEnablerList`		the returned `SubscriptionEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.