Interface RelationshipEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RelationshipEnablerSearch
extends OsidSearch

The search interface for governing relationship enabler searches.

Method Summary

Modifier and Type	Method	Description
RelationshipEnablerSearchRecord	getRelationshipEnablerSearchRecord(Type relationshipEnablerSearchRecordType)	Gets the relationship enabler search record corresponding to the given relationship enabler search record Type.
void	orderRelationshipEnablerResults(RelationshipEnablerSearchOrder relationshipEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongRelationshipEnablers(IdList relationshipEnablerIds)	Execute this search among the given list of relationship enablers.

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

searchAmongRelationshipEnablers

void searchAmongRelationshipEnablers(IdList relationshipEnablerIds)

Execute this search among the given list of relationship enablers.

Parameters:

relationshipEnablerIds - list of relationship enablers

Throws:

NullArgumentException - relationshipEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderRelationshipEnablerResults

void orderRelationshipEnablerResults(RelationshipEnablerSearchOrder relationshipEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

relationshipEnablerSearchOrder - relationship enabler search order

Throws:

NullArgumentException - relationshipEnablerSearchOrder is null

UnsupportedException - relationshipEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRelationshipEnablerSearchRecord

RelationshipEnablerSearchRecord getRelationshipEnablerSearchRecord(Type relationshipEnablerSearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

relationshipEnablerSearchRecordType - a relationship enabler search record type

Returns:

the relationship enabler search record

Throws:

NullArgumentException - relationshipEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(relationshipEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.