OSID Specifications
relationship package
Version 3.1.0
relationship package
Version 3.1.0
| Interface | osid.relationship.FamilyQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Used By | osid.relationship.FamilyQueryInspector | ||
osid.relationship.FamilySearchResults | |||
osid.relationship.RelationshipQueryInspector | |||
osid.relationship.rules.RelationshipEnablerQueryInspector | |||
| Description |
This is the query inspector for examining family queries. | ||
| Method | getRelationshipIdTerms | ||
| Description |
Gets the relationship | ||
| Return | osid.search.terms.IdTerm[] | the relationship Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getRelationshipTerms | ||
| Description |
Gets the relationship terms. | ||
| Return | osid.relationship.RelationshipQueryInspector[] | the relationship terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorFamilyIdTerms | ||
| Description |
Gets the ancestor family | ||
| Return | osid.search.terms.IdTerm[] | the ancestor family Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorFamilyTerms | ||
| Description |
Gets the ancestor family terms. | ||
| Return | osid.relationship.FamilyQueryInspector[] | the ancestor family terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantFamilyIdTerms | ||
| Description |
Gets the descendant family | ||
| Return | osid.search.terms.IdTerm[] | the descendant family Id terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantFamilyTerms | ||
| Description |
Gets the descendant family terms. | ||
| Return | osid.relationship.FamilyQueryInspector[] | the descendant family terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFamilyQueryInspectorRecord | ||
| Description |
Gets the family query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | familyRecordType | a family record type |
| Return | osid.relationship.records.FamilyQueryInspectorRecord | the family query inspector record | |
| Errors | NULL_ARGUMENT | familyRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure occurred | ||
| UNSUPPORTED | hasRecordType(familyRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |