Interface OfferingConstrainerForm

All Superinterfaces:
OsidRecord
public interface OfferingConstrainerForm extends OsidRecord

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

  • Method Details

    • getOverrideDescriptionMetadata

      Metadata getOverrideDescriptionMetadata()
      Gets the metadata for the override description flag.
      Returns:
      metadata for the override description flag
      Compliance:
      mandatory - This method must be implemented.

    • setOverrideDescription

      void setOverrideDescription(boolean overrideDescription)
      Sets the overrride description flag.
      Parameters:
      overrideDescription - the override description flag
      Throws:
      InvalidArgumentException - overrideDescription is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearOverrideDescription

      void clearOverrideDescription()
      Clears the override description flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getOverrideTitleMetadata

      Metadata getOverrideTitleMetadata()
      Gets the metadata for the override title flag.
      Returns:
      metadata for the override title flag
      Compliance:
      mandatory - This method must be implemented.

    • setOverrideTitle

      void setOverrideTitle(boolean overrideTitle)
      Sets the overrride title flag.
      Parameters:
      overrideTitle - the override title flag
      Throws:
      InvalidArgumentException - overrideTitlen is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearOverrideTitle

      void clearOverrideTitle()
      Clears the override title flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getOverrideCodeMetadata

      Metadata getOverrideCodeMetadata()
      Gets the metadata for the override code flag.
      Returns:
      metadata for the override code flag
      Compliance:
      mandatory - This method must be implemented.

    • setOverrideCode

      void setOverrideCode(boolean overrideCode)
      Sets the overrride code flag.
      Parameters:
      overrideCode - the override code flag
      Throws:
      InvalidArgumentException - overrideCode is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearOverrideCode

      void clearOverrideCode()
      Clears the override time periods flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getOverrideTimePeriodsMetadata

      Metadata getOverrideTimePeriodsMetadata()
      Gets the metadata for the override time periods flag.
      Returns:
      metadata for the override time periods flag
      Compliance:
      mandatory - This method must be implemented.

    • setOverrideTimePeriods

      void setOverrideTimePeriods(boolean overrideTimePeriods)
      Sets the overrride time periods flag.
      Parameters:
      overrideTimePeriods - the override time periods flag
      Throws:
      InvalidArgumentException - overrideTimePeriods is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearOverrideTimePeriods

      void clearOverrideTimePeriods()
      Clears the override time periods flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getConstrainTimePeriodsMetadata

      Metadata getConstrainTimePeriodsMetadata()
      Gets the metadata for the constrain time periods flag.
      Returns:
      metadata for the constrain time periods flag
      Compliance:
      mandatory - This method must be implemented.

    • setConstrainTimePeriods

      void setConstrainTimePeriods(boolean constrainTimePeriods)
      Sets the constrain time periods flag.
      Parameters:
      constrainTimePeriods - the constrain time periods flag
      Throws:
      InvalidArgumentException - constrainTimePeriods is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearConstrainTimePeriods

      void clearConstrainTimePeriods()
      Clears the constrain time periods flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getOverrideResultOptionsMetadata

      Metadata getOverrideResultOptionsMetadata()
      Gets the metadata for the override result options flag.
      Returns:
      metadata for the override result options flag
      Compliance:
      mandatory - This method must be implemented.

    • setOverrideResultOptions

      void setOverrideResultOptions(boolean overrideResultOptions)
      Sets the overrride result options flag.
      Parameters:
      overrideResultOptions - the override result options flag
      Throws:
      InvalidArgumentException - overrideResultOptions is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearResultOptions

      void clearResultOptions()
      Clears the override result options flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getConstrainResultOptionsMetadata

      Metadata getConstrainResultOptionsMetadata()
      Gets the metadata for the constrain result options flag.
      Returns:
      metadata for the constrain result options flag
      Compliance:
      mandatory - This method must be implemented.

    • setConstrainResultOptions

      void setConstrainResultOptions(boolean constrainResultOptions)
      Sets the constrain result options flag.
      Parameters:
      constrainResultOptions - the constrain result options flag
      Throws:
      InvalidArgumentException - constrainResultOptions is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearConstrainResultOptions

      void clearConstrainResultOptions()
      Clears the constrain result options flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getOverrideSponsorsMetadata

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

    • setOverrideSponsors

      void setOverrideSponsors(boolean overrideSponsors)
      Sets the overrride sponsors flag.
      Parameters:
      overrideSponsors - the override sponsors flag
      Throws:
      InvalidArgumentException - overrideSponsors is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearSponsors

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

    • getConstrainSponsorsMetadata

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

    • setConstrainSponsors

      void setConstrainSponsors(boolean constrainSponsors)
      Sets the constrain sponsors flag.
      Parameters:
      constrainSponsors - the constrain sponsors flag
      Throws:
      InvalidArgumentException - constrainSponsors is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearConstrainSponsors

      void clearConstrainSponsors()
      Clears the constrain sponsors flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getOfferingConstrainerFormRecord

      OfferingConstrainerFormRecord getOfferingConstrainerFormRecord(Type offeringConstrainerRecordType) throws OperationFailedException
      Gets the OfferingConstrainerFormRecord corresponding to the given offering constrainer record Type.
      Parameters:
      offeringConstrainerRecordType - an offering constrainer record type
      Returns:
      the offering constrainer form record
      Throws:
      NullArgumentException - offeringConstrainerRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(offeringConstrainerRecordType) is false
      Compliance:
      mandatory - This method must be implemented.