OSID - osid.provisioning.rules.BrokerProcessorEnablerLookupSession Service Interface Definition

Interface	osid.provisioning.rules.BrokerProcessorEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `BrokerProcessorEnablers.` 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 distributor view: All broker processor enabler methods in this session operate, retrieve and pertain to broker processor enablers defined explicitly in the current distributor. Using an isolated view is useful for managing `BrokerProcessorEnablers` with the `BrokerProcessorEnablerAdminSession.` federated distributor view: All broker processor enabler methods in this session operate, retrieve and pertain to all broker processor enablers defined in this distributor and any other broker processor enablers implicitly available in this distributor through distributor inheritence. active broker processor enabler view: All broker processor enabler lookup methods return active broker processor enablers. any status broker processor enabler view: Broker processor 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	getDistributorId
Description	Gets the `Distributor` `Id` associated with this session.
Return	`osid.id.Id`		the `Distributor Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getDistributor
Description	Gets the `Distributor` associated with this session.
Return	`osid.provisioning.Distributor`		the distributor
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupBrokerProcessorEnablers
Description	Tests if this user can perform `BrokerProcessorEnablers` 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	useComparativeBrokerProcessorEnablerView
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	usePlenaryBrokerProcessorEnablerView
Description	A complete view of the `BrokerProcessorEnabler` 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	useFederatedDistributorView
Description	Federates the view for methods in this session. A federated view will include broker processor enablers in distributors which are children of this distributor in the distributor hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedDistributorView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this distributor only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveBrokerProcessorEnablerView
Description	Only active broker processor enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusBrokerProcessorEnablerView
Description	All active and inactive broker processor enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getBrokerProcessorEnabler
Description	Gets the `BrokerProcessorEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `BrokerProcessorEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `BrokerProcessorEnabler` and retained for compatibility. In active mode, broker processor enablers are returned that are currently active. In any status mode, active and inactive broker processor enablers are returned.
Parameters	`osid.id.Id`	`brokerProcessorEnablerId`	`Id` of the `BrokerProcessorEnabler`
Return	`osid.provisioning.rules.BrokerProcessorEnabler`		the broker processor enabler
Errors	NOT_FOUND		`brokerProcessorEnablerId` not found
	NULL_ARGUMENT		`brokerProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getBrokerProcessorEnablersByIds
Description	Gets a `BrokerProcessorEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the broker processor 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 `BrokerProcessorEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, broker processor enablers are returned that are currently active. In any status mode, active and inactive broker processor enablers are returned.
Parameters	`osid.id.IdList`	`brokerProcessorEnablerIds`	the list of `Ids` to retrieve
Return	`osid.provisioning.rules.BrokerProcessorEnablerList`		the returned `BrokerProcessorEnabler` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`brokerProcessorEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorEnablersByGenusType
Description	Gets a `BrokerProcessorEnablerList` corresponding to the given broker processor enabler genus `Type` which does not include broker processor enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known broker processor enablers or an error results. Otherwise, the returned list may contain only those broker processor enablers that are accessible through this session. In active mode, broker processor enablers are returned that are currently active. In any status mode, active and inactive broker processor enablers are returned.
Parameters	`osid.type.Type`	`brokerProcessorEnablerGenusType`	a broker processor enabler genus type
Return	`osid.provisioning.rules.BrokerProcessorEnablerList`		the returned `BrokerProcessorEnabler` list
Errors	NULL_ARGUMENT		`brokerProcessorEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorEnablersByParentGenusType
Description	Gets a `BrokerProcessorEnablerList` corresponding to the given broker processor enabler genus `Type` and include any additional broker processor enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known broker processor enablers or an error results. Otherwise, the returned list may contain only those broker processor enablers that are accessible through this session. In active mode, broker processor enablers are returned that are currently active. In any status mode, active and inactive broker processor enablers are returned.
Parameters	`osid.type.Type`	`brokerProcessorEnablerGenusType`	a broker processor enabler genus type
Return	`osid.provisioning.rules.BrokerProcessorEnablerList`		the returned `BrokerProcessorEnabler` list
Errors	NULL_ARGUMENT		`brokerProcessorEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorEnablersByRecordType
Description	Gets a `BrokerProcessorEnablerList` containing the given broker processor enabler record `Type.` In plenary mode, the returned list contains all known broker processor enablers or an error results. Otherwise, the returned list may contain only those broker processor enablers that are accessible through this session. In active mode, broker processor enablers are returned that are currently active. In any status mode, active and inactive broker processor enablers are returned.
Parameters	`osid.type.Type`	`brokerProcessorEnablerRecordType`	a broker processor enabler record type
Return	`osid.provisioning.rules.BrokerProcessorEnablerList`		the returned `BrokerProcessorEnabler` list
Errors	NULL_ARGUMENT		`brokerProcessorEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorEnablersOnDate
Description	Gets a `BrokerProcessorEnablerList` effective for the entire the given date range inclusive but not confisned to the date range for any agent. In plenary mode, the returned list contains all known broker processor enablers or an error results. Otherwise, the returned list may contain only those broker processor enablers that are accessible through this session. In active mode, broker processor enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive broker processor enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.provisioning.rules.BrokerProcessorEnablerList`		the returned `BrokerProcessorEnabler` 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	getBrokerProcessorEnablersOnDateWithAgent
Description	Gets a `BrokerProcessorEnablerList` effective for the entire the given date range inclusive but not confisned to the date range for any agent. In plenary mode, the returned list contains all known broker processor enablers or an error results. Otherwise, the returned list may contain only those broker processor enablers that are accessible through this session. In active mode, broker processor enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive broker processor 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.provisioning.rules.BrokerProcessorEnablerList`		the returned `BrokerProcessorEnabler` 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	getBrokerProcessorEnablers
Description	Gets all `BrokerProcessorEnablers.` In plenary mode, the returned list contains all known broker processor enablers or an error results. Otherwise, the returned list may contain only those broker processor enablers that are accessible through this session. In active mode, broker processor enablers are returned that are currently active. In any status mode, active and inactive broker processor enablers are returned.
Return	`osid.provisioning.rules.BrokerProcessorEnablerList`		the returned `BrokerProcessorEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.