OSID - osid.cataloging.rules.CatalogEnablerLookupSession Service Interface Definition

Interface	osid.cataloging.rules.CatalogEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `CatalogEnablers.` A `CatalogEnabler` enables a catalog node in a federated hierarchy. 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 catalog view: All catalog enabler methods in this session operate, retrieve and pertain to catalog enablers defined explicitly in the current catalog. Using an isolated view is useful for managing `CatalogEnablers` with the `CatalogEnablerAdminSession.` federated catalog view: All catalog enabler methods in this session operate, retrieve and pertain to all catalog enablers defined in this catalog and any other catalog enablers implicitly available in this catalog through catalog inheritence. active catalog enabler view: All catalog enabler lookup methods return active catalog enablers. any status catalog enabler view: Catalog enablers of any active or inactive status are returned from methods. 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 `useFederatedDistributorView()` and `useIsolatedDistributorView()` behave as a radio group and one should be selected before invoking the methods in this session.
Method	getCatalogId
Description	Gets the `Catalog` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalog
Description	Gets the `Catalog` associated with this session.
Return	`osid.cataloging.Catalog`		the catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupCatalogEnablers
Description	Tests if this user can perform `CatalogEnablers` 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	useComparativeCatalogEnablerView
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	usePlenaryCatalogEnablerView
Description	A complete view of the `CatalogEnabler` 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	useFederatedCatalogView
Description	Federates the view for methods in this session. A federated view will include catalog enablers in catalogs which are children of this catalog in the catalog hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCatalogView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveCatalogEnablerView
Description	Only active catalog enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusCatalogEnablerView
Description	All active and inactive catalog enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getCatalogEnabler
Description	Gets the `CatalogEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `CatalogEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `CatalogEnabler` and retained for compatibility. In active mode, catalog enablers are returned that are currently active. In any status mode, active and inactive catalog enablers are returned.
Parameters	`osid.id.Id`	`catalogEnablerId`	`Id` of the `CatalogEnabler`
Return	`osid.cataloging.rules.CatalogEnabler`		the catalog enabler
Errors	NOT_FOUND		`catalogEnablerId` not found
	NULL_ARGUMENT		`catalogEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getCatalogEnablersByIds
Description	Gets a `CatalogEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the catalog 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 `CatalogEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, catalog enablers are returned that are currently active. In any status mode, active and inactive catalog enablers are returned.
Parameters	`osid.id.IdList`	`catalogEnablerIds`	the list of `Ids` to retrieve
Return	`osid.cataloging.rules.CatalogEnablerList`		the returned `CatalogEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`catalogEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogEnablersByGenusType
Description	Gets a `CatalogEnablerList` corresponding to the given catalog enabler genus `Type` which does not include catalog enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known catalog enablers or an error results. Otherwise, the returned list may contain only those catalog enablers that are accessible through this session. In active mode, catalog enablers are returned that are currently active. In any status mode, active and inactive catalog enablers are returned.
Parameters	`osid.type.Type`	`catalogEnablerGenusType`	a catalog enabler genus type
Return	`osid.cataloging.rules.CatalogEnablerList`		the returned `CatalogEnabler` list
Errors	NULL_ARGUMENT		`catalogEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogEnablersByParentGenusType
Description	Gets a `CatalogEnablerList` corresponding to the given catalog enabler genus `Type` and include any additional catalog enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known catalog enablers or an error results. Otherwise, the returned list may contain only those catalog enablers that are accessible through this session. In active mode, catalog enablers are returned that are currently active. In any status mode, active and inactive catalog enablers are returned.
Parameters	`osid.type.Type`	`catalogEnablerGenusType`	a catalog enabler genus type
Return	`osid.cataloging.rules.CatalogEnablerList`		the returned `CatalogEnabler` list
Errors	NULL_ARGUMENT		`catalogEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogEnablersByRecordType
Description	Gets a `CatalogEnablerList` containing the given catalog enabler record `Type.` In plenary mode, the returned list contains all known catalog enablers or an error results. Otherwise, the returned list may contain only those catalog enablers that are accessible through this session. In active mode, catalog enablers are returned that are currently active. In any status mode, active and inactive catalog enablers are returned.
Parameters	`osid.type.Type`	`catalogEnablerRecordType`	a catalog enabler record type
Return	`osid.cataloging.rules.CatalogEnablerList`		the returned `CatalogEnabler` list
Errors	NULL_ARGUMENT		`catalogEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogEnablersOnDate
Description	Gets a `CatalogEnablerList` effective for the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known catalog enablers or an error results. Otherwise, the returned list may contain only those catalog enablers that are accessible through this session. In active mode, catalog enablers are returned that are currently active. In any status mode, active and inactive catalog enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.cataloging.rules.CatalogEnablerList`		the returned `CatalogEnabler` 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	getCatalogEnablersOnDateWithAgent
Description	Gets a `CatalogEnablerList` 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 catalog enablers or an error results. Otherwise, the returned list may contain only those catalog enablers that are accessible through this session. In active mode, catalog enablers are returned that are currently active. In any status mode, active and inactive catalog enablers 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.cataloging.rules.CatalogEnablerList`		the returned `CatalogEnabler` 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	getCatalogEnablers
Description	Gets all `CatalogEnablers.` In plenary mode, the returned list contains all known catalog enablers or an error results. Otherwise, the returned list may contain only those catalog enablers that are accessible through this session. In both cases, the order of the set is not specified. In active mode, catalog enablers are returned that are currently active. In any status mode, active and inactive catalog enablers are returned.
Return	`osid.cataloging.rules.CatalogEnablerList`		the returned `CatalogEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.