Interface AuditProcessorSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AuditProcessorSearch
extends OsidSearch

The search interface for governing audit processor searches.

Method Summary

Modifier and Type	Method	Description
AuditProcessorSearchRecord	getAuditProcessorSearchRecord(Type auditProcessorSearchRecordType)	Gets the audit processor search record corresponding to the given audit processor search record Type .This method is used to retrieve an object implementing the requested record.
void	orderAuditProcessorResults(AuditProcessorSearchOrder auditProcessorSearchOrder)	Specify an ordering to the search results.
void	searchAmongAuditProcessors(IdList auditProcessorIds)	Execute this search among the given list of audit processors.

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

searchAmongAuditProcessors

void searchAmongAuditProcessors(IdList auditProcessorIds)

Execute this search among the given list of audit processors.

Parameters:

auditProcessorIds - list of audit processors

Throws:

NullArgumentException - auditProcessorIds is null

Compliance:

mandatory - This method must be implemented.

orderAuditProcessorResults

void orderAuditProcessorResults(AuditProcessorSearchOrder auditProcessorSearchOrder)

Specify an ordering to the search results.

Parameters:

auditProcessorSearchOrder - audit processor search order

Throws:

NullArgumentException - auditProcessorSearchOrder is null

UnsupportedException - auditProcessorSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAuditProcessorSearchRecord

AuditProcessorSearchRecord getAuditProcessorSearchRecord(Type auditProcessorSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

auditProcessorSearchRecordType - an audit processor search record type

Returns:

the audit processor search record

Throws:

NullArgumentException - auditProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auditProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.