OSID - osid.resource.demographic.Demographic Service Interface Definition

Interface	osid.resource.demographic.Demographic
Implements	`osid.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.
Method	getIncludedDemographicIds
Description	Gets a list of `Demographic` `Ids` whose members are added to this demographic. The union of these demographics is added to this demographic.
Return	`osid.id.IdList`		the demographic `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getIncludedDemographics
Description	Gets a list of `Demographics` whose members are added to this demographic. The union of these demographics is added to this demographic.
Return	`osid.resource.demographic.DemographicList`		the demographics
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getIncludedIntersectingDemographicIds
Description	Gets a list of `Demographic` `Ids` whose intersection is added to this demographic. The intersection of these demographics is added to this demographic.
Return	`osid.id.IdList`		the intersecting demographic `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getIncludedIntersectingDemographics
Description	Gets a list of `Demographics` whose intersection is added to this demographic. The intersection of these demographics is added to this demographic.
Return	`osid.resource.demographic.DemographicList`		the intersecting demographics
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getIncludedExclusiveDemographicIds
Description	Gets a list of `Demographic` `Ids` whose non-members are added to this demographic.
Return	`osid.id.IdList`		the exclusive demographic `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getIncludedExclusiveDemographics
Description	Gets a list of `Demographics` whose non-members are added to this demographic.
Return	`osid.resource.demographic.DemographicList`		the exclusive demographics
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getExcludedDemographicIds
Description	Gets a list of `Demographic` `Ids` whose members are subtracted from in this demographic.
Return	`osid.id.IdList`		the excluded demographic `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getExcludedDemographics
Description	Gets a list of `Demographics` whose members subtracted from this demographic.
Return	`osid.resource.demographic.DemographicList`		the excluded demographics
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getIncludedResourceIds
Description	Gets a list of individual `Resource` `Ids` to be added to this demographic.
Return	`osid.id.IdList`		the included resource `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getIncludedResources
Description	Gets a list of individual `Resources` to be added to this demographic.
Return	`osid.resource.ResourceList`		the included resources
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getExcludedResourceIds
Description	Gets a list of `Resource` `Ids` to be subtracted from this demographic.
Return	`osid.id.IdList`		the excluded resource `Ids`
Compliance	`mandatory`		This method must be implemented.
Method	getExcludedResources
Description	Gets a list of `Resources` to be subtracted from this demographic.
Return	`osid.resource.ResourceList`		the exempted resource
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicRecord
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` .
Parameters	`osid.type.Type`	`demographicRecordType`	the type of demographic record to retrieve
Return	`osid.resource.demographic.records.DemographicRecord`		the demographic 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.