Interface ChainLookupSession

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

This session defines methods for retrieving chains.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
  • isolated antimatroid view: All chain methods in this session operate, retrieve and pertain to chains defined explicitly in the current antimatroid. Using an isolated view is useful for managing Chains with the ChainAdminSession .
  • federated antimatroid view: All chain lookup methods in this session operate, retrieve and pertain to all chains defined in this antimatroid and any other chains implicitly available in this antimatroid through antimatroid inheritence.

The methods useFederatedAntimatroidView() and useIsolatedAntimatroidView() behave as a radio group and one should be selected before invoking any lookup methods.

Chains may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the chains.

  • Method Details

    • getAntimatroidId

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

    • getAntimatroid

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

    • canLookupChains

      boolean canLookupChains()
      Tests if this user can perform Chain 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 not offer lookup operations to unauthorized users.
      Returns:
      false if lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeChainView

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

    • usePlenaryChainView

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

    • useFederatedAntimatroidView

      void useFederatedAntimatroidView()
      Federates the view for methods in this session. A federated view will include chains in antimatroids which are children of this antimatroid in the antimatroid hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedAntimatroidView

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

    • getChain

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

    • getChainsByIds

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

    • getChainsByGenusType

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

    • getChainsByParentGenusType

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

    • getChainsByRecordType

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

    • getChains

      ChainList getChains() throws OperationFailedException, PermissionDeniedException
      Gets all chains. In plenary mode, the returned list contains all of the chains including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible Chains may be omitted from the list and may present the elements in any order including returning a unique set.
      Returns:
      the returned Chain list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.