Interface CanonicalUnitEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
CanonicalUnitEnablerSearchSession
public interface CanonicalUnitEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

CanonicalUnit constrainer enablers may have a query record indicated by their respective record types. The query record is accessed via the CanonicalUnitEnablerQuery .

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

    • canSearchCanonicalUnitEnablers

      boolean canSearchCanonicalUnitEnablers()
      Tests if this user can perform CanonicalUnitEnabler 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 enablers 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.

    • getCanonicalUnitEnablerQuery

      CanonicalUnitEnablerQuery getCanonicalUnitEnablerQuery()
      Gets a canonical unit enabler query.
      Returns:
      the canonical unit enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getCanonicalUnitEnablersByQuery

      CanonicalUnitEnablerList getCanonicalUnitEnablersByQuery(CanonicalUnitEnablerQuery canonicalUnitEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of CanonicalUnitEnablers matching the given search.
      Parameters:
      canonicalUnitEnablerQuery - the canonical unit constraienr enabler query
      Returns:
      the returned CanonicalUnitEnablerList
      Throws:
      NullArgumentException - canonicalUnitEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - canonicalUnitEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.