Interface CatalogLookupSession

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

This session provides methods for retrieving Catalogs . The Catalog represents a collection of OSID Ids .

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

  • Method Details

    • canLookupCatalogs

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

    • useComparativeCatalogView

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

    • usePlenaryCatalogView

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

    • getCatalog

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

    • getCatalogsByIds

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

    • getCatalogsByGenusType

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

    • getCatalogsByParentGenusType

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

    • getCatalogsByRecordType

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

    • getCatalogsByProvider

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

    • getCatalogs

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