Interface ProgramOfferingForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable
All Known Subinterfaces:
ProgramOfferingBatchForm
public interface ProgramOfferingForm extends OsidRelationshipForm

This is the form for creating and updating ProgramOfferings. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ProgramOfferingAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

  • Method Details

    • getTitleMetadata

      Metadata getTitleMetadata()
      Gets the metadata for a program title.
      Returns:
      metadata for the title
      Compliance:
      mandatory - This method must be implemented.

    • setTitle

      void setTitle(String title)
      Sets the title.
      Parameters:
      title - the new title
      Throws:
      InvalidArgumentException - title is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - title is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTitle

      void clearTitle()
      Removes the title.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getNumberMetadata

      Metadata getNumberMetadata()
      Gets the metadata for a program offering number.
      Returns:
      metadata for the program number
      Compliance:
      mandatory - This method must be implemented.

    • setNumber

      void setNumber(String number)
      Sets the program number.
      Parameters:
      number - the new program number
      Throws:
      InvalidArgumentException - number is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - number is null
      Compliance:
      mandatory - This method must be implemented.

    • clearNumber

      void clearNumber()
      Removes the program number.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getSponsorsMetadata

      Metadata getSponsorsMetadata()
      Gets the metadata for the sponsors.
      Returns:
      metadata for the sponsors
      Compliance:
      mandatory - This method must be implemented.

    • setSponsors

      void setSponsors(Id[] sponsorIds)
      Sets the sponsors.
      Parameters:
      sponsorIds - the new sponsors
      Throws:
      InvalidArgumentException - sponsorIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - sponsorIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearSponsors

      void clearSponsors()
      Removes the sponsors.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getParentProgramOfferingMetadata

      Metadata getParentProgramOfferingMetadata()
      Gets the metadata for the parent program offering.
      Returns:
      metadata for the parent program offering
      Compliance:
      mandatory - This method must be implemented.

    • setParentProgramOffering

      void setParentProgramOffering(Id programOfferingId)
      Sets the parent program offering.
      Parameters:
      programOfferingId - the new parent program offering
      Throws:
      InvalidArgumentException - programOfferingId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - programOfferingId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearParentProgramOffering

      void clearParentProgramOffering()
      Removes the parent program offering.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getLearningObjectivesMetadata

      Metadata getLearningObjectivesMetadata()
      Gets the metadata for the learning objectives.
      Returns:
      metadata for the learning objectives
      Compliance:
      mandatory - This method must be implemented.

    • setLearningObjectives

      void setLearningObjectives(Id[] objectiveIds)
      Sets the learning objectives.
      Parameters:
      objectiveIds - the new learning objectives
      Throws:
      InvalidArgumentException - objectiveIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - objectiveIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearLearningObjectives

      void clearLearningObjectives()
      Removes the learning objectives.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getRestrictedAudiencesMetadata

      Metadata getRestrictedAudiencesMetadata()
      Gets the metadata for a set of restricted audiences.
      Returns:
      metadata for the restricted audiences
      Compliance:
      mandatory - This method must be implemented.

    • setRestrictedAudiences

      void setRestrictedAudiences(Id[] resourceIds)
      Sets the restricted audiences.
      Parameters:
      resourceIds - the new restricted audiences
      Throws:
      InvalidArgumentException - resourceIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - resourceIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearRestrictedAudiences

      void clearRestrictedAudiences()
      Removes the restricted audiences.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getCompletionRequirementsInfoMetadata

      Metadata getCompletionRequirementsInfoMetadata()
      Gets the metadata for a completion requirements informational string.
      Returns:
      metadata for the prerequisite information
      Compliance:
      mandatory - This method must be implemented.

    • setCompletionRequirementsInfo

      void setCompletionRequirementsInfo(String requirements)
      Sets the completion requirements information.
      Parameters:
      requirements - the new requirements information
      Throws:
      InvalidArgumentException - requirements is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - requirements is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCompletionRequirementsInfo

      void clearCompletionRequirementsInfo()
      Removes the completion requirements information.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getCompletionRequirementsMetadata

      Metadata getCompletionRequirementsMetadata()
      Gets the metadata for a completion requirements requisites.
      Returns:
      metadata for the requisites
      Compliance:
      mandatory - This method must be implemented.

    • setCompletionRequirements

      void setCompletionRequirements(Id[] requisiteIds)
      Sets the completion requirements requisites.
      Parameters:
      requisiteIds - the new requisites
      Throws:
      InvalidArgumentException - ruleId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - requisiteIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCompletionRequirements

      void clearCompletionRequirements()
      Removes the completion requirements requisites.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialsMetadata

      Metadata getCredentialsMetadata()
      Gets the metadata for a set of credentials.
      Returns:
      metadata for the credentials
      Compliance:
      mandatory - This method must be implemented.

    • setCredentials

      void setCredentials(Id[] credentialIds)
      Sets the credentials.
      Parameters:
      credentialIds - the new credentials
      Throws:
      InvalidArgumentException - gradeSystemIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - credentialIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCredentials

      void clearCredentials()
      Removes the credentials.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getRequiresRegistrationMetadata

      Metadata getRequiresRegistrationMetadata()
      Gets the metadata for requires registration flag.
      Returns:
      metadata for registration flag
      Compliance:
      mandatory - This method must be implemented.

    • setRequiresRegistration

      void setRequiresRegistration(boolean requiresRegistration)
      Sets the requires registration flag.
      Parameters:
      requiresRegistration - the new registration flag
      Throws:
      InvalidArgumentException - requiresRegistration is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearRequiresRegistration

      void clearRequiresRegistration()
      Removes the requires registration flag.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getMinimumSeatsMetadata

      Metadata getMinimumSeatsMetadata()
      Gets the metadata for the minimum seats.
      Returns:
      metadata for the minimum seats
      Compliance:
      mandatory - This method must be implemented.

    • setMinimumSeats

      void setMinimumSeats(long seats)
      Sets the minimum seating count.
      Parameters:
      seats - the new minimum seats
      Throws:
      InvalidArgumentException - seats is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearMinimumSeats

      void clearMinimumSeats()
      Removes the minimum seats.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getMaximumSeatsMetadata

      Metadata getMaximumSeatsMetadata()
      Gets the metadata for the maximum seats.
      Returns:
      metadata for the maximum seats
      Compliance:
      mandatory - This method must be implemented.

    • setMaximumSeats

      void setMaximumSeats(long seats)
      Sets the maximum seating count.
      Parameters:
      seats - the new maximum seats
      Throws:
      InvalidArgumentException - seats is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearMaximumSeats

      void clearMaximumSeats()
      Removes the maximum seats.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getURLMetadata

      Metadata getURLMetadata()
      Gets the metadata for a program url.
      Returns:
      metadata for the url
      Compliance:
      mandatory - This method must be implemented.

    • setURL

      void setURL(String url)
      Sets the url for a program web site.
      Parameters:
      url - the new url
      Throws:
      InvalidArgumentException - url is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - url is null
      Compliance:
      mandatory - This method must be implemented.

    • clearURL

      void clearURL()
      Removes the url.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getProgramOfferingFormRecord

      ProgramOfferingFormRecord getProgramOfferingFormRecord(Type programOfferingRecordType) throws OperationFailedException
      Gets the ProgramOfferingFormRecord corresponding to the given program offering record Type.
      Parameters:
      programOfferingRecordType - a program offering record type
      Returns:
      the program offering form record
      Throws:
      NullArgumentException - programOfferingRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(programOfferingRecordType) is false
      Compliance:
      mandatory - This method must be implemented.