Interface | osid.configuration.rules.ParameterProcessorLookupSession | ||
---|---|---|---|
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 | getConfigurationId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Configuration Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getConfiguration | ||
Description |
Gets the | ||
Return | osid.configuration.Configuration | the configuration | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupParameterProcessors | ||
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 | useComparativeParameterProcessorView | ||
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 | usePlenaryParameterProcessorView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedConfigurationView | ||
Description |
Federates the view for methods in this session. A federated view will include parameter processor in configurations which are children of this configuration in the configuration hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedConfigurationView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this configuration only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useActiveParameterProcessorView | ||
Description |
Only active parameter processors are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyStatusParameterProcessorView | ||
Description |
All active and inactive parameter processors are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getParameterProcessor | ||
Description |
Gets the In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned. | ||
Parameters | osid.id.Id | parameterProcessorId | Id of the ParameterProcessor |
Return | osid.configuration.rules.ParameterProcessor | the parameter processor | |
Errors | NOT_FOUND | parameterProcessorId not found | |
NULL_ARGUMENT | parameterProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getParameterProcessorsByIds | ||
Description |
Gets a In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned. | ||
Parameters | osid.id.IdList | parameterProcessorIds | the list of Ids to retrieve |
Return | osid.configuration.rules.ParameterProcessorList | the returned ParameterProcessor list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | parameterProcessorIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParameterProcessorsByGenusType | ||
Description |
Gets a In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned. | ||
Parameters | osid.type.Type | parameterProcessorGenusType | a parameter processor genus type |
Return | osid.configuration.rules.ParameterProcessorList | the returned ParameterProcessor list | |
Errors | NULL_ARGUMENT | parameterProcessorGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParameterProcessorsByParentGenusType | ||
Description |
Gets a In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned. | ||
Parameters | osid.type.Type | parameterProcessorGenusType | a parameter processor genus type |
Return | osid.configuration.rules.ParameterProcessorList | the returned ParameterProcessor list | |
Errors | NULL_ARGUMENT | parameterProcessorGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParameterProcessorsByRecordType | ||
Description |
Gets a In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned. | ||
Parameters | osid.type.Type | parameterProcessorRecordType | a parameter processor record type |
Return | osid.configuration.rules.ParameterProcessorList | the returned ParameterProcessor list | |
Errors | NULL_ARGUMENT | parameterProcessorRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getParameterProcessors | ||
Description |
Gets all In plenary mode, the returned list contains all known parameter processor or an error results. Otherwise, the returned list may contain only those parameter processor that are accessible through this session. In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned. | ||
Return | osid.configuration.rules.ParameterProcessorList | the returned ParameterProcessor list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |