Interface AuditConstrainerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface AuditConstrainerSearch
extends OsidSearch

The search interface for governing audit constrainer searches.

Method Summary

Modifier and Type	Method	Description
AuditConstrainerSearchRecord	getAuditConstrainerSearchRecord(Type auditConstrainerSearchRecordType)	Gets the audit constrainer search record corresponding to the given audit constrainer search record Type .This method is used to retrieve an object implementing the requested record.
void	orderAuditConstrainerResults(AuditConstrainerSearchOrder auditConstrainerSearchOrder)	Specify an ordering to the search results.
void	searchAmongAuditConstrainers(IdList auditConstrainerIds)	Execute this search among the given list of audit constrainers.

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

searchAmongAuditConstrainers

void searchAmongAuditConstrainers(IdList auditConstrainerIds)

Execute this search among the given list of audit constrainers.

Parameters:

auditConstrainerIds - list of audit constrainer

Throws:

NullArgumentException - auditConstrainerIds is null

Compliance:

mandatory - This method must be implemented.

orderAuditConstrainerResults

void orderAuditConstrainerResults(AuditConstrainerSearchOrder auditConstrainerSearchOrder)

Specify an ordering to the search results.

Parameters:

auditConstrainerSearchOrder - audit constrainer search order

Throws:

NullArgumentException - auditConstrainerSearchOrder is null

UnsupportedException - auditConstrainerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getAuditConstrainerSearchRecord

AuditConstrainerSearchRecord getAuditConstrainerSearchRecord(Type auditConstrainerSearchRecordType)
                                                      throws OperationFailedException

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

Parameters:

auditConstrainerSearchRecordType - an audit constrainer search record type

Returns:

the audit constrainer search record

Throws:

NullArgumentException - auditConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auditConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.