public interface RelationshipEnablerSearch extends OsidSearch
The search interface for governing relationship enabler searches.
Modifier and Type | Method and 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.
|
limitResultSet
getRecordTypes, hasRecordType
void searchAmongRelationshipEnablers(IdList relationshipEnablerIds)
relationshipEnablerIds
- list of relationship enablersNullArgumentException
- relationshipEnablerIds
is null
mandatory
- This method must be implemented. void orderRelationshipEnablerResults(RelationshipEnablerSearchOrder relationshipEnablerSearchOrder)
relationshipEnablerSearchOrder
- relationship enabler search
orderNullArgumentException
-
relationshipEnablerSearchOrder
is null
UnsupportedException
-
relationshipEnablerSearchOrder
is not of this servicemandatory
- This method must be implemented. RelationshipEnablerSearchRecord getRelationshipEnablerSearchRecord(Type relationshipEnablerSearchRecordType) throws OperationFailedException
Type.
This method is
used to retrieve an object implementing the requested record.relationshipEnablerSearchRecordType
- a relationship enabler
search record typeNullArgumentException
-
relationshipEnablerSearchRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(relationshipEnablerSearchRecordType)
is
false
mandatory
- This method must be implemented.