Interface StepConstrainerEnablerSearchResults

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

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

  • Method Details

    • getStepConstrainerEnablers

      StepConstrainerEnablerList getStepConstrainerEnablers()
      Gets the StepConstrainerEnablerList resulting from a search.
      Returns:
      the step constrainer enabler list
      Throws:
      IllegalStateException - list has already been retrieved
      Compliance:
      mandatory - This method must be implemented.

    • getStepConstrainerEnablerQueryInspector

      StepConstrainerEnablerQueryInspector getStepConstrainerEnablerQueryInspector()
      Gets the inspector for the query to examine the terms used in the search.
      Returns:
      the step constrainer enabler query inspector
      Compliance:
      mandatory - This method must be implemented.

    • getStepConstrainerEnablerSearchResultsRecord

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