Interface CredentialEntrySearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable
public interface CredentialEntrySearchOrder extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByStudent

      void orderByStudent(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the resource.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsStudentSearchOrder

      boolean supportsStudentSearchOrder()
      Tests if a resource order is available.
      Returns:
      true if a resource order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getStudentSearchOrder

      ResourceSearchOrder getStudentSearchOrder()
      Gets the resource order.
      Returns:
      the resource search order
      Throws:
      UnimplementedException - supportsStudentSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStudentSearchOrder()} is {@code true} .

    • orderByCredential

      void orderByCredential(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the credential.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsCredentialSearchOrder

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

    • getCredentialSearchOrder

      CredentialSearchOrder getCredentialSearchOrder()
      Gets the credential order.
      Returns:
      the credential search order
      Throws:
      UnimplementedException - supportsCredentialSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCredentialSearchOrder()} is {@code true} .

    • orderByIsMatriculationKnown

      void orderByIsMatriculationKnown(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the matriculation known flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByStartDate

      void orderByStartDate(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the start date.
      Specified by:
      orderByStartDate in interface OsidTemporalSearchOrder
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByStartTerm

      void orderByStartTerm(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the start term.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsStartTermSearchOrder

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

    • getStartTermSearchOrder

      TermSearchOrder getStartTermSearchOrder()
      Gets the start term order.
      Returns:
      the start term search order
      Throws:
      UnimplementedException - supportsStartTermSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStartTermSearchOrder()} is {@code true} .

    • orderByIsExpectedToComplete

      void orderByIsExpectedToComplete(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the is expected to complete flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByExpectedCompletionDate

      void orderByExpectedCompletionDate(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the expected completion date.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByExpectedCompletionTerm

      void orderByExpectedCompletionTerm(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the expected completion term.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsExpectedCompletionTermSearchOrder

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

    • getExpectedCompletionTermSearchOrder

      TermSearchOrder getExpectedCompletionTermSearchOrder()
      Gets the expected completion term order.
      Returns:
      the expected completion term search order
      Throws:
      UnimplementedException - supportsExpectedCompletionTermSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsExpectedCompletionTermSearchOrder()} is {@code true} .

    • orderByIsActivelyPursuing

      void orderByIsActivelyPursuing(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the actively pursuing flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByIsPaused

      void orderByIsPaused(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the is paused flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByIsAbandoned

      void orderByIsAbandoned(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the is abandoned flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByAbandonDate

      void orderByAbandonDate(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the abandon date.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByAbandonTerm

      void orderByAbandonTerm(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the abandon term.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsAbandonTermSearchOrder

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

    • getAbandonTermSearchOrder

      TermSearchOrder getAbandonTermSearchOrder()
      Gets the abandon term order.
      Returns:
      the abandon term search order
      Throws:
      UnimplementedException - supportsAbandonTermSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAbandonTermSearchOrder()} is {@code true} .

    • orderByIsAwarded

      void orderByIsAwarded(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the is awarded flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByAwardDate

      void orderByAwardDate(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the award date.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByAwardTerm

      void orderByAwardTerm(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the award term.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsAwardTermSearchOrder

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

    • getAwardTermSearchOrder

      TermSearchOrder getAwardTermSearchOrder()
      Gets the award term order.
      Returns:
      the award term search order
      Throws:
      UnimplementedException - supportsAwardTermSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAwardTermSearchOrder()} is {@code true} .

    • orderByDateAwarded

      void orderByDateAwarded(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the award date.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByProgram

      void orderByProgram(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the program.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsProgramSearchOrder

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

    • getProgramSearchOrder

      ProgramSearchOrder getProgramSearchOrder()
      Gets the program order.
      Returns:
      the program search order
      Throws:
      UnimplementedException - supportsProgramSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProgramSearchOrder()} is {@code true} .

    • getCredentialEntrySearchOrderRecord

      CredentialEntrySearchOrderRecord getCredentialEntrySearchOrderRecord(Type credentialEntryRecordType) throws OperationFailedException
      Gets the chronicle search order record corresponding to the given credential entry record Type . Multiple retrievals return the same underlying object.
      Parameters:
      credentialEntryRecordType - a credential entry record type
      Returns:
      the credential entry search order record
      Throws:
      NullArgumentException - credentialEntryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(credentialEntryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.