Interface AssetContentSmartRepositorySession

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

This session manages queries and sequencing to create "smart" dynamic catalogs. An AssetContentQuery can be retrieved from this session and mapped to this Repository to create a virtual collection of AssetContents . The asset contents may be sequenced using the AssetContentSearchOrder from this session.

This Repository has a default query that matches any asset content and a default search order that specifies no sequencing. The queries may be examined using an AssetContentQueryInspector . The query may be modified by converting the inspector back to an AssetContentQuery .

  • 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
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canManageSmartRepositories

      boolean canManageSmartRepositories()
      Tests if this user can manage smart repositories. A return of true does not guarantee successful authorization. A return of false indicates that it is known 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 operations to unauthorized users.
      Returns:
      false if smart repository management is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAssetContentQuery

      AssetContentQuery getAssetContentQuery()
      Gets an asset content query.
      Returns:
      the asset content query
      Compliance:
      mandatory - This method must be implemented.

    • getAssetContentSearchOrder

      AssetContentSearchOrder getAssetContentSearchOrder()
      Gets an asset content search order.
      Returns:
      the asset content search order
      Compliance:
      mandatory - This method must be implemented.

    • applyAssetContentQuery

      void applyAssetContentQuery(AssetContentQuery assetContentQuery) throws OperationFailedException, PermissionDeniedException
      Applies an asset content query to this repository.
      Parameters:
      assetContentQuery - the asset content query
      Throws:
      NullArgumentException - assetContentQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - assetContentQuery not of this service
      Compliance:
      mandatory - This method must be implemented.

    • inspectAssetContentQuery

      AssetContentQueryInspector inspectAssetContentQuery() throws OperationFailedException, PermissionDeniedException
      Gets an asset content query inspector for this repository.
      Returns:
      the asset content query inspector
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      Compliance:
      mandatory - This method must be implemented.

    • applyAssetContentSequencing

      void applyAssetContentSequencing(AssetContentSearchOrder assetContentSearchOrder) throws OperationFailedException, PermissionDeniedException
      Applies an asset content search order to this repository.
      Parameters:
      assetContentSearchOrder - the asset content search order
      Throws:
      NullArgumentException - assetContentSearchOrder is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - assetContentSearchOrder not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getAssetContentQueryFromInspector

      AssetContentQuery getAssetContentQueryFromInspector(AssetContentQueryInspector assetContentQueryInspector)
      Gets an asset content query from an inspector.
      Parameters:
      assetContentQueryInspector - an asset content query inspector
      Returns:
      the asset content query
      Throws:
      NullArgumentException - assetContentQueryInspector is null
      UnsupportedException - assetContentQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.