Interface AuditEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AuditEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AuditEnablerQueryInspector	getAuditEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
AuditEnablerList	getAuditEnablers()	Gets the AuditEnablerList resulting from a search.
AuditEnablerSearchResultsRecord	getAuditEnablerSearchResultsRecord(Type auditEnablerSearchRecordType)	Gets the audit enabler search results record corresponding to the given audit enabler search record Type .This method must be 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

getAuditEnablers

AuditEnablerList getAuditEnablers()

Gets the AuditEnablerList resulting from a search.

Returns:

the audit enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getAuditEnablerQueryInspector

AuditEnablerQueryInspector getAuditEnablerQueryInspector()

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

Returns:

the audit enabler query inspector

Compliance:

mandatory - This method must be implemented.

getAuditEnablerSearchResultsRecord

AuditEnablerSearchResultsRecord getAuditEnablerSearchResultsRecord(Type auditEnablerSearchRecordType)
                                                            throws OperationFailedException,
PermissionDeniedException

Gets the audit enabler search results record corresponding to the given audit enabler search record Type .This method must be used to retrieve an object implementing the requested record.

Parameters:

auditEnablerSearchRecordType - an audit enabler search record type

Returns:

the audit enabler search results record

Throws:

NullArgumentException - auditEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(auditEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.