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

Interface	osid.provisioning.rules.BrokerProcessorLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `BrokerProcessors.` 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 methods in this session operate, retrieve and pertain to broker processor defined explicitly in the current distributor. Using an isolated view is useful for managing `BrokerProcessors` with the `BrokerProcessorAdminSession.` federated distributor view: All broker processor methods in this session operate, retrieve and pertain to all broker processor defined in this distributor and any other broker processor implicitly available in this distributor through distributor inheritence. active broker processor view: All broker processor lookup methods return active broker processors. any status broker processor view: Broker processors of any active and 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	canLookupBrokerProcessors
Description	Tests if this user can perform `BrokerProcessors` 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	useComparativeBrokerProcessorView
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	usePlenaryBrokerProcessorView
Description	A complete view of the `BrokerProcessor` 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 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	useActiveBrokerProcessorView
Description	Only active broker processors are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusBrokerProcessorView
Description	All active and inactive broker processors are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getBrokerProcessor
Description	Gets the `BrokerProcessor` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `BrokerProcessor` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `BrokerProcessor` and retained for compatibility. In active mode, broker processors are returned that are currently active. In any status mode, active and inactive broker processors are returned.
Parameters	`osid.id.Id`	`brokerProcessorId`	`Id` of the `BrokerProcessor`
Return	`osid.provisioning.rules.BrokerProcessor`		the broker processor
Errors	NOT_FOUND		`brokerProcessorId` not found
	NULL_ARGUMENT		`brokerProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getBrokerProcessorsByIds
Description	Gets a `BrokerProcessorList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the broker processor 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 `BrokerProcessors` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, broker processors are returned that are currently active. In any status mode, active and inactive broker processors are returned.
Parameters	`osid.id.IdList`	`brokerProcessorIds`	the list of `Ids` to retrieve
Return	`osid.provisioning.rules.BrokerProcessorList`		the returned `BrokerProcessor` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`brokerProcessorIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorsByGenusType
Description	Gets a `BrokerProcessorList` corresponding to the given broker processor genus `Type` which does not include broker processor of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known broker processor or an error results. Otherwise, the returned list may contain only those broker processor that are accessible through this session. In active mode, broker processors are returned that are currently active. In any status mode, active and inactive broker processors are returned.
Parameters	`osid.type.Type`	`brokerProcessorGenusType`	a broker processor genus type
Return	`osid.provisioning.rules.BrokerProcessorList`		the returned `BrokerProcessor` list
Errors	NULL_ARGUMENT		`brokerProcessorGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorsByParentGenusType
Description	Gets a `BrokerProcessorList` corresponding to the given broker processor genus `Type` and include any additional broker processor with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known broker processor or an error results. Otherwise, the returned list may contain only those broker processor that are accessible through this session. In active mode, broker processors are returned that are currently active. In any status mode, active and inactive broker processors are returned.
Parameters	`osid.type.Type`	`brokerProcessorGenusType`	a broker processor genus type
Return	`osid.provisioning.rules.BrokerProcessorList`		the returned `BrokerProcessor` list
Errors	NULL_ARGUMENT		`brokerProcessorGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessorsByRecordType
Description	Gets a `BrokerProcessorList` containing the given broker processor record `Type.` In plenary mode, the returned list contains all known broker processor or an error results. Otherwise, the returned list may contain only those broker processor that are accessible through this session. In active mode, broker processors are returned that are currently active. In any status mode, active and inactive broker processors are returned.
Parameters	`osid.type.Type`	`brokerProcessorRecordType`	a broker processor record type
Return	`osid.provisioning.rules.BrokerProcessorList`		the returned `BrokerProcessor` list
Errors	NULL_ARGUMENT		`brokerProcessorRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerProcessors
Description	Gets all `BrokerProcessors.` In plenary mode, the returned list contains all known broker processor or an error results. Otherwise, the returned list may contain only those broker processor that are accessible through this session. In active mode, broker processors are returned that are currently active. In any status mode, active and inactive broker processors are returned.
Return	`osid.provisioning.rules.BrokerProcessorList`		the returned `BrokerProcessor` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.