public interface ResourceRelationshipSearch extends OsidSearch
ResourceRelationshipSearch
defines the interface for
specifying relationship search options.
Modifier and Type | Method and Description |
---|---|
ResourceRelationshipSearchRecord |
getResourceRelationshipSearchRecord(Type resourceRelationshipSearchRecordType)
Gets the resource relationship search record corresponding to the
given relationship search record
Type. |
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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongResourceRelationships(IdList resourceRelationshipIds)
resourceRelationshipIds
- list of resource relationshipsNullArgumentException
- resourceRelationshipIds
is null
mandatory
- This method must be implemented. void orderResourceRelationshipResults(ResourceRelationshipSearchOrder resourceRelationshipSearchOrder)
resourceRelationshipSearchOrder
- relationship search orderNullArgumentException
-
resourceRelationshipSearchOrder
is null
UnsupportedException
-
resourceRelationshipSearchOrder
is not of this servicemandatory
- This method must be implemented. ResourceRelationshipSearchRecord getResourceRelationshipSearchRecord(Type resourceRelationshipSearchRecordType) throws OperationFailedException
Type.
This method is
used to retrieve an object implementing the requested record.resourceRelationshipSearchRecordType
- a resource relationship
search record typeNullArgumentException
-
resourceRelationshipSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(resourceRelationshipSearchRecordType)
is
false
mandatory
- This method must be implemented.