Interface ActionGroupLookupSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface ActionGroupLookupSession extends OsidSession

This session provides methods for retrieving ActionGroups .

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.

  • Method Details

    • getSystemId

      Id getSystemId()
      Gets the System Id associated with this session.
      Returns:
      the System Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getSystem

      System getSystem() throws OperationFailedException, PermissionDeniedException
      Gets the System associated with this session.
      Returns:
      the system
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupActionGroups

      boolean canLookupActionGroups()
      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.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeActionGroupView

      void useComparativeActionGroupView()
      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.

    • usePlenaryActionGroupView

      void usePlenaryActionGroupView()
      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.
      Compliance:
      mandatory - This method is must be implemented.

    • useFederatedSystemView

      void useFederatedSystemView()
      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.

    • useIsolatedSystemView

      void useIsolatedSystemView()
      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.

    • getActionGroup

      ActionGroup getActionGroup(Id actionGroupId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      actionGroupId - Id of the ActionGroup
      Returns:
      the action group
      Throws:
      NotFoundException - actionGroupId not found
      NullArgumentException - actionGroupId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getActionGroupsByIds

      ActionGroupList getActionGroupsByIds(IdList actionGroupIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      actionGroupIds - the list of Ids to retrieve
      Returns:
      the returned ActionGroup list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - actionGroupIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActionGroupsByGenusType

      ActionGroupList getActionGroupsByGenusType(Type actionGroupGenusType) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      actionGroupGenusType - an action group genus type
      Returns:
      the returned ActionGroup list
      Throws:
      NullArgumentException - actionGroupGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActionGroupsByParentGenusType

      ActionGroupList getActionGroupsByParentGenusType(Type actionGroupGenusType) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      actionGroupGenusType - an action group genus type
      Returns:
      the returned ActionGroup list
      Throws:
      NullArgumentException - actionGroupGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActionGroupsByRecordType

      ActionGroupList getActionGroupsByRecordType(Type actionGroupRecordType) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      actionGroupRecordType - an action group record type
      Returns:
      the returned ActionGroup list
      Throws:
      NullArgumentException - actionGroupRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActionGroupsByAction

      ActionGroupList getActionGroupsByAction(Id actionId) throws OperationFailedException, PermissionDeniedException
      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.
      Parameters:
      actionId - an action Id
      Returns:
      the returned ActionGroup list
      Throws:
      NullArgumentException - actionId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getActionGroups

      ActionGroupList getActionGroups() throws OperationFailedException, PermissionDeniedException
      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.
      Returns:
      a list of ActionGroups
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.