Interface AuditSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AuditSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AuditQueryInspector	getAuditQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
AuditList	getAudits()	Gets the audit list resulting from a search.
AuditSearchResultsRecord	getAuditSearchResultsRecord(Type auditSearchRecordType)	Gets the audit search results record corresponding to the given audit 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

getAudits

AuditList getAudits()

Gets the audit list resulting from a search.

Returns:

the audit list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getAuditQueryInspector

AuditQueryInspector getAuditQueryInspector()

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

Returns:

the audit query inspector

Compliance:

mandatory - This method must be implemented.

getAuditSearchResultsRecord

AuditSearchResultsRecord getAuditSearchResultsRecord(Type auditSearchRecordType)
                                              throws OperationFailedException

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

Throws:

NullArgumentException - auditSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auditSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.