Interface | osid.control.ActionGroupLookupSession | ||
---|---|---|---|
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 | getSystemId | ||
Description |
Gets the | ||
Return | osid.id.Id | the System Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getSystem | ||
Description |
Gets the | ||
Return | osid.control.System | the system | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupActionGroups | ||
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 | useComparativeActionGroupView | ||
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 | usePlenaryActionGroupView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedSystemView | ||
Description |
Federates the view for methods in this session. A federated view will include action groups in systems which are children of this system in the system hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedSystemView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this system only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getActionGroup | ||
Description |
Gets the | ||
Parameters | osid.id.Id | actionGroupId | Id of the ActionGroup |
Return | osid.control.ActionGroup | the action group | |
Errors | NOT_FOUND | actionGroupId not found | |
NULL_ARGUMENT | actionGroupId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getActionGroupsByIds | ||
Description |
Gets an | ||
Parameters | osid.id.IdList | actionGroupIds | the list of Ids to retrieve |
Return | osid.control.ActionGroupList | the returned ActionGroup list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | actionGroupIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActionGroupsByGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | actionGroupGenusType | an action group genus type |
Return | osid.control.ActionGroupList | the returned ActionGroup list | |
Errors | NULL_ARGUMENT | actionGroupGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActionGroupsByParentGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | actionGroupGenusType | an action group genus type |
Return | osid.control.ActionGroupList | the returned ActionGroup list | |
Errors | NULL_ARGUMENT | actionGroupGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActionGroupsByRecordType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | actionGroupRecordType | an action group record type |
Return | osid.control.ActionGroupList | the returned ActionGroup list | |
Errors | NULL_ARGUMENT | actionGroupRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActionGroupsByAction | ||
Description |
Gets an | ||
Parameters | osid.id.Id | actionId | an action Id |
Return | osid.control.ActionGroupList | the returned ActionGroup list | |
Errors | NULL_ARGUMENT | actionId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActionGroups | ||
Description |
Gets all In plenary mode, the returned list contains all known action groups or an error results. Otherwise, the returned list may contain only those action groups that are accessible through this session. | ||
Return | osid.control.ActionGroupList | a list of ActionGroups | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |