Interface AuditProcessorSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AuditProcessorSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
AuditProcessorQueryInspector	getAuditProcessorQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
AuditProcessorList	getAuditProcessors()	Gets the audit processor list resulting from a search.
AuditProcessorSearchResultsRecord	getAuditProcessorSearchResultsRecord(Type auditProcessorSearchRecordType)	Gets the audit processor search results record corresponding to the given audit processor search record Type .This method is used to retrieve an object implementing the requested record.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getAuditProcessors

AuditProcessorList getAuditProcessors()

Gets the audit processor list resulting from a search.

Returns:

the audit processor list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getAuditProcessorQueryInspector

AuditProcessorQueryInspector getAuditProcessorQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the audit processor query inspector

Compliance:

mandatory - This method must be implemented.

getAuditProcessorSearchResultsRecord

AuditProcessorSearchResultsRecord getAuditProcessorSearchResultsRecord(Type auditProcessorSearchRecordType)
                                                                throws OperationFailedException

Gets the audit processor search results 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 results record

Throws:

NullArgumentException - auditProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auditProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.