Interface AssetContentQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
AssetContentSearchSession
public interface AssetContentQuerySession extends OsidSession

This session provides methods for searching among AssetContents . The search query is constructed using the AssetContentQuery .

This session defines views that offer differing behaviors for searching.

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

Asset Contents may have a query record indicated by their respective record types. The query record is accessed via the 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.

    • canSearchAssetContents

      boolean canSearchAssetContents()
      Tests if this user can perform AssetContent 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 not offer lookup 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 asset contents 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 searches to this repository only.
      Compliance:
      mandatory - This method is must be implemented.

    • getAssetContentQuery

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

    • getAssetContentsByQuery

      AssetContentList getAssetContentsByQuery(AssetContentQuery assetContentQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of AssetContents matching the given search.
      Parameters:
      assetContentQuery - the asset content query
      Returns:
      the returned AssetContentList
      Throws:
      NullArgumentException - assetContentQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - assetContentQuery did not originate from getAssetContentQuery()
      Compliance:
      mandatory - This method must be implemented.