Interface | osid.provisioning.rules.BrokerConstrainerEnablerLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
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 | ||
Method | getDistributorId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Distributor Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistributor | ||
Description |
Gets the | ||
Return | osid.provisioning.Distributor | the distributor | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupBrokerConstrainerEnablers | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeBrokerConstrainerEnablerView | ||
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 | usePlenaryBrokerConstrainerEnablerView | ||
Description |
A complete view of the | ||
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 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 | useActiveBrokerConstrainerEnablerView | ||
Description |
Only active broker constrainer enablers are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusBrokerConstrainerEnablerView | ||
Description |
All active and inactive broker constrainer enablers are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getBrokerConstrainerEnabler | ||
Description |
Gets the In active mode, broker constrainer enablers are returned that are currently active. In any status mode, active and inactive broker constrainer enablers are returned. | ||
Parameters | osid.id.Id | brokerConstrainerEnablerId | Id of the BrokerConstrainerEnabler |
Return | osid.provisioning.rules.BrokerConstrainerEnabler | the broker constrainer enabler | |
Errors | NOT_FOUND | brokerConstrainerEnablerId not found | |
NULL_ARGUMENT | brokerConstrainerEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getBrokerConstrainerEnablersByIds | ||
Description |
Gets a In active mode, broker constrainer enablers are returned that are currently active. In any status mode, active and inactive broker constrainer enablers are returned. | ||
Parameters | osid.id.IdList | brokerConstrainerEnablerIds | the list of Ids to retrieve |
Return | osid.provisioning.rules.BrokerConstrainerEnablerList | the returned BrokerConstrainerEnabler list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | brokerConstrainerEnablerIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBrokerConstrainerEnablersByGenusType | ||
Description |
Gets a In active mode, broker constrainer enablers are returned that are currently active. In any status mode, active and inactive broker constrainer enablers are returned. | ||
Parameters | osid.type.Type | brokerConstrainerEnablerGenusType | a broker constrainer enabler genus type |
Return | osid.provisioning.rules.BrokerConstrainerEnablerList | the returned BrokerConstrainerEnabler list | |
Errors | NULL_ARGUMENT | brokerConstrainerEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBrokerConstrainerEnablersByParentGenusType | ||
Description |
Gets a In active mode, broker constrainer enablers are returned that are currently active. In any status mode, active and inactive broker constrainer enablers are returned. | ||
Parameters | osid.type.Type | brokerConstrainerEnablerGenusType | a broker constrainer enabler genus type |
Return | osid.provisioning.rules.BrokerConstrainerEnablerList | the returned BrokerConstrainerEnabler list | |
Errors | NULL_ARGUMENT | brokerConstrainerEnablerGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBrokerConstrainerEnablersByRecordType | ||
Description |
Gets a In active mode, broker constrainer enablers are returned that are currently active. In any status mode, active and inactive broker constrainer enablers are returned. | ||
Parameters | osid.type.Type | brokerConstrainerEnablerRecordType | a broker constrainer enabler record type |
Return | osid.provisioning.rules.BrokerConstrainerEnablerList | the returned BrokerConstrainerEnabler list | |
Errors | NULL_ARGUMENT | brokerConstrainerEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBrokerConstrainerEnablersOnDate | ||
Description |
Gets a In active mode, broker constrainer 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 constrainer enablers are returned. | ||
Parameters | osid.calendaring.DateTime | from | a start date |
osid.calendaring.DateTime | to | an end date | |
Return | osid.provisioning.rules.BrokerConstrainerEnablerList | the returned BrokerConstrainerEnabler 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 | getBrokerConstrainerEnablersOnDateWithAgent | ||
Description |
Gets a In active mode, broker constrainer 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 constrainer 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.BrokerConstrainerEnablerList | the returned BrokerConstrainerEnabler 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 | getBrokerConstrainerEnablers | ||
Description |
Gets all In plenary mode, the returned list contains all known broker constrainer enablers or an error results. Otherwise, the returned list may contain only those broker constrainer enablers that are accessible through this session. In active mode, broker constrainer enablers are returned that are currently active. In any status mode, active and inactive broker constrainer enablers are returned. | ||
Return | osid.provisioning.rules.BrokerConstrainerEnablerList | the returned BrokerConstrainerEnabler list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |