public interface ParameterForm extends OsidRuleForm
This is the form for creating and updating Parameters.
Various data elements may be set here for use in the create and update
methods in the ParameterAdminSession.
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 |
clearValueCoordinateType()
Clears the coordinate type.
|
void |
clearValueHeadingType()
Clears the heading type.
|
void |
clearValueObjectType()
Clears the object value type.
|
void |
clearValueSpatialUnitRecordType()
Clears the spatial unit record type.
|
void |
clearValuesShuffled()
Clears the shuffle flag.
|
void |
clearValueSyntax()
Clears the value syntax.
|
void |
clearValueVersionScheme()
Clears the version value type.
|
ParameterFormRecord |
getParameterFormRecord(Type parameterRecordType)
Gets the
ParameterFormRecord corresponding to the given
parameter record Type. |
Metadata |
getValueCoordinateTypeMetadata()
Gets the metadata for the coordinate type for coordinate values.
|
Metadata |
getValueHeadingTypeMetadata()
Gets the metadata for the heading type for coordinate values.
|
Metadata |
getValueObjectTypeMetadata()
Gets the metadata for the object value type for object values.
|
Metadata |
getValueSpatialUnitRecordTypeMetadata()
Gets the metadata for the spatial unit record type for coordinate
values.
|
Metadata |
getValuesShuffledMetadata()
Gets the metadata for the shuffle type.
|
Metadata |
getValueSyntaxMetadata()
Gets the metadata for the value syntax.
|
Metadata |
getValueVersionSchemeMetadata()
Gets the metadata for the version type for object values.
|
void |
setValueCoordinateType(Type coordinateType)
Sets a coordinate type.
|
void |
setValueHeadingType(Type headingType)
Sets a heading type.
|
void |
setValueObjectType(Type objectType)
Sets an object value type.
|
void |
setValueSpatialUnitRecordType(Type spatialUnitRecordType)
Sets a spatial unit record type.
|
void |
setValuesShuffled(boolean shuffle)
Sets the shuffle order.
|
void |
setValueSyntax(Syntax syntax)
Sets a value syntax.
|
void |
setValueVersionScheme(Type versionType)
Sets a version type.
|
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 getValueSyntaxMetadata()
mandatory
- This method must be implemented. void setValueSyntax(Syntax syntax)
syntax
- the new value typeInvalidArgumentException
- syntax
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- syntax
is
null
mandatory
- This method must be implemented. void clearValueSyntax()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly() is true
mandatory
- This method must be implemented. Metadata getValueCoordinateTypeMetadata()
mandatory
- This method must be implemented. void setValueCoordinateType(Type coordinateType)
coordinateType
- the new coordinate typeInvalidArgumentException
- coordinateType
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- coordinateType
is null
mandatory
- This method must be implemented. void clearValueCoordinateType()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly() is true
mandatory
- This method must be implemented. Metadata getValueHeadingTypeMetadata()
mandatory
- This method must be implemented. void setValueHeadingType(Type headingType)
headingType
- the new heading typeInvalidArgumentException
- headingType
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- headingType
is
null
mandatory
- This method must be implemented. void clearValueHeadingType()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly() is true
mandatory
- This method must be implemented. Metadata getValueObjectTypeMetadata()
mandatory
- This method must be implemented. void setValueObjectType(Type objectType)
objectType
- the new object typeInvalidArgumentException
- objectType
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- objectType
is
null
mandatory
- This method must be implemented. void clearValueObjectType()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly() is true
mandatory
- This method must be implemented. Metadata getValueSpatialUnitRecordTypeMetadata()
mandatory
- This method must be implemented. void setValueSpatialUnitRecordType(Type spatialUnitRecordType)
spatialUnitRecordType
- the new spatial unit record typeInvalidArgumentException
- spatialUnitRecordType
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- spatialUnitRecordType
is null
mandatory
- This method must be implemented. void clearValueSpatialUnitRecordType()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly() is true
mandatory
- This method must be implemented. Metadata getValueVersionSchemeMetadata()
mandatory
- This method must be implemented. void setValueVersionScheme(Type versionType)
versionType
- the new version typeInvalidArgumentException
- versionType
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- versionType
is
null
mandatory
- This method must be implemented. void clearValueVersionScheme()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly() is true
mandatory
- This method must be implemented. Metadata getValuesShuffledMetadata()
mandatory
- This method must be implemented. void setValuesShuffled(boolean shuffle)
shuffle
- true
to shuffle values by weight,
false
to order values by indexInvalidArgumentException
- shuffle
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearValuesShuffled()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly() is true
mandatory
- This method must be implemented. ParameterFormRecord getParameterFormRecord(Type parameterRecordType) throws OperationFailedException
ParameterFormRecord
corresponding to the given
parameter record Type.
parameterRecordType
- a parameter record typeNullArgumentException
- parameterRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(parameterRecordType)
is false
mandatory
- This method must be implemented.