Interface AuditProcessorEnablerSearchResults
- 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 audit processor enabler list resulting from a search.getAuditProcessorEnablerSearchResultsRecord(Type auditProcessorEnablerSearchRecordType) Gets the audit processor enabler search results record corresponding to the given audit processor enabler search recordType.Methods inherited from interface Browsable
getProperties, getPropertiesByRecordTypeMethods inherited from interface Extensible
getRecordTypes, hasRecordTypeMethods inherited from interface OsidSearchResults
getResultSize
-
Method Details
-
getAuditProcessorEnablers
AuditProcessorEnablerList getAuditProcessorEnablers()Gets the audit processor enabler list resulting from a search.- Returns:
- the audit processor enabler list
- Throws:
IllegalStateException- list already retrieved- Compliance:
mandatory- This method must be implemented.
-
getAuditProcessorEnablerQueryInspector
AuditProcessorEnablerQueryInspector getAuditProcessorEnablerQueryInspector()Gets the inspector for the query to examine the terms used in the search.- Returns:
- the audit processor enabler query inspector
- Compliance:
mandatory- This method must be implemented.
-
getAuditProcessorEnablerSearchResultsRecord
AuditProcessorEnablerSearchResultsRecord getAuditProcessorEnablerSearchResultsRecord(Type auditProcessorEnablerSearchRecordType) throws OperationFailedException Gets the audit processor enabler search results record corresponding to the given audit processor enabler search recordType. This method is used to retrieve an object implementing the requested record.- Parameters:
auditProcessorEnablerSearchRecordType- an audit processor enabler search record type- Returns:
- the audit processor enabler search results record
- Throws:
NullArgumentException-auditProcessorEnablerSearchRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(auditProcessorEnablerSearchRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-