Interface AuditEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AuditEnablerSearch
extends OsidSearch

The search interface for governing audit enabler searches.

Method Summary

Modifier and Type	Method	Description
AuditEnablerSearchRecord	getAuditEnablerSearchRecord(Type auditEnablerSearchRecordType)	Gets the audit enabler search record corresponding to the given audit enabler search record Type .This method is used to retrieve an object implementing the requested record.
void	orderAuditEnablerResults(AuditEnablerSearchOrder auditEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongAuditEnablers(IdList auditEnablerIds)	Execute this search among the given list of audit enablers.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongAuditEnablers

void searchAmongAuditEnablers(IdList auditEnablerIds)

Execute this search among the given list of audit enablers.

Parameters:

auditEnablerIds - list of audit enablers

Throws:

NullArgumentException - auditEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderAuditEnablerResults

void orderAuditEnablerResults(AuditEnablerSearchOrder auditEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

auditEnablerSearchOrder - audit enabler search order

Throws:

NullArgumentException - auditEnablerSearchOrder is null

UnsupportedException - auditEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAuditEnablerSearchRecord

AuditEnablerSearchRecord getAuditEnablerSearchRecord(Type auditEnablerSearchRecordType)
                                              throws OperationFailedException

Gets the audit enabler search record corresponding to the given audit enabler search record Type .This method is used to retrieve an object implementing the requested record.

Parameters:

auditEnablerSearchRecordType - an audit enabler search record type

Returns:

the audit enabler search record

Throws:

NullArgumentException - auditEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auditEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.