OSID Logo
OSID Specifications
resource demographic package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.demographic.Demographic
Implementsosid.OsidRule
Description

A Demographic is an OsidRule for building demographics of Resources . A demographic is the resource query plus the included demographics plus the intersecting demographics plus the included resources minus the exempted demographics minus the excluded resources. Demographic genus type may be used to provide alternate equations.

MethodgetIncludedDemographicIds
Description

Gets a list of Demographic Ids whose members are added to this demographic. The union of these demographics is added to this demographic.

Returnosid.id.IdListthe demographic Ids
CompliancemandatoryThis method must be implemented.
MethodgetIncludedDemographics
Description

Gets a list of Demographics whose members are added to this demographic. The union of these demographics is added to this demographic.

Returnosid.resource.demographic.DemographicListthe demographics
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetIncludedIntersectingDemographicIds
Description

Gets a list of Demographic Ids whose intersection is added to this demographic. The intersection of these demographics is added to this demographic.

Returnosid.id.IdListthe intersecting demographic Ids
CompliancemandatoryThis method must be implemented.
MethodgetIncludedIntersectingDemographics
Description

Gets a list of Demographics whose intersection is added to this demographic. The intersection of these demographics is added to this demographic.

Returnosid.resource.demographic.DemographicListthe intersecting demographics
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetIncludedExclusiveDemographicIds
Description

Gets a list of Demographic Ids whose non-members are added to this demographic.

Returnosid.id.IdListthe exclusive demographic Ids
CompliancemandatoryThis method must be implemented.
MethodgetIncludedExclusiveDemographics
Description

Gets a list of Demographics whose non-members are added to this demographic.

Returnosid.resource.demographic.DemographicListthe exclusive demographics
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetExcludedDemographicIds
Description

Gets a list of Demographic Ids whose members are subtracted from in this demographic.

Returnosid.id.IdListthe excluded demographic Ids
CompliancemandatoryThis method must be implemented.
MethodgetExcludedDemographics
Description

Gets a list of Demographics whose members subtracted from this demographic.

Returnosid.resource.demographic.DemographicListthe excluded demographics
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetIncludedResourceIds
Description

Gets a list of individual Resource Ids to be added to this demographic.

Returnosid.id.IdListthe included resource Ids
CompliancemandatoryThis method must be implemented.
MethodgetIncludedResources
Description

Gets a list of individual Resources to be added to this demographic.

Returnosid.resource.ResourceListthe included resources
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetExcludedResourceIds
Description

Gets a list of Resource Ids to be subtracted from this demographic.

Returnosid.id.IdListthe excluded resource Ids
CompliancemandatoryThis method must be implemented.
MethodgetExcludedResources
Description

Gets a list of Resources to be subtracted from this demographic.

Returnosid.resource.ResourceListthe exempted resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetDemographicRecord
Description

Gets the demographic record corresponding to the given Demographic record Type. This method is used to retrieve an object implementing the requested record. The demographicRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(demographicRecordType) is true .

Parametersosid.type.TypedemographicRecordTypethe type of demographic record to retrieve
Returnosid.resource.demographic.records.DemographicRecordthe demographic record
ErrorsNULL_ARGUMENT demographicRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(demographicRecordType) is false
CompliancemandatoryThis method must be implemented.