Interface ProfileQueryInspector

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

This is the query inspector to examine profile queries.

  • Method Details

    • getProfileItemIdTerms

      IdTerm[] getProfileItemIdTerms()
      Gets the profile item Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getProfileItemTerms

      ProfileItemQueryInspector[] getProfileItemTerms()
      Gets the profile item query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getProfileEntryIdTerms

      IdTerm[] getProfileEntryIdTerms()
      Gets the profile entry Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getProfileEntryTerms

      ProfileEntryQueryInspector[] getProfileEntryTerms()
      Gets the profile entry query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorProfileIdTerms

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

    • getAncestorProfileTerms

      ProfileQueryInspector[] getAncestorProfileTerms()
      Gets the ancestor profile query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantProfileIdTerms

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

    • getDescendantProfileTerms

      ProfileQueryInspector[] getDescendantProfileTerms()
      Gets the descendant profile query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getProfileQueryInspectorRecord

      ProfileQueryInspectorRecord getProfileQueryInspectorRecord(Type profileRecordType) throws OperationFailedException
      Gets the profile query inspector record corresponding to the given Profile record Type .
      Parameters:
      profileRecordType - a profile record type
      Returns:
      the profile query inspector record
      Throws:
      NullArgumentException - profileRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(profileRecordType) is false
      Compliance:
      mandatory - This method must be implemented.