Interface DemographicForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable

public interface DemographicForm
extends OsidRuleForm

This is the form for creating and updating Demographics. Like all OsidForms, 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.

Method Summary

Modifier and Type	Method	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	getExcludedResourcesMetadata()	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	getIncludedResourcesMetadata()	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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Modifier and Type	Method	Description
void	clearDisabled()	Removes the administratively disabled flag.
void	clearEnabled()	Removes the administratively enabled flag.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled flag.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled flag.
void	setDisabled(boolean disabled)	Sets the administratively disabled flag.
void	setEnabled(boolean enabled)	Sets the administratively enabled flag.

Methods inherited from interface OsidRuleForm

clearConditionRecordTypes, clearRule, getConditionRecordTypesMetadata, getRuleMetadata, setConditionRecordTypes, setRule

Modifier and Type	Method	Description
void	clearConditionRecordTypes()	Clears the condition record types.
void	clearRule()	Removes the rule.
Metadata	getConditionRecordTypesMetadata()	Gets the metadata for the condition record types.
Metadata	getRuleMetadata()	Gets the metadata for an associated rule.
void	setConditionRecordTypes(Type[] conditionRecordTypes)	Sets the condition record types.
void	setRule(Id ruleId)	Sets a rule.

Method Details

getIncludedDemographicsMetadata

Metadata getIncludedDemographicsMetadata()

Gets the metadata for the included demographics.

Returns:

metadata for the included demographics

Compliance:

mandatory - This method must be implemented.

setIncludedDemographics

void setIncludedDemographics(Id[] demographicIds)

Sets the included demographics.

Parameters:

demographicIds - the new included demographics

Throws:

InvalidArgumentException - demographicIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - demographicIds is null

Compliance:

mandatory - This method must be implemented.

clearIncludedDemographics

void clearIncludedDemographics()

Removes the included demographics.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getIncludedIntersectingDemographicsMetadata

Metadata getIncludedIntersectingDemographicsMetadata()

Gets the metadata for the included intersecting demographics.

Returns:

metadata for the included intersecting demographics

Compliance:

mandatory - This method must be implemented.

setIncludedIntersectingDemographics

void setIncludedIntersectingDemographics(Id[] demographicIds)

Sets the included intersecting demographics.

Parameters:

demographicIds - the new included intersecting demographics

Throws:

InvalidArgumentException - demographicIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - demographicIds is null

Compliance:

mandatory - This method must be implemented.

clearIncludedIntersectingDemographics

void clearIncludedIntersectingDemographics()

Removes the included intersecting demographics.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getIncludedExclusiveDemographicsMetadata

Metadata getIncludedExclusiveDemographicsMetadata()

Gets the metadata for the included exclusive demographics.

Returns:

metadata for the included exclusive demographics

Compliance:

mandatory - This method must be implemented.

setIncludedExclusiveDemographics

void setIncludedExclusiveDemographics(Id[] demographicIds)

Sets the included exclusive demographics.

Parameters:

demographicIds - the new included exclusive demographics

Throws:

InvalidArgumentException - demographicIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - demographicIds is null

Compliance:

mandatory - This method must be implemented.

clearIncludedExclusiveDemographics

void clearIncludedExclusiveDemographics()

Removes the included exclusive demographics.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getExcludedDemographicsMetadata

Metadata getExcludedDemographicsMetadata()

Gets the metadata for the excluded demographics.

Returns:

metadata for the excluded demographics

Compliance:

mandatory - This method must be implemented.

setExcludedDemographics

void setExcludedDemographics(Id[] demographicIds)

Sets the excluded demographics.

Parameters:

demographicIds - the new excluded demographics

Throws:

InvalidArgumentException - demographicIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - demographicIds is null

Compliance:

mandatory - This method must be implemented.

clearExcludedDemographics

void clearExcludedDemographics()

Removes the excluded demographics.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getIncludedResourcesMetadata

Metadata getIncludedResourcesMetadata()

Gets the metadata for the included resources.

Returns:

metadata for the included resources

Compliance:

mandatory - This method must be implemented.

setIncludedResources

void setIncludedResources(Id[] resourceIds)

Sets the included resources.

Parameters:

resourceIds - the new included resources

Throws:

InvalidArgumentException - resourceIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceIds is null

Compliance:

mandatory - This method must be implemented.

clearIncludedResource

void clearIncludedResource()

Removes the included resources.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getExcludedResourcesMetadata

Metadata getExcludedResourcesMetadata()

Gets the metadata for the excluded resources.

Returns:

metadata for the excluded resources

Compliance:

mandatory - This method must be implemented.

setExcludedResources

void setExcludedResources(Id[] resourceIds)

Sets the excluded resources.

Parameters:

resourceIds - the new excluded resources

Throws:

InvalidArgumentException - resourceIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceIds is null

Compliance:

mandatory - This method must be implemented.

clearExcludedResources

void clearExcludedResources()

Removes the excluded resources.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getDemographicFormRecord

DemographicFormRecord getDemographicFormRecord(Type demographicRecordType)
                                        throws OperationFailedException

Gets the DemographicFormRecord corresponding to the given demographic record Type.

Parameters:

demographicRecordType - a demographic record type

Returns:

the demographic form record

Throws:

NullArgumentException - demographicRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(demographicRecordType) is false

Compliance:

mandatory - This method must be implemented.