Interface CommissionEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
CommissionEnablerSearchSession
public interface CommissionEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

  • federated foundry view: searches include commission enabler in foundries of which this foundry is an ancestor in the foundry hierarchy
  • isolated foundry view: searches are restricted to commission enabler in this foundry

Commission enablers may have a commission enabler query record indicated by their respective record types. The commission enabler query record is accessed via the CommissionEnablerQuery .

  • Method Details

    • getFoundryId

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

    • getFoundry

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

    • canSearchCommissionEnablers

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

    • useFederatedFoundryView

      void useFederatedFoundryView()
      Federates the view for methods in this session. A federated view will include commission enabler in foundries which are children of this job in the foundry hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedFoundryView

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

    • getCommissionEnablerQuery

      CommissionEnablerQuery getCommissionEnablerQuery()
      Gets a commission enabler query.
      Returns:
      the commission enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionEnablersByQuery

      CommissionEnablerList getCommissionEnablersByQuery(CommissionEnablerQuery commissionEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of CommissionEnablers matching the given commission enabler query.
      Parameters:
      commissionEnablerQuery - the commission enabler query
      Returns:
      the returned CommissionEnablerList
      Throws:
      NullArgumentException - commissionEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - commissionEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.