Interface | osid.resource.demographic.DemographicForm | ||
---|---|---|---|
Implements | osid.OsidRuleForm | ||
Description |
This is the form for creating and updating | ||
Method | getIncludedDemographicsMetadata | ||
Description |
Gets the metadata for the included demographics. | ||
Return | osid.Metadata | metadata for the included demographics | |
Compliance | mandatory | This method must be implemented. | |
Method | setIncludedDemographics | ||
Description |
Sets the included demographics. | ||
Parameters | osid.id.Id[] | demographicIds | the new included demographics |
Errors | INVALID_ARGUMENT | demographicIds is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | demographicIds is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearIncludedDemographics | ||
Description |
Removes the included demographics. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getIncludedIntersectingDemographicsMetadata | ||
Description |
Gets the metadata for the included intersecting demographics. | ||
Return | osid.Metadata | metadata for the included intersecting demographics | |
Compliance | mandatory | This method must be implemented. | |
Method | setIncludedIntersectingDemographics | ||
Description |
Sets the included intersecting demographics. | ||
Parameters | osid.id.Id[] | demographicIds | the new included intersecting demographics |
Errors | INVALID_ARGUMENT | demographicIds is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | demographicIds is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearIncludedIntersectingDemographics | ||
Description |
Removes the included intersecting demographics. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getIncludedExclusiveDemographicsMetadata | ||
Description |
Gets the metadata for the included exclusive demographics. | ||
Return | osid.Metadata | metadata for the included exclusive demographics | |
Compliance | mandatory | This method must be implemented. | |
Method | setIncludedExclusiveDemographics | ||
Description |
Sets the included exclusive demographics. | ||
Parameters | osid.id.Id[] | demographicIds | the new included exclusive demographics |
Errors | INVALID_ARGUMENT | demographicIds is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | demographicIds is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearIncludedExclusiveDemographics | ||
Description |
Removes the included exclusive demographics. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getExcludedDemographicsMetadata | ||
Description |
Gets the metadata for the excluded demographics. | ||
Return | osid.Metadata | metadata for the excluded demographics | |
Compliance | mandatory | This method must be implemented. | |
Method | setExcludedDemographics | ||
Description |
Sets the excluded demographics. | ||
Parameters | osid.id.Id[] | demographicIds | the new excluded demographics |
Errors | INVALID_ARGUMENT | demographicIds is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | demographicIds is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearExcludedDemographics | ||
Description |
Removes the excluded demographics. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getIncludedResourceMetadata | ||
Description |
Gets the metadata for the included resources. | ||
Return | osid.Metadata | metadata for the included resources | |
Compliance | mandatory | This method must be implemented. | |
Method | setIncludedResources | ||
Description |
Sets the included resources. | ||
Parameters | osid.id.Id[] | resourceIds | the new included resources |
Errors | INVALID_ARGUMENT | resourceIds is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | resourceIds is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearIncludedResource | ||
Description |
Removes the included resources. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getExcludedResourceMetadata | ||
Description |
Gets the metadata for the excluded resources. | ||
Return | osid.Metadata | metadata for the excluded resources | |
Compliance | mandatory | This method must be implemented. | |
Method | setExcludedResources | ||
Description |
Sets the excluded resources. | ||
Parameters | osid.id.Id[] | resourceIds | the new excluded resources |
Errors | INVALID_ARGUMENT | resourceIds is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | resourceIds is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearExcludedResources | ||
Description |
Removes the excluded resources. | ||
Errors | NO_ACCESS | Metadata.isRequired() is true or
Metadata.isReadOnly() is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getDemographicFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | demographicRecordType | a demographic record type |
Return | osid.resource.demographic.records.DemographicFormRecord | the demographic form record | |
Errors | NULL_ARGUMENT | demographicRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(demographicRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |