OSID Logo
OSID Specifications
resource demographic package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.demographic.DemographicForm
Implementsosid.OsidRuleForm
Description

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.

MethodgetIncludedDemographicsMetadata
Description

Gets the metadata for the included demographics.

Returnosid.Metadatametadata for the included demographics
CompliancemandatoryThis method must be implemented.
MethodsetIncludedDemographics
Description

Sets the included demographics.

Parametersosid.id.Id[]demographicIdsthe new included demographics
ErrorsINVALID_ARGUMENT demographicIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT demographicIds is null
CompliancemandatoryThis method must be implemented.
MethodclearIncludedDemographics
Description

Removes the included demographics.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetIncludedIntersectingDemographicsMetadata
Description

Gets the metadata for the included intersecting demographics.

Returnosid.Metadatametadata for the included intersecting demographics
CompliancemandatoryThis method must be implemented.
MethodsetIncludedIntersectingDemographics
Description

Sets the included intersecting demographics.

Parametersosid.id.Id[]demographicIdsthe new included intersecting demographics
ErrorsINVALID_ARGUMENT demographicIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT demographicIds is null
CompliancemandatoryThis method must be implemented.
MethodclearIncludedIntersectingDemographics
Description

Removes the included intersecting demographics.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetIncludedExclusiveDemographicsMetadata
Description

Gets the metadata for the included exclusive demographics.

Returnosid.Metadatametadata for the included exclusive demographics
CompliancemandatoryThis method must be implemented.
MethodsetIncludedExclusiveDemographics
Description

Sets the included exclusive demographics.

Parametersosid.id.Id[]demographicIdsthe new included exclusive demographics
ErrorsINVALID_ARGUMENT demographicIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT demographicIds is null
CompliancemandatoryThis method must be implemented.
MethodclearIncludedExclusiveDemographics
Description

Removes the included exclusive demographics.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetExcludedDemographicsMetadata
Description

Gets the metadata for the excluded demographics.

Returnosid.Metadatametadata for the excluded demographics
CompliancemandatoryThis method must be implemented.
MethodsetExcludedDemographics
Description

Sets the excluded demographics.

Parametersosid.id.Id[]demographicIdsthe new excluded demographics
ErrorsINVALID_ARGUMENT demographicIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT demographicIds is null
CompliancemandatoryThis method must be implemented.
MethodclearExcludedDemographics
Description

Removes the excluded demographics.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetIncludedResourceMetadata
Description

Gets the metadata for the included resources.

Returnosid.Metadatametadata for the included resources
CompliancemandatoryThis method must be implemented.
MethodsetIncludedResources
Description

Sets the included resources.

Parametersosid.id.Id[]resourceIdsthe new included resources
ErrorsINVALID_ARGUMENT resourceIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT resourceIds is null
CompliancemandatoryThis method must be implemented.
MethodclearIncludedResource
Description

Removes the included resources.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetExcludedResourceMetadata
Description

Gets the metadata for the excluded resources.

Returnosid.Metadatametadata for the excluded resources
CompliancemandatoryThis method must be implemented.
MethodsetExcludedResources
Description

Sets the excluded resources.

Parametersosid.id.Id[]resourceIdsthe new excluded resources
ErrorsINVALID_ARGUMENT resourceIds is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT resourceIds is null
CompliancemandatoryThis method must be implemented.
MethodclearExcludedResources
Description

Removes the excluded resources.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetDemographicFormRecord
Description

Gets the DemographicFormRecord corresponding to the given demographic record Type.

Parametersosid.type.TypedemographicRecordTypea demographic record type
Returnosid.resource.demographic.records.DemographicFormRecordthe demographic form record
ErrorsNULL_ARGUMENT demographicRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(demographicRecordType) is false
CompliancemandatoryThis method must be implemented.