Interface AuditConstrainerEnablerSearch
- All Superinterfaces:
Extensible, OsidCondition, OsidSearch, Suppliable
The search interface for governing audit constrainer enabler searches.
-
Method Summary
Modifier and TypeMethodDescriptiongetAuditConstrainerEnablerSearchRecord(Type auditConstrainerEnablerSearchRecordType) Gets the audit constrainer enabler search record corresponding to the given audit constrainer enabler search recordType.voidorderAuditConstrainerEnablerResults(AuditConstrainerEnablerSearchOrder auditConstrainerEnablerSearchOrder) Specify an ordering to the search results.voidsearchAmongAuditConstrainerEnablers(IdList auditConstrainerEnablerIds) Execute this search among the given list of audit constrainer enablers.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface OsidSearch
limitResultSetModifier and TypeMethodDescriptionvoidlimitResultSet(long start, long end) By default, searches return all matching results.
-
Method Details
-
searchAmongAuditConstrainerEnablers
Execute this search among the given list of audit constrainer enablers.- Parameters:
auditConstrainerEnablerIds- list of audit constrainer enablers- Throws:
NullArgumentException-auditConstrainerEnablerIdsisnull- Compliance:
mandatory- This method must be implemented.
-
orderAuditConstrainerEnablerResults
void orderAuditConstrainerEnablerResults(AuditConstrainerEnablerSearchOrder auditConstrainerEnablerSearchOrder) Specify an ordering to the search results.- Parameters:
auditConstrainerEnablerSearchOrder- audit constrainer enabler search order- Throws:
NullArgumentException-auditConstrainerEnablerSearchOrderisnullUnsupportedException-auditConstrainerEnablerSearchOrderis not of this service- Compliance:
mandatory- This method must be implemented.
-
getAuditConstrainerEnablerSearchRecord
AuditConstrainerEnablerSearchRecord getAuditConstrainerEnablerSearchRecord(Type auditConstrainerEnablerSearchRecordType) throws OperationFailedException Gets the audit constrainer enabler search record corresponding to the given audit constrainer enabler search recordType. This method is used to retrieve an object implementing the requested record.- Parameters:
auditConstrainerEnablerSearchRecordType- an audit constrainer enabler search record type- Returns:
- the audit constrainer enabler search record
- Throws:
NullArgumentException-auditConstrainerEnablerSearchRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(auditConstrainerEnablerSearchRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-