public interface DemographicForm extends OsidRuleForm
This is the form for creating and updating Demographics.
Like all OsidForm
objects, various data elements may be set
here for use in the create and update methods in the
DemographicAdminSession.
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 |
clearExcludedDemographics()
Removes the excluded demographics.
|
void |
clearExcludedResources()
Removes the excluded resources.
|
void |
clearIncludedDemographics()
Removes the included demographics.
|
void |
clearIncludedExclusiveDemographics()
Removes the included exclusive demographics.
|
void |
clearIncludedIntersectingDemographics()
Removes the included intersecting demographics.
|
void |
clearIncludedResource()
Removes the included resources.
|
DemographicFormRecord |
getDemographicFormRecord(Type demographicRecordType)
Gets the
DemographicFormRecord corresponding to the
given demographic record Type. |
Metadata |
getExcludedDemographicsMetadata()
Gets the metadata for the excluded demographics.
|
Metadata |
getExcludedResourceMetadata()
Gets the metadata for the excluded resources.
|
Metadata |
getIncludedDemographicsMetadata()
Gets the metadata for the included demographics.
|
Metadata |
getIncludedExclusiveDemographicsMetadata()
Gets the metadata for the included exclusive demographics.
|
Metadata |
getIncludedIntersectingDemographicsMetadata()
Gets the metadata for the included intersecting demographics.
|
Metadata |
getIncludedResourceMetadata()
Gets the metadata for the included resources.
|
void |
setExcludedDemographics(Id[] demographicIds)
Sets the excluded demographics.
|
void |
setExcludedResources(Id[] resourceIds)
Sets the excluded resources.
|
void |
setIncludedDemographics(Id[] demographicIds)
Sets the included demographics.
|
void |
setIncludedExclusiveDemographics(Id[] demographicIds)
Sets the included exclusive demographics.
|
void |
setIncludedIntersectingDemographics(Id[] demographicIds)
Sets the included intersecting demographics.
|
void |
setIncludedResources(Id[] resourceIds)
Sets the included resources.
|
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 getIncludedDemographicsMetadata()
mandatory
- This method must be implemented. void setIncludedDemographics(Id[] demographicIds)
demographicIds
- the new included demographicsInvalidArgumentException
- demographicIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- demographicIds
is null
mandatory
- This method must be implemented. void clearIncludedDemographics()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getIncludedIntersectingDemographicsMetadata()
mandatory
- This method must be implemented. void setIncludedIntersectingDemographics(Id[] demographicIds)
demographicIds
- the new included intersecting demographicsInvalidArgumentException
- demographicIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- demographicIds
is null
mandatory
- This method must be implemented. void clearIncludedIntersectingDemographics()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getIncludedExclusiveDemographicsMetadata()
mandatory
- This method must be implemented. void setIncludedExclusiveDemographics(Id[] demographicIds)
demographicIds
- the new included exclusive demographicsInvalidArgumentException
- demographicIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- demographicIds
is null
mandatory
- This method must be implemented. void clearIncludedExclusiveDemographics()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getExcludedDemographicsMetadata()
mandatory
- This method must be implemented. void setExcludedDemographics(Id[] demographicIds)
demographicIds
- the new excluded demographicsInvalidArgumentException
- demographicIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- demographicIds
is null
mandatory
- This method must be implemented. void clearExcludedDemographics()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getIncludedResourceMetadata()
mandatory
- This method must be implemented. void setIncludedResources(Id[] resourceIds)
resourceIds
- the new included resourcesInvalidArgumentException
- resourceIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- resourceIds
is
null
mandatory
- This method must be implemented. void clearIncludedResource()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getExcludedResourceMetadata()
mandatory
- This method must be implemented. void setExcludedResources(Id[] resourceIds)
resourceIds
- the new excluded resourcesInvalidArgumentException
- resourceIds
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- resourceIds
is
null
mandatory
- This method must be implemented. void clearExcludedResources()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. DemographicFormRecord getDemographicFormRecord(Type demographicRecordType) throws OperationFailedException
DemographicFormRecord
corresponding to the
given demographic record Type.
demographicRecordType
- a demographic record typeNullArgumentException
- demographicRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(demographicRecordType)
is false
mandatory
- This method must be implemented.