Interface IssueProcessorEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface IssueProcessorEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
IssueProcessorEnablerQueryInspector	getIssueProcessorEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
IssueProcessorEnablerList	getIssueProcessorEnablers()	Gets the issue processor enabler list resulting from a search.
IssueProcessorEnablerSearchResultsRecord	getIssueProcessorEnablerSearchResultsRecord(Type issueProcessorEnablerSearchRecordType)	Gets the issue processor enabler search results record corresponding to the given issue processor 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

getIssueProcessorEnablers

IssueProcessorEnablerList getIssueProcessorEnablers()

Gets the issue processor enabler list resulting from a search.

Returns:

the issue processor enabler list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getIssueProcessorEnablerQueryInspector

IssueProcessorEnablerQueryInspector getIssueProcessorEnablerQueryInspector()

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

Returns:

the issue processor enabler query inspector

Compliance:

mandatory - This method must be implemented.

getIssueProcessorEnablerSearchResultsRecord

IssueProcessorEnablerSearchResultsRecord getIssueProcessorEnablerSearchResultsRecord(Type issueProcessorEnablerSearchRecordType)
                                                                              throws OperationFailedException

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

Parameters:

issueProcessorEnablerSearchRecordType - an issue processor enabler search record type

Returns:

the issue processor enabler search results record

Throws:

NullArgumentException - issueProcessorEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(issueProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.