Interface SequenceRuleEnablerQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
SequenceRuleEnablerSearchSession
public interface SequenceRuleEnablerQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

sequence rule enablers may have a query record indicated by their respective record types. The query record is accessed via the SequenceRuleEnablerQuery.

Like all OsidSessions, SequenceRuleEnablerQuerySessions are dedicated to single processing threads and a single authenticated user.

  • Method Details

    • getBankId

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

    • getBank

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

    • canSearchSequenceRuleEnablers

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

    • useFederatedBankView

      void useFederatedBankView()
      Federates the view for methods in this session. A federated view will include sequence rule enablers in banks which are children of this step in the bank hierarchy.
      Compliance:
      mandatory - This method must be implemented.

    • useIsolatedBankView

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

    • getSequenceRuleEnablerQuery

      SequenceRuleEnablerQuery getSequenceRuleEnablerQuery()
      Gets a sequence rule enabler query.
      Returns:
      the sequence rule enabler query
      Compliance:
      mandatory - This method must be implemented.

    • getSequenceRuleEnablersByQuery

      SequenceRuleEnablerList getSequenceRuleEnablersByQuery(SequenceRuleEnablerQuery sequenceRuleEnablerQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of SequenceRuleEnablers matching the given sequence rule enabler query.
      Parameters:
      sequenceRuleEnablerQuery - the sesequence rule enabler query
      Returns:
      the returned SequenceRuleEnablerList
      Throws:
      NullArgumentException - sequenceRuleEnablerQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - sequenceRuleEnablerQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.