Interface BinLookupSession

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

This session provides methods for retrieving Bin objects. The Bin represents a collection resources.

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 Bins it can access, without breaking execution. However, an administrative application may require all Bin elements to be available.

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

  • Method Details

    • canLookupBins

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

    • useComparativeBinView

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

    • usePlenaryBinView

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

    • getBin

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

    • getBinsByIds

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

    • getBinsByGenusType

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

    • getBinsByParentGenusType

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

    • getBinsByRecordType

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

    • getBinsByProvider

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

    • getBins

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