Interface ProcessConstrainerEnablerSearchResults
- All Superinterfaces:
Browsable, Extensible, OsidResult, OsidSearchResults
This interface provides a means to capture results of a search.
-
Method Summary
Modifier and TypeMethodDescriptionGets the inspector for the query to examine the terms used in the search.Gets the process constrainer enabler list resulting from a search.getProcessConstrainerEnablerSearchResultsRecord(Type processConstrainerEnablerSearchRecordType) Gets the process constrainer enabler search results record corresponding to the given process constrainer enabler search recordType.Methods inherited from interface Browsable
getProperties, getPropertiesByRecordTypeMethods inherited from interface Extensible
getRecordTypes, hasRecordTypeMethods inherited from interface OsidSearchResults
getResultSize
-
Method Details
-
getProcessConstrainerEnablers
ProcessConstrainerEnablerList getProcessConstrainerEnablers()Gets the process constrainer enabler list resulting from a search.- Returns:
- the process constrainer enabler list
- Throws:
IllegalStateException- list already retrieved- Compliance:
mandatory- This method must be implemented.
-
getProcessConstrainerEnablerQueryInspector
ProcessConstrainerEnablerQueryInspector getProcessConstrainerEnablerQueryInspector()Gets the inspector for the query to examine the terms used in the search.- Returns:
- the process constrainer enabler query inspector
- Compliance:
mandatory- This method must be implemented.
-
getProcessConstrainerEnablerSearchResultsRecord
ProcessConstrainerEnablerSearchResultsRecord getProcessConstrainerEnablerSearchResultsRecord(Type processConstrainerEnablerSearchRecordType) throws OperationFailedException Gets the process constrainer enabler search results record corresponding to the given process constrainer enabler search recordType. This method is used to retrieve an object implementing the requested record.- Parameters:
processConstrainerEnablerSearchRecordType- a process constrainer enabler search record type- Returns:
- the process constrainer enabler search results record
- Throws:
NullArgumentException-processConstrainerEnablerSearchRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(processConstrainerEnablerSearchRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-