Interface SequenceRuleEnablerSearchSession

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

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

getSequenceRuleEnablersByQuery() is the basic search method and returns a list of SequenceRuleEnablers . A more advanced search may be performed with getSequenceRuleEnablersBySearch() . It accepts a SequenceRuleEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as workflow. getSequenceRuleEnablersBySearch() returns a SequenceRuleEnablerSearchResults that can be used to access the resulting SequenceRuleEnablerList or be used to perform a search within the result set through SequenceRuleEnablerSearch .

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
SequenceRuleEnablers may have a query record indicated by their respective record types. The query record is accessed via the SequenceRuleEnablerQuery .

  • Method Details

    • getSequenceRuleEnablerSearch

      SequenceRuleEnablerSearch getSequenceRuleEnablerSearch()
      Gets a sequence rule enabler search.
      Returns:
      the sequence rule enabler search
      Compliance:
      mandatory - This method must be implemented.

    • getSequenceRuleEnablerSearchOrder

      SequenceRuleEnablerSearchOrder getSequenceRuleEnablerSearchOrder()
      Gets a sequence rule enabler search order. The SequenceRuleEnablerSearchOrder is supplied to a SequenceRuleEnablerSearch to specify the ordering of results.
      Returns:
      the sequence rule enabler search order
      Compliance:
      mandatory - This method must be implemented.

    • getSequenceRuleEnablersBySearch

      SequenceRuleEnablerSearchResults getSequenceRuleEnablersBySearch(SequenceRuleEnablerQuery sequenceRuleEnablerQuery, SequenceRuleEnablerSearch sequenceRuleEnablerSearch) throws OperationFailedException, PermissionDeniedException
      Gets the search results matching the given search query using the given search.
      Parameters:
      sequenceRuleEnablerQuery - the sequence rule enabler query
      sequenceRuleEnablerSearch - the sequence rule enabler search
      Returns:
      the returned search results
      Throws:
      NullArgumentException - sequenceRuleEnablerQuery or sequenceRuleEnablerSearch is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      UnsupportedException - sequenceRuleEnablerQuery or sequenceRuleEnablerSearch is not of this service
      Compliance:
      mandatory - This method must be implemented.

    • getSequenceRuleEnablerQueryFromInspector

      SequenceRuleEnablerQuery getSequenceRuleEnablerQueryFromInspector(SequenceRuleEnablerQueryInspector sequenceRuleEnablerQueryInspector)
      Gets a sequence rule enabler query from an inspector. The inspector is available from a SequenceRuleEnablerSearchResults .
      Parameters:
      sequenceRuleEnablerQueryInspector - a sequence rule enabler query inspector
      Returns:
      the sequence rule enabler query
      Throws:
      NullArgumentException - sequenceRuleEnablerQueryInspector is null
      UnsupportedException - sequenceRuleEnablerQueryInspector is not of this service
      Compliance:
      mandatory - This method must be implemented.