Interface CheckLookupSession

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

This session provides methods for retrieving Check relationships.

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 engine view: All check methods in this session operate, retrieve and pertain to checks defined explicitly in the current engine. Using an isolated view is useful for managing Checks with the CheckAdminSession .
  • federated engine view: All check methods in this session operate, retrieve and pertain to all checks defined in this engine and any other checks implicitly available in this engine through engine inheritence.
  • active check view: All check lookup methods return active checks.
  • any status check view: Checks of any active or inactive status are returned from methods.

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

  • Method Details

    • getEngineId

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

    • getEngine

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

    • canLookupChecks

      boolean canLookupChecks()
      Tests if this user can perform Check 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.

    • useComparativeCheckView

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

    • usePlenaryCheckView

      void usePlenaryCheckView()
      A complete view of the Check 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.

    • useFederatedEngineView

      void useFederatedEngineView()
      Federates the view for methods in this session. A federated view will include checks in engines which are children of this engine in the engine hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedEngineView

      void useIsolatedEngineView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this engine only.
      Compliance:
      mandatory - This method is must be implemented.

    • useActiveCheckView

      void useActiveCheckView()
      Only active checks are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusCheckView

      void useAnyStatusCheckView()
      All active and inactive checks are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getCheck

      Check getCheck(Id checkId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the Check specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Check may have a different Id than requested, such as the case where a duplicate Id was assigned to a Check and retained for compatibility. In active mode, checks are returned that are currently active. In any status mode, active and inactive checks are returned.
      Parameters:
      checkId - Id of the Check
      Returns:
      the hold
      Throws:
      NotFoundException - checkId not found
      NullArgumentException - checkId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getChecksByIds

      CheckList getChecksByIds(IdList checkIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a CheckList corresponding to the given IdList . In plenary mode, the returned list contains all of the checks 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 Checks may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, checks are returned that are currently active. In any status mode, active and inactive checks are returned.
      Parameters:
      checkIds - the list of Ids to retrieve
      Returns:
      the returned Check list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - checkIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getChecksByGenusType

      CheckList getChecksByGenusType(Type holdGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a CheckList corresponding to the given check genus Type which does not include checks of genus types derived from the specified Type . In plenary mode, the returned list contains all known checks or an error results. Otherwise, the returned list may contain only those checks that are accessible through this session. In active mode, checks are returned that are currently active. In any status mode, active and inactive checks are returned.
      Parameters:
      holdGenusType - a check genus type
      Returns:
      the returned Check list
      Throws:
      NullArgumentException - holdGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getChecksByParentGenusType

      CheckList getChecksByParentGenusType(Type holdGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a CheckList corresponding to the given check genus Type and include any additional checks with genus types derived from the specified Type . In plenary mode, the returned list contains all known checks or an error results. Otherwise, the returned list may contain only those checks that are accessible through this session. In active mode, checks are returned that are currently active. In any status mode, active and inactive checks are returned.
      Parameters:
      holdGenusType - a check genus type
      Returns:
      the returned Check list
      Throws:
      NullArgumentException - holdGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getChecksByRecordType

      CheckList getChecksByRecordType(Type checkRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a CheckList containing the given check record Type . In plenary mode, the returned list contains all known checks or an error results. Otherwise, the returned list may contain only those checks that are accessible through this session. In active mode, checks are returned that are currently active. In any status mode, active and inactive checks are returned.
      Parameters:
      checkRecordType - a check record type
      Returns:
      the returned Check list
      Throws:
      NullArgumentException - checkRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getChecks

      CheckList getChecks() throws OperationFailedException, PermissionDeniedException
      Gets all Checks . In plenary mode, the returned list contains all known checks or an error results. Otherwise, the returned list may contain only those checks that are accessible through this session. In active mode, checks are returned that are currently active. In any status mode, active and inactive checks are returned.
      Returns:
      a list of Checks
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.