Interface RegistrationRequestItem

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, Subjugateable
public interface RegistrationRequestItem extends OsidObject, Subjugateable

A RegistrationRequestItem supports several operations:

  • ADD: Registers the student into the designated RegistrationTarget .
  • DROP: Ends the existing Registration .
  • UPDATE: Swaps the existing Registration with the RegistrationTarget and/or updates the credit and grading options.

  • Method Details

    • getRegistrationRequestId

      Id getRegistrationRequestId()
      Gets the Id of the registration request.
      Returns:
      the registration request Id
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRequest

      RegistrationRequest getRegistrationRequest() throws OperationFailedException
      Gets the registration request,
      Returns:
      the registration request
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getStudentId

      Id getStudentId()
      Gets the Id of the student resource for whom this applies.
      Returns:
      the resource Id
      Compliance:
      mandatory - This method must be implemented.

    • getStudent

      Resource getStudent() throws OperationFailedException
      Gets the student resource for whom this applies.
      Returns:
      the resource
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationOperation

      RegistrationOperation getRegistrationOperation()
      Gets the operation.
      Returns:
      the operation
      Compliance:
      mandatory - This method must be implemented.

    • getRegsistrationTargetId

      Id getRegsistrationTargetId()
      Gets the Id of the registration target. A registration target must exist for valid ADD and UPDATE operations.
      Returns:
      the registration target Id
      Throws:
      IllegalStateException - getOperation() != ADD and getOperation() != UPDATE
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationTarget

      RegistrationTarget getRegistrationTarget() throws OperationFailedException
      Gets the registration target. A registration target must exist for valid ADD and UPDATE operations.
      Returns:
      the registration target
      Throws:
      IllegalStateException - getOperation() != ADD and getOperation() != UPDATE
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getExixtingRegsistrationId

      Id getExixtingRegsistrationId()
      Gets the Id of the existing registration to be dropped or updated. An existing registration must exist for valid UPDATE and DROP operations.
      Returns:
      the existing registration Id
      Throws:
      IllegalStateException - getOperation() != UPDATE and getOperation() != DROP
      Compliance:
      mandatory - This method must be implemented.

    • getExistingRegistration

      Registration getExistingRegistration() throws OperationFailedException
      Gets the existing registration to be dropped or updated. An existing registration must exist for valid UPDATE and DROP operations.
      Returns:
      the existing registration
      Throws:
      IllegalStateException - getOperation() != UPDATE and getOperation() != DROP
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • specifiesCreditOption

      boolean specifiesCreditOption()
      Tests if this request item specifies the number of credits to be taken. If no credit option range is specified in the RegistrationTarget , then this may be left unspecified.
      Returns:
      true if this a credit option is specified, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCreditOption

      BigDecimal getCreditOption()
      Gets the number of credits for which the student is registering.
      Returns:
      the number of credits
      Throws:
      IllegalStateException - specifiesCreditOption() is false
      Compliance:
      mandatory - This method must be implemented.

    • specifiesGradingOption

      boolean specifiesGradingOption()
      Tests if this request item specifies the grading option. If the RegistrationTarget does not specify multiple grading options, then this may be left unspecified.
      Returns:
      true if this a grading option is specified, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getGradingOptionId

      Id getGradingOptionId()
      Gets the grading option Id .
      Returns:
      the grading system Id
      Throws:
      IllegalStateException - specifiesGradingOption() is false
      Compliance:
      mandatory - This method must be implemented.

    • getGradingOption

      GradeSystem getGradingOption() throws OperationFailedException
      Gets the grading option.
      Returns:
      the grade system option
      Throws:
      IllegalStateException - specifiesGradingOption() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getRegistrationRequestItemRecord

      RegistrationRequestItemRecord getRegistrationRequestItemRecord(Type registrationRequestItemRecordType) throws OperationFailedException
      Gets the registration request item record corresponding to the given RegistrationR equestItem record Type . This method ie used to retrieve an object implementing the requested record. The registrationRequestItem RecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(registrationRequestItemRe cordType) is true .
      Parameters:
      registrationRequestItemRecordType - the type of registration request item record to retrieve
      Returns:
      the registration request item record
      Throws:
      NullArgumentException - registrationRequestItemRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(registrationRequestItemRecordType) is false
      Compliance:
      mandatory - This method must be implemented.