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

Interface	osid.provisioning.rules.BrokerConstrainerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `BrokerConstrainers.` 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 constrainer methods in this session operate, retrieve and pertain to broker constrainer defined explicitly in the current distributor. Using an isolated view is useful for managing `BrokerConstrainers` with the `BrokerConstrainerAdminSession.` federated distributor view: All broker constrainer methods in this session operate, retrieve and pertain to all broker constrainer defined in this distributor and any other broker constrainer implicitly available in this distributor through distributor inheritence. active broker constrainer view: All broker constrainer lookup methods return active broker constrainers. any status broker constrainer view: Broker constrainers 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	canLookupBrokerConstrainers
Description	Tests if this user can perform `BrokerConstrainers` 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	useComparativeBrokerConstrainerView
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	usePlenaryBrokerConstrainerView
Description	A complete view of the `BrokerConstrainer` 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 constrainer 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	useActiveBrokerConstrainerView
Description	Only active broker constrainers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusBrokerConstrainerView
Description	All active and inactive broker constrainers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getBrokerConstrainer
Description	Gets the `BrokerConstrainer` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `BrokerConstrainer` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `BrokerConstrainer` and retained for compatibility. In active mode, offset broker constrainers are returned that are currently active. In any status mode, active and inactive offset broker constrainers are returned.
Parameters	`osid.id.Id`	`brokerConstrainerId`	`Id` of the `BrokerConstrainer`
Return	`osid.provisioning.rules.BrokerConstrainer`		the broker constrainer
Errors	NOT_FOUND		`brokerConstrainerId` not found
	NULL_ARGUMENT		`brokerConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getBrokerConstrainersByIds
Description	Gets a `BrokerConstrainerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the broker constrainer 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 `BrokerConstrainers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, offset broker constrainers are returned that are currently active. In any status mode, active and inactive offset broker constrainers are returned.
Parameters	`osid.id.IdList`	`brokerConstrainerIds`	the list of `Ids` to retrieve
Return	`osid.provisioning.rules.BrokerConstrainerList`		the returned `BrokerConstrainer` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`brokerConstrainerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerConstrainersByGenusType
Description	Gets a `BrokerConstrainerList` corresponding to the given broker constrainer genus `Type` which does not include broker constrainer of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known broker constrainer or an error results. Otherwise, the returned list may contain only those broker constrainer that are accessible through this session. In active mode, offset broker constrainers are returned that are currently active. In any status mode, active and inactive offset broker constrainers are returned.
Parameters	`osid.type.Type`	`brokerConstrainerGenusType`	a broker constrainer genus type
Return	`osid.provisioning.rules.BrokerConstrainerList`		the returned `BrokerConstrainer` list
Errors	NULL_ARGUMENT		`brokerConstrainerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerConstrainersByParentGenusType
Description	Gets a `BrokerConstrainerList` corresponding to the given broker constrainer genus `Type` and include any additional broker constrainer with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known broker constrainer or an error results. Otherwise, the returned list may contain only those broker constrainer that are accessible through this session. In active mode, offset broker constrainers are returned that are currently active. In any status mode, active and inactive offset broker constrainers are returned.
Parameters	`osid.type.Type`	`brokerConstrainerGenusType`	a broker constrainer genus type
Return	`osid.provisioning.rules.BrokerConstrainerList`		the returned `BrokerConstrainer` list
Errors	NULL_ARGUMENT		`brokerConstrainerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerConstrainersByRecordType
Description	Gets a `BrokerConstrainerList` containing the given broker constrainer record `Type.` In plenary mode, the returned list contains all known broker constrainer or an error results. Otherwise, the returned list may contain only those broker constrainer that are accessible through this session. In active mode, offset broker constrainers are returned that are currently active. In any status mode, active and inactive offset broker constrainers are returned.
Parameters	`osid.type.Type`	`brokerConstrainerRecordType`	a broker constrainer record type
Return	`osid.provisioning.rules.BrokerConstrainerList`		the returned `BrokerConstrainer` list
Errors	NULL_ARGUMENT		`brokerConstrainerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getBrokerConstrainers
Description	Gets all `BrokerConstrainers.` In plenary mode, the returned list contains all known broker constrainer or an error results. Otherwise, the returned list may contain only those broker constrainer that are accessible through this session. In active mode, offset broker constrainers are returned that are currently active. In any status mode, active and inactive offset broker constrainers are returned.
Return	`osid.provisioning.rules.BrokerConstrainerList`		the returned `BrokerConstrainer` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.