Interface AssetQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
AssetSearchSession
public interface AssetQuerySession extends OsidSession

This session provides methods for searching among Asset objects. The search query is constructed using the AssetQuery .

This session defines views that offer differing behaviors for searching.

  • federated repository view: searches include assets in repositories of which this repository is an ancestor in the repository hierarchy
  • isolated repository view: searches are restricted to assets in this repository

Assets may have a query record indicated by their respective record types. The query record is accessed via the AssetQuery .

  • 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.

    • canSearchAssets

      boolean canSearchAssets()
      Tests if this user can perform Asset searches. 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 search operations to unauthorized users.
      Returns:
      false if search methods are not authorized, true otherwise
      Compliance:
      mandatory - This method 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.

    • getAssetQuery

      AssetQuery getAssetQuery()
      Gets an asset query.
      Returns:
      the asset query
      Compliance:
      mandatory - This method must be implemented.

    • getAssetsByQuery

      AssetList getAssetsByQuery(AssetQuery assetQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of Assets matching the given asset query.
      Parameters:
      assetQuery - the asset query
      Returns:
      the returned AssetList
      Throws:
      NullArgumentException - assetQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - the assetQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.