OSID Logo
OSID Specifications
offering rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.offering.rules.OfferingConstrainerForm
Implementsosid.OsidConstrainerForm
Description

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.

MethodgetOverrideDescriptionMetadata
Description

Gets the metadata for the override description flag.

Returnosid.Metadatametadata for the override description flag
CompliancemandatoryThis method must be implemented.
MethodsetOverrideDescription
Description

Sets the overrride description flag.

ParametersbooleanoverrideDescriptionthe override description flag
ErrorsINVALID_ARGUMENT overrideDescription is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearOverrideDescription
Description

Clears the override description flag.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetOverrideTitleMetadata
Description

Gets the metadata for the override title flag.

Returnosid.Metadatametadata for the override title flag
CompliancemandatoryThis method must be implemented.
MethodsetOverrideTitle
Description

Sets the overrride title flag.

ParametersbooleanoverrideTitlethe override title flag
ErrorsINVALID_ARGUMENT overrideTitlen is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearOverrideTitle
Description

Clears the override title flag.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetOverrideCodeMetadata
Description

Gets the metadata for the override code flag.

Returnosid.Metadatametadata for the override code flag
CompliancemandatoryThis method must be implemented.
MethodsetOverrideCode
Description

Sets the overrride code flag.

ParametersbooleanoverrideCodethe override code flag
ErrorsINVALID_ARGUMENT overrideCode is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearOverrideCode
Description

Clears the override time periods flag.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetOverrideTimePeriodsMetadata
Description

Gets the metadata for the override time periods flag.

Returnosid.Metadatametadata for the override time periods flag
CompliancemandatoryThis method must be implemented.
MethodsetOverrideTimePeriods
Description

Sets the overrride time periods flag.

ParametersbooleanoverrideTimePeriodsthe override time periods flag
ErrorsINVALID_ARGUMENT overrideTimePeriods is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearOverrideTimePeriods
Description

Clears the override time periods flag.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetConstrainTimePeriodsMetadata
Description

Gets the metadata for the constrain time periods flag.

Returnosid.Metadatametadata for the constrain time periods flag
CompliancemandatoryThis method must be implemented.
MethodsetConstrainTimePeriods
Description

Sets the constrain time periods flag.

ParametersbooleanconstrainTimePeriodsthe constrain time periods flag
ErrorsINVALID_ARGUMENT constrainTimePeriods is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearConstrainTimePeriods
Description

Clears the constrain time periods flag.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetOverrideResultOptionsMetadata
Description

Gets the metadata for the override result options flag.

Returnosid.Metadatametadata for the override result options flag
CompliancemandatoryThis method must be implemented.
MethodsetOverrideResultOptions
Description

Sets the overrride result options flag.

ParametersbooleanoverrideResultOptionsthe override result options flag
ErrorsINVALID_ARGUMENT overrideResultOptions is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearResultOptions
Description

Clears the override result options flag.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetConstrainResultOptionsMetadata
Description

Gets the metadata for the constrain result options flag.

Returnosid.Metadatametadata for the constrain result options flag
CompliancemandatoryThis method must be implemented.
MethodsetConstrainResultOptions
Description

Sets the constrain result options flag.

ParametersbooleanconstrainResultOptionsthe constrain result options flag
ErrorsINVALID_ARGUMENT constrainResultOptions is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearConstrainResultOptions
Description

Clears the constrain result options flag.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetOverrideSponsorsMetadata
Description

Gets the metadata for the override sponsors flag.

Returnosid.Metadatametadata for the override sponsors flag
CompliancemandatoryThis method must be implemented.
MethodsetOverrideSponsors
Description

Sets the overrride sponsors flag.

ParametersbooleanoverrideSponsorsthe override sponsors flag
ErrorsINVALID_ARGUMENT overrideSponsors is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearSponsors
Description

Clears the override sponsors flag.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetConstrainSponsorsMetadata
Description

Gets the metadata for the constrain sponsors flag.

Returnosid.Metadatametadata for the constrain sponsors flag
CompliancemandatoryThis method must be implemented.
MethodsetConstrainSponsors
Description

Sets the constrain sponsors flag.

ParametersbooleanconstrainSponsorsthe constrain sponsors flag
ErrorsINVALID_ARGUMENT constrainSponsors is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearConstrainSponsors
Description

Clears the constrain sponsors flag.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetOfferingConstrainerFormRecord
Description

Gets the OfferingConstrainerFormRecord corresponding to the given offering constrainer record Type.

Parametersosid.type.TypeofferingConstrainerRecordTypean offering constrainer record type
Returnosid.offering.rules.records.OfferingConstrainerFormRecordthe offering constrainer form record
ErrorsNULL_ARGUMENT offeringConstrainerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(offeringConstrainerRecordType) is false
CompliancemandatoryThis method must be implemented.