Interface RelationshipSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface RelationshipSearch
extends OsidSearch

The search interface for governing relationship searches.

Method Summary

Modifier and Type	Method	Description
RelationshipSearchRecord	getRelationshipSearchRecord(Type relationshipSearchRecordType)	Gets the relationship search record corresponding to the given relationship search record Type .This method is used to retrieve an object implementing the requested record.
void	orderRelationshipResults(RelationshipSearchOrder relationshipSearchOrder)	Specify an ordering to the search results.
void	searchAmongRelationships(IdList relationshipIds)	Execute this search among the given list of relationships.

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

searchAmongRelationships

void searchAmongRelationships(IdList relationshipIds)

Execute this search among the given list of relationships.

Parameters:

relationshipIds - list of relationships

Throws:

NullArgumentException - relationshipIds is null

Compliance:

mandatory - This method must be implemented.

orderRelationshipResults

void orderRelationshipResults(RelationshipSearchOrder relationshipSearchOrder)

Specify an ordering to the search results.

Parameters:

relationshipSearchOrder - relationship search order

Throws:

NullArgumentException - relationshipSearchOrder is null

UnsupportedException - relationshipSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getRelationshipSearchRecord

RelationshipSearchRecord getRelationshipSearchRecord(Type relationshipSearchRecordType)
                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

relationshipSearchRecordType - a relationship search record type

Returns:

the relationship search record

Throws:

NullArgumentException - relationshipSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(relationshipSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.