Interface CanonicalUnitProcessorQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
CanonicalUnitProcessorSearchSession
public interface CanonicalUnitProcessorQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

  • federated catalogue view: searches include canonical unit processor in catalogues of which this catalogue is an ancestor in the catalogue hierarchy
  • isolated catalogue view: searches are restricted to canonical unit processor in this catalogue

CanonicalUnit processor may have a query record indicated by their respective record types. The record is accessed via the CanonicalUnitProcessorQuery .

  • Method Details

    • getCatalogueId

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

    • getCatalogue

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

    • canSearchCanonicalUnitProcessors

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

    • useFederatedCatalogueView

      void useFederatedCatalogueView()
      Federates the view for methods in this session. A federated view will include canonical unit processor in catalogues which are children of this broker in the catalogue hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCatalogueView

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

    • getCanonicalUnitProcessorQuery

      CanonicalUnitProcessorQuery getCanonicalUnitProcessorQuery()
      Gets a canonical unit processor query.
      Returns:
      the canonical unit processor query
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitProcessorsByQuery

      CanonicalUnitProcessorList getCanonicalUnitProcessorsByQuery(CanonicalUnitProcessorQuery canonicalUnitProcessorQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of CanonicalUnitProcessors matching the given search.
      Parameters:
      canonicalUnitProcessorQuery - the canonical unit processor query
      Returns:
      the returned CanonicalUnitProcessorList
      Throws:
      NullArgumentException - canonicalUnitProcessorQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - canonicalUnitProcessorQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.