Interface SequenceRuleQuerySession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
All Known Subinterfaces:
SequenceRuleSearchSession
public interface SequenceRuleQuerySession extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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

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

    • canSearchSequenceRules

      boolean canSearchSequenceRules()
      Tests if this user can perform SequenceRule 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 in banks which are children of this step in the bank hierarchy.
      Compliance:
      mandatory - This method is 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 is must be implemented.

    • getSequenceRuleQuery

      SequenceRuleQuery getSequenceRuleQuery()
      Gets a sequence rule query.
      Returns:
      the sequence rule query
      Compliance:
      mandatory - This method must be implemented.

    • getSequenceRulesByQuery

      SequenceRuleList getSequenceRulesByQuery(SequenceRuleQuery sequenceRuleQuery) throws OperationFailedException, PermissionDeniedException
      Gets a list of SequenceRules matching the given sequence rule query.
      Parameters:
      sequenceRuleQuery - the sequence rule query
      Returns:
      the returned SequenceRuleList
      Throws:
      NullArgumentException - sequenceRuleQuery is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - sequenceRuleQuery is not of this service
      Compliance:
      mandatory - This method must be implemented.