Interface AntimatroidLookupSession

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

This session provides methods for retrieving Antimatroid 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

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 Antimatroids it can access, without breaking execution. However, an assessment may only be useful if all Antimatroids referenced by it are available, and a test-taking application may sacrifice some interoperability for the sake of precision.

  • Method Details

    • canLookupAntimatroids

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

    • useComparativeAntimatroidView

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

    • usePlenaryAntimatroidView

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

    • getAntimatroid

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

    • getAntimatroidsByIds

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

    • getAntimatroidsByGenusType

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

    • getAntimatroidsByParentGenusType

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

    • getAntimatroidsByRecordType

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

    • getAntimatroidsByProvider

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

    • getAntimatroids

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