Interface IssueEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface IssueEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
IssueEnablerQueryInspector	getIssueEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
IssueEnablerList	getIssueEnablers()	Gets the issue enabler list resulting from a search.
IssueEnablerSearchResultsRecord	getIssueEnablerSearchResultsRecord(Type issueEnablerSearchRecordType)	Gets the issue enabler search results record corresponding to the given issue enabler 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

getIssueEnablers

IssueEnablerList getIssueEnablers()

Gets the issue enabler list resulting from a search.

Returns:

the issu eenabler list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getIssueEnablerQueryInspector

IssueEnablerQueryInspector getIssueEnablerQueryInspector()

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

Returns:

the issue enabler query inspector

Compliance:

mandatory - This method must be implemented.

getIssueEnablerSearchResultsRecord

IssueEnablerSearchResultsRecord getIssueEnablerSearchResultsRecord(Type issueEnablerSearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

issueEnablerSearchRecordType - an issue enabler search record type

Returns:

the issue enabler search results record

Throws:

NullArgumentException - issueEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(issueEnablerSearchRecordTypee) is false

Compliance:

mandatory - This method must be implemented.