Interface | osid.relationship.rules.RelationshipEnablerSearchSession | ||
---|---|---|---|
Implements | osid.relationship.rules.RelationshipEnablerQuerySession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
| ||
Method | getRelationshipEnablerSearch | ||
Description |
Gets a relationship enabler search. | ||
Return | osid.relationship.rules.RelationshipEnablerSearch | the relationship enabler search | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipEnablerSearchOrder | ||
Description |
Gets a relationship enabler search order. The | ||
Return | osid.relationship.rules.RelationshipEnablerSearchOrder | the relationship enabler search order | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipEnablersBySearch | ||
Description |
Gets the search results matching the given search query using the given search. | ||
Parameters | osid.relationship.rules.RelationshipEnablerQuery | relationshipEnablerQuery | the relationship enabler query |
osid.relationship.rules.RelationshipEnablerSearch | relationshipEnablerSearch | the relationship enabler search | |
Return | osid.relationship.rules.RelationshipEnablerSearchResults | the returned search results | |
Errors | NULL_ARGUMENT | relationshipEnablerQuery or relationshipEnablerSearch
is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | relationshipEnablerQuery or relationshipEnablerSearch
is not of this service | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRelationshipEnablerQueryFromInspector | ||
Description |
Gets a relationship enabler query from an inspector.
The inspector is available from a | ||
Parameters | osid.relationship.rules.RelationshipEnablerQueryInspector | relationshipEnablerQueryInspector | a relationship enabler query inspector |
Return | osid.relationship.rules.RelationshipEnablerQuery | the relationship enabler query | |
Errors | NULL_ARGUMENT | relationshipEnablerQueryInspector is null | |
UNSUPPORTED | relationshipEnablerQueryInspector is not of this service | ||
Compliance | mandatory | This method must be implemented. |