Interface CredentialEntryQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector
public interface CredentialEntryQueryInspector extends OsidRelationshipQueryInspector

The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to OsidQuery interfaces for reuse or modification in the search sessions.

  • Method Details

    • getStudentIdTerms

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

    • getStudentTerms

      ResourceQueryInspector[] getStudentTerms()
      Gets the student query terms.
      Returns:
      the resource query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialIdTerms

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

    • getCredentialTerms

      CredentialQueryInspector[] getCredentialTerms()
      Gets the credential query terms.
      Returns:
      the credential terms
      Compliance:
      mandatory - This method must be implemented.

    • getIsMatriculationKnownTerms

      BooleanTerm[] getIsMatriculationKnownTerms()
      Gets the matriculation known query terms.
      Returns:
      the matriculation known terms
      Compliance:
      mandatory - This method must be implemented.

    • getStartDateTerms

      DateTimeRangeTerm[] getStartDateTerms()
      Gets the start date query terms.
      Specified by:
      getStartDateTerms in interface OsidTemporalQueryInspector
      Returns:
      the start date terms
      Compliance:
      mandatory - This method must be implemented.

    • getStartTermIdTerms

      IdTerm[] getStartTermIdTerms()
      Gets the start term Id query terms.
      Returns:
      the start term Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getStartTermTerms

      TermQueryInspector[] getStartTermTerms()
      Gets the start term query terms.
      Returns:
      the start term terms
      Compliance:
      mandatory - This method must be implemented.

    • getIsExpectedToCompleteTerms

      BooleanTerm[] getIsExpectedToCompleteTerms()
      Gets the expected to complete query terms.
      Returns:
      the expected to complete terms
      Compliance:
      mandatory - This method must be implemented.

    • getExpectedCompletionDateTerms

      DateTimeRangeTerm[] getExpectedCompletionDateTerms()
      Gets the expected completion date query terms.
      Returns:
      the expected completion date terms
      Compliance:
      mandatory - This method must be implemented.

    • getExpectedCompletionTermIdTerms

      IdTerm[] getExpectedCompletionTermIdTerms()
      Gets the expected completion term Id query terms.
      Returns:
      the expected completion term Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getExpectedCompletionTermTerms

      TermQueryInspector[] getExpectedCompletionTermTerms()
      Gets the expected completion term query terms.
      Returns:
      the expected completion term terms
      Compliance:
      mandatory - This method must be implemented.

    • getIsActivelyPursuingTerms

      BooleanTerm[] getIsActivelyPursuingTerms()
      Gets the actively pursuing query terms.
      Returns:
      the actively pursuing terms
      Compliance:
      mandatory - This method must be implemented.

    • getIsPausedTerms

      BooleanTerm[] getIsPausedTerms()
      Gets the paused query terms.
      Returns:
      the paused terms
      Compliance:
      mandatory - This method must be implemented.

    • getIsAbandonedTerms

      BooleanTerm[] getIsAbandonedTerms()
      Gets the abandoned query terms.
      Returns:
      the abandoned terms
      Compliance:
      mandatory - This method must be implemented.

    • getAbandonDateTerms

      DateTimeRangeTerm[] getAbandonDateTerms()
      Gets the abandon date query terms.
      Returns:
      the abandon date terms
      Compliance:
      mandatory - This method must be implemented.

    • getAbandonTermIdTerms

      IdTerm[] getAbandonTermIdTerms()
      Gets the abandon term Id query terms.
      Returns:
      the abandon term Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAbandonTermTerms

      TermQueryInspector[] getAbandonTermTerms()
      Gets the abandon term query terms.
      Returns:
      the abandon term terms
      Compliance:
      mandatory - This method must be implemented.

    • getIsAwardedTerms

      BooleanTerm[] getIsAwardedTerms()
      Gets the awarded query terms.
      Returns:
      the awarded terms
      Compliance:
      mandatory - This method must be implemented.

    • getAwardDateTerms

      DateTimeRangeTerm[] getAwardDateTerms()
      Gets the award date query terms.
      Returns:
      the award date terms
      Compliance:
      mandatory - This method must be implemented.

    • getAwardTermIdTerms

      IdTerm[] getAwardTermIdTerms()
      Gets the award term Id query terms.
      Returns:
      the award term Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAwardTermTerms

      TermQueryInspector[] getAwardTermTerms()
      Gets the award term query terms.
      Returns:
      the award term terms
      Compliance:
      mandatory - This method must be implemented.

    • getDateAwardedTerms

      DateTimeRangeTerm[] getDateAwardedTerms()
      Gets the award date query terms.
      Returns:
      the date terms
      Compliance:
      mandatory - This method must be implemented.

    • getProgramIdTerms

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

    • getProgramTerms

      ProgramQueryInspector[] getProgramTerms()
      Gets the program query terms.
      Returns:
      the program terms
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogIdTerms

      IdTerm[] getCourseCatalogIdTerms()
      Gets the course catalog Id query terms.
      Returns:
      the course catalog Id query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogTerms

      CourseCatalogQueryInspector[] getCourseCatalogTerms()
      Gets the course catalog query terms.
      Returns:
      the course catalog query terms
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialEntryQueryInspectorRecord

      CredentialEntryQueryInspectorRecord getCredentialEntryQueryInspectorRecord(Type credentialEntryRecordType) throws OperationFailedException
      Gets the credential entry query inspector record corresponding to the given CredentialEntry record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      credentialEntryRecordType - a credential entry record type
      Returns:
      the credential entry query inspector record
      Throws:
      NullArgumentException - credentialEntryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(credentialEntryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.