Interface SystemLookupSession

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

This session provides methods for retrieving Systems .

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

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Systems it can access, without breaking execution. However, an assessment may only be useful if all Systems referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

  • Method Details

    • canLookupSystems

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

    • useComparativeSystemView

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

    • usePlenarySystemView

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

    • getSystem

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

    • getSystemsByIds

      SystemList getSystemsByIds(IdList systemIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a SystemList corresponding to the given IdList . In plenary mode, the returned list contains all of the systems 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 Systems may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      systemIds - the list of Ids to retrieve
      Returns:
      the returned System list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - systemIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSystemsByGenusType

      SystemList getSystemsByGenusType(Type systemGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a SystemList corresponding to the given system genus Type which does not include systems of types derived from the specified Type . In plenary mode, the returned list contains all known systems or an error results. Otherwise, the returned list may contain only those systems that are accessible through this session.
      Parameters:
      systemGenusType - a system genus type
      Returns:
      the returned System list
      Throws:
      NullArgumentException - systemGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSystemsByParentGenusType

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

    • getSystemsByRecordType

      SystemList getSystemsByRecordType(Type systemRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a SystemList containing the given system record Type . In plenary mode, the returned list contains all known systems or an error results. Otherwise, the returned list may contain only those systems that are accessible through this session.
      Parameters:
      systemRecordType - a system record type
      Returns:
      the returned System list
      Throws:
      NullArgumentException - systemRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSystemsByProvider

      SystemList getSystemsByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a SystemList for the given provider. In plenary mode, the returned list contains all known systems or an error results. Otherwise, the returned list may contain only those systems that are accessible through this session.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned System list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getSystems

      SystemList getSystems() throws OperationFailedException, PermissionDeniedException
      Gets all Systems . In plenary mode, the returned list contains all known systems or an error results. Otherwise, the returned list may contain only those systems that are accessible through this session.
      Returns:
      a list of Systems
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.