public interface OfferingConstrainerForm extends OsidConstrainerForm
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.
Modifier and Type | Method and Description |
---|---|
void |
clearConstrainResultOptions()
Clears the constrain result options flag.
|
void |
clearConstrainSponsors()
Clears the constrain sponsors flag.
|
void |
clearConstrainTimePeriods()
Clears the constrain time periods flag.
|
void |
clearOverrideCode()
Clears the override time periods flag.
|
void |
clearOverrideDescription()
Clears the override description flag.
|
void |
clearOverrideTimePeriods()
Clears the override time periods flag.
|
void |
clearOverrideTitle()
Clears the override title flag.
|
void |
clearResultOptions()
Clears the override result options flag.
|
void |
clearSponsors()
Clears the override sponsors flag.
|
Metadata |
getConstrainResultOptionsMetadata()
Gets the metadata for the constrain result options flag.
|
Metadata |
getConstrainSponsorsMetadata()
Gets the metadata for the constrain sponsors flag.
|
Metadata |
getConstrainTimePeriodsMetadata()
Gets the metadata for the constrain time periods flag.
|
OfferingConstrainerFormRecord |
getOfferingConstrainerFormRecord(Type offeringConstrainerRecordType)
Gets the
OfferingConstrainerFormRecord corresponding to
the given offering constrainer record Type. |
Metadata |
getOverrideCodeMetadata()
Gets the metadata for the override code flag.
|
Metadata |
getOverrideDescriptionMetadata()
Gets the metadata for the override description flag.
|
Metadata |
getOverrideResultOptionsMetadata()
Gets the metadata for the override result options flag.
|
Metadata |
getOverrideSponsorsMetadata()
Gets the metadata for the override sponsors flag.
|
Metadata |
getOverrideTimePeriodsMetadata()
Gets the metadata for the override time periods flag.
|
Metadata |
getOverrideTitleMetadata()
Gets the metadata for the override title flag.
|
void |
setConstrainResultOptions(boolean constrainResultOptions)
Sets the constrain result options flag.
|
void |
setConstrainSponsors(boolean constrainSponsors)
Sets the constrain sponsors flag.
|
void |
setConstrainTimePeriods(boolean constrainTimePeriods)
Sets the constrain time periods flag.
|
void |
setOverrideCode(boolean overrideCode)
Sets the overrride code flag.
|
void |
setOverrideDescription(boolean overrideDescription)
Sets the overrride description flag.
|
void |
setOverrideResultOptions(boolean overrideResultOptions)
Sets the overrride result options flag.
|
void |
setOverrideSponsors(boolean overrideSponsors)
Sets the overrride sponsors flag.
|
void |
setOverrideTimePeriods(boolean overrideTimePeriods)
Sets the overrride time periods flag.
|
void |
setOverrideTitle(boolean overrideTitle)
Sets the overrride title flag.
|
clearRule, getRuleMetadata, setRule
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled
Metadata getOverrideDescriptionMetadata()
mandatory
- This method must be implemented. void setOverrideDescription(boolean overrideDescription)
overrideDescription
- the override description flagInvalidArgumentException
- overrideDescription
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearOverrideDescription()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getOverrideTitleMetadata()
mandatory
- This method must be implemented. void setOverrideTitle(boolean overrideTitle)
overrideTitle
- the override title flagInvalidArgumentException
- overrideTitlen
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearOverrideTitle()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getOverrideCodeMetadata()
mandatory
- This method must be implemented. void setOverrideCode(boolean overrideCode)
overrideCode
- the override code flagInvalidArgumentException
- overrideCode
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearOverrideCode()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getOverrideTimePeriodsMetadata()
mandatory
- This method must be implemented. void setOverrideTimePeriods(boolean overrideTimePeriods)
overrideTimePeriods
- the override time periods flagInvalidArgumentException
- overrideTimePeriods
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearOverrideTimePeriods()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getConstrainTimePeriodsMetadata()
mandatory
- This method must be implemented. void setConstrainTimePeriods(boolean constrainTimePeriods)
constrainTimePeriods
- the constrain time periods flagInvalidArgumentException
- constrainTimePeriods
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearConstrainTimePeriods()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getOverrideResultOptionsMetadata()
mandatory
- This method must be implemented. void setOverrideResultOptions(boolean overrideResultOptions)
overrideResultOptions
- the override result options flagInvalidArgumentException
- overrideResultOptions
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearResultOptions()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getConstrainResultOptionsMetadata()
mandatory
- This method must be implemented. void setConstrainResultOptions(boolean constrainResultOptions)
constrainResultOptions
- the constrain result options flagInvalidArgumentException
-
constrainResultOptions
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearConstrainResultOptions()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getOverrideSponsorsMetadata()
mandatory
- This method must be implemented. void setOverrideSponsors(boolean overrideSponsors)
overrideSponsors
- the override sponsors flagInvalidArgumentException
- overrideSponsors
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearSponsors()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getConstrainSponsorsMetadata()
mandatory
- This method must be implemented. void setConstrainSponsors(boolean constrainSponsors)
constrainSponsors
- the constrain sponsors flagInvalidArgumentException
- constrainSponsors
is invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearConstrainSponsors()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. OfferingConstrainerFormRecord getOfferingConstrainerFormRecord(Type offeringConstrainerRecordType) throws OperationFailedException
OfferingConstrainerFormRecord
corresponding to
the given offering constrainer record Type.
offeringConstrainerRecordType
- an offering constrainer record
typeNullArgumentException
-
offeringConstrainerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(offeringConstrainerRecordType)
is
false
mandatory
- This method must be implemented.