Interface AuditConstrainerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AuditConstrainerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AuditConstrainerQueryInspector	getAuditConstrainerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
AuditConstrainerList	getAuditConstrainers()	Gets the audit constrainer list resulting from a search.
AuditConstrainerSearchResultsRecord	getAuditConstrainerSearchResultsRecord(Type auditConstrainerSearchRecordType)	Gets the audit constrainer search results record corresponding to the given audit constrainer search record Type.

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

getAuditConstrainers

AuditConstrainerList getAuditConstrainers()

Gets the audit constrainer list resulting from a search.

Returns:

the audit constrainer list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getAuditConstrainerQueryInspector

AuditConstrainerQueryInspector getAuditConstrainerQueryInspector()

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

Returns:

the audit constrainer query inspector

Compliance:

mandatory - This method must be implemented.

getAuditConstrainerSearchResultsRecord

AuditConstrainerSearchResultsRecord getAuditConstrainerSearchResultsRecord(Type auditConstrainerSearchRecordType)
                                                                    throws OperationFailedException

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

Throws:

NullArgumentException - auditConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auditConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.