org.osid.resource.demographic

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 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.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

Methods inherited from interface org.osid.OsidObjectForm

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

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

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

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Method Detail

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.

getIncludedResourceMetadata

Metadata getIncludedResourceMetadata()

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.

getExcludedResourceMetadata

Metadata getExcludedResourceMetadata()

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.