Interface AuditConstrainerEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface AuditConstrainerEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
AuditConstrainerEnablerQueryInspector	getAuditConstrainerEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
AuditConstrainerEnablerList	getAuditConstrainerEnablers()	Gets the audit constrainer enabler list resulting from a search.
AuditConstrainerEnablerSearchResultsRecord	getAuditConstrainerEnablerSearchResultsRecord(Type auditConstrainerEnablerSearchRecordType)	Gets the audit constrainer enabler search results record corresponding to the given audit constrainer enabler 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

getAuditConstrainerEnablers

AuditConstrainerEnablerList getAuditConstrainerEnablers()

Gets the audit constrainer enabler list resulting from a search.

Returns:

the audit constrainer enabler list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getAuditConstrainerEnablerQueryInspector

AuditConstrainerEnablerQueryInspector getAuditConstrainerEnablerQueryInspector()

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

Returns:

the audit constrainer enabler query inspector

Compliance:

mandatory - This method must be implemented.

getAuditConstrainerEnablerSearchResultsRecord

AuditConstrainerEnablerSearchResultsRecord getAuditConstrainerEnablerSearchResultsRecord(Type auditConstrainerEnablerSearchRecordType)
                                                                                  throws OperationFailedException

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

Parameters:

auditConstrainerEnablerSearchRecordType - an audit constrainer enabler search record type

Returns:

the audit constrainer enabler search results record

Throws:

NullArgumentException - auditConstrainerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(auditConstrainerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.