Interface SequenceRuleEnablerSearchResults

All Superinterfaces:
Browsable, Extensible, OsidResult, OsidSearchResults
public interface SequenceRuleEnablerSearchResults extends OsidSearchResults

This interface provides a means to capture results of a search.

  • Method Details

    • getSequenceRuleEnablers

      SequenceRuleEnablerList getSequenceRuleEnablers()
      Gets the SequenceRuleEnablerList resulting from a search.
      Returns:
      the sequence rule enabler list
      Throws:
      IllegalStateException - list has already been retrieved
      Compliance:
      mandatory - This method must be implemented.

    • getSequenceRuleEnablerQueryInspector

      SequenceRuleEnablerQueryInspector getSequenceRuleEnablerQueryInspector()
      Gets the inspector for the query to examine the terms used in the search.
      Returns:
      the sequence rule enabler query inspector
      Compliance:
      mandatory - This method must be implemented.

    • getSequenceRuleEnablerSearchResultsRecord

      SequenceRuleEnablerSearchResultsRecord getSequenceRuleEnablerSearchResultsRecord(Type sequenceRuleEnablerSearchRecordType) throws OperationFailedException, PermissionDeniedException
      Gets the sequence rule enabler search results record corresponding to the given sequence rule enabler search record Type. This method must be used to retrieve an object implementing the requested record.
      Parameters:
      sequenceRuleEnablerSearchRecordType - a sequence rule enabler search record type
      Returns:
      the sequence rule enabler search results record
      Throws:
      NullArgumentException - sequenceRuleEnablerSearchRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - hasRecordType(sequenceRuleEnablerSearchRecordType) is false
      Compliance:
      mandatory - This method must be implemented.