Interface AssetLookupSession

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

This session defines methods for retrieving assets. An Asset represents an element of content stored in a Repository.

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 repository view: All asset methods in this session operate, retrieve and pertain to assets defined explicitly in the current repository. Using an isolated view is useful for managing Assets with the AssetAdminSession .
  • federated repository view: All asset methods in this session operate, retrieve and pertain to all assets defined in this repository and any other assets implicitly available in this repository through repository inheritence.

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

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

  • Method Details

    • getRepositoryId

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

    • getRepository

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

    • canLookupAssets

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

    • useComparativeAssetView

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

    • usePlenaryAssetView

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

    • useFederatedRepositoryView

      void useFederatedRepositoryView()
      Federates the view for methods in this session. A federated view will include assets in repositories which are children of this repository in the repository hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedRepositoryView

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

    • getAsset

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

    • getAssetsByIds

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

    • getAssetsByGenusType

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

    • getAssetsByParentGenusType

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

    • getAssetsByRecordType

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

    • getAssetsByProvider

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

    • getAssets

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