Interface CredentialEntryQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable
public interface CredentialEntryQuery extends OsidRelationshipQuery

This is the query for searching credential entries. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR .

  • Method Details

    • matchStudentId

      void matchStudentId(Id resourceId, boolean match)
      Sets the student Id for this query.
      Parameters:
      resourceId - a resource Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - resourceId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearStudentIdTerms

      void clearStudentIdTerms()
      Clears the student Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsStudentQuery

      boolean supportsStudentQuery()
      Tests if a StudentQuery is available.
      Returns:
      true if a student query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getStudentQuery

      ResourceQuery getStudentQuery()
      Gets the query for a student option. Multiple retrievals produce a nested OR term.
      Returns:
      a student query
      Throws:
      UnimplementedException - supportsStudentQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStudentQuery()} is {@code true} .

    • clearStudentTerms

      void clearStudentTerms()
      Clears the student option terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCredentialId

      void matchCredentialId(Id credentialId, boolean match)
      Sets the credential Id for this query to match entries that have an entry for the given course.
      Parameters:
      credentialId - a credential Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - credentialId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCredentialIdTerms

      void clearCredentialIdTerms()
      Clears the credential Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCredentialQuery

      boolean supportsCredentialQuery()
      Tests if a CredentialQuery is available.
      Returns:
      true if a credential query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialQuery

      CredentialQuery getCredentialQuery()
      Gets the query for a credential entry. Multiple retrievals produce a nested OR term.
      Returns:
      a credential query
      Throws:
      UnimplementedException - supportsCredentialQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCredentialQuery()} is {@code true} .

    • clearCredentialTerms

      void clearCredentialTerms()
      Clears the credential terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchIsMatriculationKnown

      void matchIsMatriculationKnown(boolean match)
      Matches credential entries with a matriculation known value.
      Parameters:
      match - true to match a true value, false to match a false value
      Compliance:
      mandatory - This method must be implemented.

    • clearIsMatriculationKnownTerms

      void clearIsMatriculationKnownTerms()
      Clears the matriculation known terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchStartDate

      void matchStartDate(DateTime from, DateTime to, boolean match)
      Matches start dates between the given dates inclusive.
      Specified by:
      matchStartDate in interface OsidTemporalQuery
      Parameters:
      from - starting date
      to - ending date
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyStartDate

      void matchAnyStartDate(boolean match)
      Matches credential entries with any start date.
      Specified by:
      matchAnyStartDate in interface OsidTemporalQuery
      Parameters:
      match - true to match entries with a start date, false to match entries with no start date
      Compliance:
      mandatory - This method must be implemented.

    • clearStartDateTerms

      void clearStartDateTerms()
      Clears the start date terms.
      Specified by:
      clearStartDateTerms in interface OsidTemporalQuery
      Compliance:
      mandatory - This method must be implemented.

    • matchStartTermId

      void matchStartTermId(Id startTermId, boolean match)
      Sets the start term Id for this query.
      Parameters:
      startTermId - a start term Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - startTermId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearStartTermIdTerms

      void clearStartTermIdTerms()
      Clears the start term Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsStartTermQuery

      boolean supportsStartTermQuery()
      Tests if a TermQuery is available.
      Returns:
      true if a start term query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getStartTermQuery

      TermQuery getStartTermQuery()
      Gets the query for a start term. Multiple retrievals produce a nested OR term.
      Returns:
      a start term query
      Throws:
      UnimplementedException - supportsStartTermQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStartTermQuery()} is {@code true} .

    • clearStartTermTerms

      void clearStartTermTerms()
      Clears the start term terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchIsExpectedToComplete

      void matchIsExpectedToComplete(boolean match)
      Matches credential entries with a expected to complete value.
      Parameters:
      match - true to match a true value, false to match a false value
      Compliance:
      mandatory - This method must be implemented.

    • clearIsExpectedToCompleteTerms

      void clearIsExpectedToCompleteTerms()
      Clears the expected to complete terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchExpectedCompletionDate

      void matchExpectedCompletionDate(DateTime from, DateTime to, boolean match)
      Matches expected completion dates between the given dates inclusive.
      Parameters:
      from - starting date
      to - ending date
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyExpectedCompletionDate

      void matchAnyExpectedCompletionDate(boolean match)
      Matches credential entries with any expected completion date.
      Parameters:
      match - true to match entries with a expected completion date, false to match entries with no expected completion date
      Compliance:
      mandatory - This method must be implemented.

    • clearExpectedCompletionDateTerms

      void clearExpectedCompletionDateTerms()
      Clears the expected completion date terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchExpectedCompletionTermId

      void matchExpectedCompletionTermId(Id expectedCompletionTermId, boolean match)
      Sets the expected completion term Id for this query.
      Parameters:
      expectedCompletionTermId - a expected completion term Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - expectedCompletionTermId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearExpectedCompletionTermIdTerms

      void clearExpectedCompletionTermIdTerms()
      Clears the expected completion term Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsExpectedCompletionTermQuery

      boolean supportsExpectedCompletionTermQuery()
      Tests if a TermQuery is available.
      Returns:
      true if a expected completion term query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getExpectedCompletionTermQuery

      TermQuery getExpectedCompletionTermQuery()
      Gets the query for a expected completion term. Multiple retrievals produce a nested OR term.
      Returns:
      a expected completion term query
      Throws:
      UnimplementedException - supportsExpectedCompletionTermQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsExpectedCompletionTermQuery()} is {@code true} .

    • clearExpectedCompletionTermTerms

      void clearExpectedCompletionTermTerms()
      Clears the expected completion term terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchIsActivelyPursuing

      void matchIsActivelyPursuing(boolean match)
      Matches credential entries with a actively pursuing value.
      Parameters:
      match - true to match a true value, false to match a false value
      Compliance:
      mandatory - This method must be implemented.

    • clearIsActivelyPursuingTerms

      void clearIsActivelyPursuingTerms()
      Clears the actively pursuing terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchIsPaused

      void matchIsPaused(boolean match)
      Matches credential entries with a paused value.
      Parameters:
      match - true to match a true value, false to match a false value
      Compliance:
      mandatory - This method must be implemented.

    • clearIsPausedTerms

      void clearIsPausedTerms()
      Clears the paused terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchIsAbandoned

      void matchIsAbandoned(boolean match)
      Matches credential entries with a abandoned value.
      Parameters:
      match - true to match a true value, false to match a false value
      Compliance:
      mandatory - This method must be implemented.

    • clearIsAbandonedTerms

      void clearIsAbandonedTerms()
      Clears the abandoned terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAbandonDate

      void matchAbandonDate(DateTime from, DateTime to, boolean match)
      Matches abandon dates between the given dates inclusive.
      Parameters:
      from - starting date
      to - ending date
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyAbandonDate

      void matchAnyAbandonDate(boolean match)
      Matches credential entries with any abandon date.
      Parameters:
      match - true to match entries with a abandon date, false to match entries with no abandon date
      Compliance:
      mandatory - This method must be implemented.

    • clearAbandonDateTerms

      void clearAbandonDateTerms()
      Clears the abandon date terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAbandonTermId

      void matchAbandonTermId(Id abandonTermId, boolean match)
      Sets the abandon term Id for this query.
      Parameters:
      abandonTermId - a abandon term Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - abandonTermId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAbandonTermIdTerms

      void clearAbandonTermIdTerms()
      Clears the abandon term Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAbandonTermQuery

      boolean supportsAbandonTermQuery()
      Tests if a TermQuery is available.
      Returns:
      true if a abandon term query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAbandonTermQuery

      TermQuery getAbandonTermQuery()
      Gets the query for a abandon term. Multiple retrievals produce a nested OR term.
      Returns:
      a abandon term query
      Throws:
      UnimplementedException - supportsAbandonTermQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAbandonTermQuery()} is {@code true} .

    • clearAbandonTermTerms

      void clearAbandonTermTerms()
      Clears the abandon term terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchIsAwarded

      void matchIsAwarded(boolean match)
      Matches credential entries with a awarded value.
      Parameters:
      match - true to match a true value, false to match a false value
      Compliance:
      mandatory - This method must be implemented.

    • clearIsAwardedTerms

      void clearIsAwardedTerms()
      Clears the awarded terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAwardDate

      void matchAwardDate(DateTime from, DateTime to, boolean match)
      Matches award dates between the given dates inclusive.
      Parameters:
      from - starting date
      to - ending date
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyAwardDate

      void matchAnyAwardDate(boolean match)
      Matches credential entries with any award date.
      Parameters:
      match - true to match entries with a award date, false to match entries with no award date
      Compliance:
      mandatory - This method must be implemented.

    • clearAwardDateTerms

      void clearAwardDateTerms()
      Clears the award date terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAwardTermId

      void matchAwardTermId(Id awardTermId, boolean match)
      Sets the award term Id for this query.
      Parameters:
      awardTermId - a award term Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - awardTermId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAwardTermIdTerms

      void clearAwardTermIdTerms()
      Clears the award term Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAwardTermQuery

      boolean supportsAwardTermQuery()
      Tests if a TermQuery is available.
      Returns:
      true if a award term query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAwardTermQuery

      TermQuery getAwardTermQuery()
      Gets the query for a award term. Multiple retrievals produce a nested OR term.
      Returns:
      a award term query
      Throws:
      UnimplementedException - supportsAwardTermQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAwardTermQuery()} is {@code true} .

    • clearAwardTermTerms

      void clearAwardTermTerms()
      Clears the award term terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDateAwarded

      void matchDateAwarded(DateTime from, DateTime to, boolean match)
      Matches award dates between the given dates inclusive.
      Parameters:
      from - starting date
      to - ending date
      match - true if a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyDateAwarded

      void matchAnyDateAwarded(boolean match)
      Matches entries that have any award date.
      Parameters:
      match - true to match entries with any award date, false to match entries with no award date
      Compliance:
      mandatory - This method must be implemented.

    • clearDateAwardedTerms

      void clearDateAwardedTerms()
      Clears the award date terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchProgramId

      void matchProgramId(Id programId, boolean match)
      Sets the program Id for this query.
      Parameters:
      programId - a program Id
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - programId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearProgramIdTerms

      void clearProgramIdTerms()
      Clears the program Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsProgramQuery

      boolean supportsProgramQuery()
      Tests if a ProgramQuery is available.
      Returns:
      true if a program query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getProgramQuery

      ProgramQuery getProgramQuery()
      Gets the query for a program. Multiple retrievals produce a nested OR term.
      Returns:
      a program query
      Throws:
      UnimplementedException - supportsProgramQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramQuery()} is {@code true} .

    • matchAnyProgram

      void matchAnyProgram(boolean match)
      Matches entries that have any program.
      Parameters:
      match - true to match entries with any program false to match entries with no program
      Compliance:
      mandatory - This method must be implemented.

    • clearProgramTerms

      void clearProgramTerms()
      Clears the program terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCourseCatalogId

      void matchCourseCatalogId(Id courseCatalogId, boolean match)
      Sets the course catalog Id for this query to match entries assigned to course catalogs.
      Parameters:
      courseCatalogId - the course catalog Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - courseCatalogId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCourseCatalogIdTerms

      void clearCourseCatalogIdTerms()
      Clears the course catalog Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCourseCatalogQuery

      boolean supportsCourseCatalogQuery()
      Tests if a CourseCatalogQuery is available.
      Returns:
      true if a course catalog query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCourseCatalogQuery

      CourseCatalogQuery getCourseCatalogQuery()
      Gets the query for a course catalog. Multiple retrievals produce a nested OR term.
      Returns:
      the course catalog query
      Throws:
      UnimplementedException - supportsCourseCatalogQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCourseCatalogQuery()} is {@code true} .

    • clearCourseCatalogTerms

      void clearCourseCatalogTerms()
      Clears the course catalog terms.
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialEntryQueryRecord

      CredentialEntryQueryRecord getCredentialEntryQueryRecord(Type credentialEntryRecordType) throws OperationFailedException
      Gets the credential entry query 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 record
      Throws:
      NullArgumentException - credentialEntryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(credentialEntryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.