Interface CatalogEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
CatalogEnablerSearchSession
public interface CatalogEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

  • federated catalog view: searches include catalog enablers in catalogs of which this catalog is an ancestor in the catalog hierarchy
  • isolated catalog view: searches are restricted to catalog enablers in this catalog

Catalog enablers may have a query record indicated by their respective record types. The query record is accessed via the CatalogEnablerQuery.

  • Method Details

    • getCatalogId

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

    • getCatalog

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

    • canSearchCatalogEnablers

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

    • useFederatedCatalogView

      void useFederatedCatalogView()
      Federates the view for methods in this session. A federated view will include catalog enablers in catalogs which are children of this broker in the catalog hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedCatalogView

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

    • getCatalogEnablerQuery

      CatalogEnablerQuery getCatalogEnablerQuery()
      Gets a catalog enabler query.
      Returns:
      the catalog enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getCatalogEnablersByQuery

      CatalogEnablerList getCatalogEnablersByQuery(CatalogEnablerQuery catalogEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of CatalogEnablers matching the given search.
      Parameters:
      catalogEnablerQuery - the catalog enabler query
      Returns:
      the returned CatalogEnablerList
      Throws:
      NullArgumentException - catalogEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - catalogEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.