Interface IssueProcessorSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface IssueProcessorSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
IssueProcessorQueryInspector	getIssueProcessorQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
IssueProcessorList	getIssueProcessors()	Gets the issue processor list resulting from a search.
IssueProcessorSearchResultsRecord	getIssueProcessorSearchResultsRecord(Type issueProcessorSearchRecordType)	Gets the issue processor search results record corresponding to the given issue processor 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

getIssueProcessors

IssueProcessorList getIssueProcessors()

Gets the issue processor list resulting from a search.

Returns:

the issue processor list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getIssueProcessorQueryInspector

IssueProcessorQueryInspector getIssueProcessorQueryInspector()

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

Returns:

the issue processor query inspector

Compliance:

mandatory - This method must be implemented.

getIssueProcessorSearchResultsRecord

IssueProcessorSearchResultsRecord getIssueProcessorSearchResultsRecord(Type issueProcessorSearchRecordType)
                                                                throws OperationFailedException

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

Parameters:

issueProcessorSearchRecordType - an issue processor search record type

Returns:

the issue processor search results record

Throws:

NullArgumentException - issueProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(issueProcessorSearchRecordTypee) is false

Compliance:

mandatory - This method must be implemented.