Interface IssueConstrainerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface IssueConstrainerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
IssueConstrainerQueryInspector	getIssueConstrainerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
IssueConstrainerList	getIssueConstrainers()	Gets the issue constrainer list resulting from a search.
IssueConstrainerSearchResultsRecord	getIssueConstrainerSearchResultsRecord(Type issueConstrainerSearchRecordType)	Gets the issue constrainer search results record corresponding to the given issue constrainer 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

getIssueConstrainers

IssueConstrainerList getIssueConstrainers()

Gets the issue constrainer list resulting from a search.

Returns:

the issue constrainer list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getIssueConstrainerQueryInspector

IssueConstrainerQueryInspector getIssueConstrainerQueryInspector()

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

Returns:

the issue constrainer query inspector

Compliance:

mandatory - This method must be implemented.

getIssueConstrainerSearchResultsRecord

IssueConstrainerSearchResultsRecord getIssueConstrainerSearchResultsRecord(Type issueConstrainerSearchRecordType)
                                                                    throws OperationFailedException

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

Parameters:

issueConstrainerSearchRecordType - an issue constrainer search record type

Returns:

the issue constrainer search results record

Throws:

NullArgumentException - issueConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(issueConstrainerSearchRecordTypee) is false

Compliance:

mandatory - This method must be implemented.