Interface ProgramEntrySearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable
public interface ProgramEntrySearchOrder 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} .

    • 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} .

    • orderByParentProgramEntry

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

    • supportsParentProgramEntrySearchOrder

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

    • getParentProgramEntrySearchOrder

      ProgramEntrySearchOrder getParentProgramEntrySearchOrder()
      Gets the parent program entry order.
      Returns:
      the parent program entry search order
      Throws:
      UnimplementedException - supportsParentProgramEntrySearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParentProgramEntrySearchOrder()} 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.

    • orderByEntranceDate

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

    • orderByEntranceTerm

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

    • supportsEntranceTermSearchOrder

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

    • getEntranceTermSearchOrder

      TermSearchOrder getEntranceTermSearchOrder()
      Gets the entrance term order.
      Returns:
      the entrance term search order
      Throws:
      UnimplementedException - supportsEntranceTermSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEntranceTermSearchOrder()} 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} .

    • orderByIsEnrolled

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

    • orderByIsActivelyEnrolled

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

    • orderByIsOnLeave

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

    • orderByHasWithdrawn

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

    • orderByWithdrawDate

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

    • orderByWithdrawTerm

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

    • supportsWithdrawTermSearchOrder

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

    • getWithdrawTermSearchOrder

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

    • orderByComplete

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

    • orderByCompletionDate

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

    • orderByCompletionTerm

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

    • supportsCompletionTermSearchOrder

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

    • getCompletionTermSearchOrder

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

    • orderByLevel

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

    • supportsLevelSearchOrder

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

    • getLevelSearchOrder

      GradeSearchOrder getLevelSearchOrder()
      Gets the level order.
      Returns:
      the level search order
      Throws:
      UnimplementedException - supportsLevelSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsLevelSearchOrder()} is {@code true} .

    • orderByStanding

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

    • supportsStandingSearchOrder

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

    • getStandingSearchOrder

      GradeSearchOrder getStandingSearchOrder()
      Gets the standing order.
      Returns:
      the standing search order
      Throws:
      UnimplementedException - supportsStandingSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStandingSearchOrder()} is {@code true} .

    • orderByAdmissionDate

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

    • orderByTerm

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

    • supportsTermSearchOrder

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

    • getTermSearchOrder

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

    • orderByCreditScale

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

    • supportsCreditScaleSearchOrder

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

    • getCreditScaleSearchOrder

      GradeSystemSearchOrder getCreditScaleSearchOrder()
      Gets the grade system order.
      Returns:
      the credit scale search order
      Throws:
      UnimplementedException - supportsCreditScaleSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCreditScaleSearchOrder()} is {@code true} .

    • orderByCreditsEarned

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

    • orderByGPAScale

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

    • supportsGPAScaleSearchOrder

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

    • getGPAScaleSearchOrder

      GradeSystemSearchOrder getGPAScaleSearchOrder()
      Gets the grade system order.
      Returns:
      the GPA scale search order
      Throws:
      UnimplementedException - supportsGPAScaleSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsGPAScaleSearchOrder()} is {@code true} .

    • orderByGPA

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

    • getProgramEntrySearchOrderRecord

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