Interface ResourceRelationshipSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ResourceRelationshipSearch
extends OsidSearch

ResourceRelationshipSearch defines the interface for specifying relationship search options.

Method Summary

Modifier and Type	Method	Description
ResourceRelationshipSearchRecord	getResourceRelationshipSearchRecord(Type resourceRelationshipSearchRecordType)	Gets the resource relationship search record corresponding to the given relationship search record Type .This method is used to retrieve an object implementing the requested record.
void	orderResourceRelationshipResults(ResourceRelationshipSearchOrder resourceRelationshipSearchOrder)	Specify an ordering to the search results.
void	searchAmongResourceRelationships(IdList resourceRelationshipIds)	Execute this search among the given list of resource 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

searchAmongResourceRelationships

void searchAmongResourceRelationships(IdList resourceRelationshipIds)

Execute this search among the given list of resource relationships.

Parameters:

resourceRelationshipIds - list of resource relationships

Throws:

NullArgumentException - resourceRelationshipIds is null

Compliance:

mandatory - This method must be implemented.

orderResourceRelationshipResults

void orderResourceRelationshipResults(ResourceRelationshipSearchOrder resourceRelationshipSearchOrder)

Specify an ordering to the search results.

Parameters:

resourceRelationshipSearchOrder - relationship search order

Throws:

NullArgumentException - resourceRelationshipSearchOrder is null

UnsupportedException - resourceRelationshipSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getResourceRelationshipSearchRecord

ResourceRelationshipSearchRecord getResourceRelationshipSearchRecord(Type resourceRelationshipSearchRecordType)
                                                              throws OperationFailedException

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

Parameters:

resourceRelationshipSearchRecordType - a resource relationship search record type

Returns:

the resource relationship search record

Throws:

NullArgumentException - resourceRelationshipSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(resourceRelationshipSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.