Interface AuditSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AuditSearch
extends OsidSearch

The search interface for governing audit searches.

Method Summary

Modifier and Type	Method	Description
AuditSearchRecord	getAuditSearchRecord(Type auditSearchRecordType)	Gets the audit search record corresponding to the given audit search record Type .
void	orderAuditResults(AuditSearchOrder auditSearchOrder)	Specify an ordering to the search results.
void	searchAmongAudits(IdList auditIds)	Execute this search among the given list of audits.

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

searchAmongAudits

void searchAmongAudits(IdList auditIds)

Execute this search among the given list of audits.

Parameters:

auditIds - list of audits

Throws:

NullArgumentException - auditIds is null

Compliance:

mandatory - This method must be implemented.

orderAuditResults

void orderAuditResults(AuditSearchOrder auditSearchOrder)

Specify an ordering to the search results.

Parameters:

auditSearchOrder - audit search order

Throws:

NullArgumentException - auditSearchOrder is null

UnsupportedException - auditSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAuditSearchRecord

AuditSearchRecord getAuditSearchRecord(Type auditSearchRecordType)
                                throws OperationFailedException

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

Parameters:

auditSearchRecordType - an audit search record type

Returns:

the audit search record

Throws:

NullArgumentException - auditSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auditSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.