OSID Specifications
relationship rules package
Version 3.0.0
Release Candidate Preview
relationship rules package
Version 3.0.0
Release Candidate Preview
| Interface | osid.relationship.rules.RelationshipEnablerQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidEnablerQueryInspector | ||
| Description |
This is the query inspector for examining relationship enabler queries. | ||
| Method | getRuledRelationshipIdTerms | ||
| Description |
Gets the relationship | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRuledRelationshipTerms | ||
| Description |
Gets the relationship query terms. | ||
| Return | osid.relationship.RelationshipQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFamilyIdTerms | ||
| Description |
Gets the family | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFamilyTerms | ||
| Description |
Gets the family query terms. | ||
| Return | osid.relationship.FamilyQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelationshipEnablerQueryInspectorRecord | ||
| Description |
Gets the relationship enabler query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | relationshipEnablerRecordType | a relationship enabler record type |
| Return | osid.relationship.rules.records.RelationshipEnablerQueryInspectorRecord | the relationship enabler query inspector record | |
| Errors | NULL_ARGUMENT | relationshipEnablerRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(relationshipEnablerRecordType) is false
| ||
| Compliance | mandatory | This method must be implemented. | |