OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.ActionGroupLookupSession
Implementsosid.OsidSession
Description

This session provides methods for retrieving ActionGroup objects.

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 system view: All action group methods in this session operate, retrieve and pertain to action groups defined explicitly in the current system. Using an isolated view is useful for managing ActionGroups with the ActionGroupAdminSession.
  • federated system view: All action group methods in this session operate, retrieve and pertain to all action groups defined in this system and any other action groups implicitly available in this system through system inheritence.

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 useFederatedSystemView() and useIsolatedSystemView() behave as a radio group and one should be selected before invoking any lookup methods.

MethodgetSystemId
Description

Gets the System Id associated with this session.

Returnosid.id.Idthe System Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetSystem
Description

Gets the System associated with this session.

Returnosid.control.Systemthe system
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupActionGroups
Description

Tests if this user can perform ActionGroup 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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeActionGroupView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryActionGroupView
Description

A complete view of the ActionGroup 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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedSystemView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedSystemView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this system only.

CompliancemandatoryThis method is must be implemented.
MethodgetActionGroup
Description

Gets the ActionGroup specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned ActionGroup may have a different Id than requested, such as the case where a duplicate Id was assigned to an ActionGroup and retained for compatibility.

Parametersosid.id.IdactionGroupId Id of the ActionGroup
Returnosid.control.ActionGroupthe action group
ErrorsNOT_FOUND actionGroupId not found
NULL_ARGUMENT actionGroupId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetActionGroupsByIds
Description

Gets an ActionGroupList corresponding to the given IdList.

In plenary mode, the returned list contains all of the action groups 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 ActionGroups may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListactionGroupIdsthe list of Ids to retrieve
Returnosid.control.ActionGroupListthe returned ActionGroup list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT actionGroupIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActionGroupsByGenusType
Description

Gets an ActionGroupList corresponding to the given action group genus Type which does not include action groups of genus types derived from the specified Type.

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.

Parametersosid.type.TypeactionGroupGenusTypean action group genus type
Returnosid.control.ActionGroupListthe returned ActionGroup list
ErrorsNULL_ARGUMENT actionGroupGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActionGroupsByParentGenusType
Description

Gets an ActionGroupList corresponding to the given action group genus Type and include any additional action groups with genus types derived from the specified Type.

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.

Parametersosid.type.TypeactionGroupGenusTypean action group genus type
Returnosid.control.ActionGroupListthe returned ActionGroup list
ErrorsNULL_ARGUMENT actionGroupGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActionGroupsByRecordType
Description

Gets an ActionGroupList containing the given action group record Type.

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.

Parametersosid.type.TypeactionGroupRecordTypean action group record type
Returnosid.control.ActionGroupListthe returned ActionGroup list
ErrorsNULL_ARGUMENT actionGroupRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActionGroupsByAction
Description

Gets an ActionGroupList containing of the given Action.

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.

Parametersosid.id.IdactionIdan action Id
Returnosid.control.ActionGroupListthe returned ActionGroup list
ErrorsNULL_ARGUMENT actionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActionGroups
Description

Gets all ActionGroups.

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.

Returnosid.control.ActionGroupLista list of ActionGroups
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.