Interface FamilyQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector
public interface FamilyQueryInspector extends OsidCatalogQueryInspector

This is the query inspector for examining family queries.

  • Method Details

    • getRelationshipIdTerms

      IdTerm[] getRelationshipIdTerms()
      Gets the relationship Id terms.
      Specified by:
      getRelationshipIdTerms in interface OsidObjectQueryInspector
      Returns:
      the relationship Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getRelationshipTerms

      RelationshipQueryInspector[] getRelationshipTerms()
      Gets the relationship terms.
      Specified by:
      getRelationshipTerms in interface OsidObjectQueryInspector
      Returns:
      the relationship terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorFamilyIdTerms

      IdTerm[] getAncestorFamilyIdTerms()
      Gets the ancestor family Id terms.
      Returns:
      the ancestor family Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorFamilyTerms

      FamilyQueryInspector[] getAncestorFamilyTerms()
      Gets the ancestor family terms.
      Returns:
      the ancestor family terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantFamilyIdTerms

      IdTerm[] getDescendantFamilyIdTerms()
      Gets the descendant family Id terms.
      Returns:
      the descendant family Id terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantFamilyTerms

      FamilyQueryInspector[] getDescendantFamilyTerms()
      Gets the descendant family terms.
      Returns:
      the descendant family terms
      Compliance:
      mandatory - This method must be implemented.

    • getFamilyQueryInspectorRecord

      FamilyQueryInspectorRecord getFamilyQueryInspectorRecord(Type familyRecordType) throws OperationFailedException, PermissionDeniedException
      Gets the family query inspector record corresponding to the given Family record Type .
      Parameters:
      familyRecordType - a family record type
      Returns:
      the family query inspector record
      Throws:
      NullArgumentException - familyRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - hasRecordType(familyRecordType) is false
      Compliance:
      mandatory - This method must be implemented.