Interface AuditProcessorEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AuditProcessorEnablerSearch
extends OsidSearch

The search interface for governing audit processor enabler searches.

Method Summary

Modifier and Type	Method	Description
AuditProcessorEnablerSearchRecord	getAuditProcessorEnablerSearchRecord(Type auditProcessorEnablerSearchRecordType)	Gets the audit processor enabler search record corresponding to the given audit processor enabler search record Type.
void	orderAuditProcessorEnablerResults(AuditProcessorEnablerSearchOrder auditProcessorEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongAuditProcessorEnablers(IdList auditProcessorEnablerIds)	Execute this search among the given list of audit processor 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

searchAmongAuditProcessorEnablers

void searchAmongAuditProcessorEnablers(IdList auditProcessorEnablerIds)

Execute this search among the given list of audit processor enablers.

Parameters:

auditProcessorEnablerIds - list of audit processor enablers

Throws:

NullArgumentException - auditProcessorEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderAuditProcessorEnablerResults

void orderAuditProcessorEnablerResults(AuditProcessorEnablerSearchOrder auditProcessorEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

auditProcessorEnablerSearchOrder - audit processor enabler search order

Throws:

NullArgumentException - auditProcessorEnablerSearchOrder is null

UnsupportedException - auditProcessorEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAuditProcessorEnablerSearchRecord

AuditProcessorEnablerSearchRecord getAuditProcessorEnablerSearchRecord(Type auditProcessorEnablerSearchRecordType)
                                                                throws OperationFailedException

Gets the audit processor enabler search record corresponding to the given audit processor enabler search record Type. 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 record

Throws:

NullArgumentException - auditProcessorEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auditProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.