OSID Specifications
relationship package
Version 3.0.0
relationship package
Version 3.0.0
| Interface | osid.relationship.RelationshipSearchSession | ||
|---|---|---|---|
| Implements | osid.relationship.RelationshipQuerySession | ||
| Used By | osid.relationship.RelationshipManager | ||
osid.relationship.RelationshipProxyManager | |||
| Description |
This session provides methods for searching among
getRelationshipsByQuery() is the basic search
method and returns a list of Relationships . A
more advanced search may be performed with
getRelationshipsBySearch() .It accepts a
RelationshipSearch in addition to the query for
the purpose of specifying additional options affecting the
entire search, such as ordering.
getRelationshipsBySearch() returns a
RelationshipSearchResults that can be used to
access the resulting RelationshipList or be used
to perform a search within the result set through
RelationshipSearch .
Relationships may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
| Method | getRelationshipSearch | ||
| Description |
Gets a relationship search. | ||
| Return | osid.relationship.RelationshipSearch | the relationship search | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelationshipSearchOrder | ||
| Description |
Gets a relationship search order. The
| ||
| Return | osid.relationship.RelationshipSearchOrder | the relationship search order | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelationshipsBySearch | ||
| Description |
Gets the search results matching the given search query using the given search. | ||
| Parameters | osid.relationship.RelationshipQuery | relationshipQuery | the relationship query |
osid.relationship.RelationshipSearch | relationshipSearch | the relationship search | |
| Return | osid.relationship.RelationshipSearchResults | the returned search results | |
| Errors | NULL_ARGUMENT | relationshipQuery or relationshipSearch is
null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | relationshipQuery or relationshipSearch is not of
this service | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelationshipQueryFromInspector | ||
| Description |
Gets a relationship query from an inspector. The
inspector is available from a
| ||
| Parameters | osid.relationship.RelationshipQueryInspector | relationshipQueryInspector | a relationship query inspector |
| Return | osid.relationship.RelationshipQuery | the relationship query | |
| Errors | NULL_ARGUMENT | relationshipQueryInspector is null | |
| UNSUPPORTED | relationshipQueryInspector is not of this service | ||
| Compliance | mandatory | This method must be implemented. | |