Interface IssueConstrainerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface IssueConstrainerSearch
extends OsidSearch

The search interface for governing issue constrainer searches.

Method Summary

Modifier and Type	Method	Description
IssueConstrainerSearchRecord	getIssueConstrainerSearchRecord(Type issueConstrainerSearchRecordType)	Gets the issue constrainer search record corresponding to the given issue constrainer search record Type .This method is used to retrieve an object implementing the requested record.
void	orderIssueConstrainerResults(IssueConstrainerSearchOrder issueConstrainerSearchOrder)	Specify an ordering to the search results.
void	searchAmongIssueConstrainers(IdList issueConstrainerIds)	Execute this search among the given list of issue constrainers.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongIssueConstrainers

void searchAmongIssueConstrainers(IdList issueConstrainerIds)

Execute this search among the given list of issue constrainers.

Parameters:

issueConstrainerIds - list of issue constrainers

Throws:

NullArgumentException - issueConstrainerIds is null

Compliance:

mandatory - This method must be implemented.

orderIssueConstrainerResults

void orderIssueConstrainerResults(IssueConstrainerSearchOrder issueConstrainerSearchOrder)

Specify an ordering to the search results.

Parameters:

issueConstrainerSearchOrder - issue constrainer search order

Throws:

NullArgumentException - issueConstrainerSearchOrder is null

UnsupportedException - issueConstrainerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getIssueConstrainerSearchRecord

IssueConstrainerSearchRecord getIssueConstrainerSearchRecord(Type issueConstrainerSearchRecordType)
                                                      throws OperationFailedException

Gets the issue constrainer search 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 record

Throws:

NullArgumentException - issueConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(issueConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.