org.osid.resource.demographic

Interface Demographic

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidObject, OsidRule

public interface Demographic
extends OsidRule

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 Summary

Methods

Modifier and Type	Method and Description
DemographicRecord	getDemographicRecord(Type demographicRecordType) Gets the demographic record corresponding to the given Demographic record Type.
IdList	getExcludedDemographicIds() Gets a list of Demographic Ids whose members are subtracted from in this demographic.
DemographicList	getExcludedDemographics() Gets a list of Demographics whose members subtracted from this demographic.
IdList	getExcludedResourceIds() Gets a list of Resource Ids to be subtracted from this demographic.
ResourceList	getExcludedResources() Gets a list of Resources to be subtracted from this demographic.
IdList	getIncludedDemographicIds() Gets a list of Demographic Ids whose members are added to this demographic.
DemographicList	getIncludedDemographics() Gets a list of Demographics whose members are added to this demographic.
IdList	getIncludedExclusiveDemographicIds() Gets a list of Demographic Ids whose non-members are added to this demographic.
DemographicList	getIncludedExclusiveDemographics() Gets a list of Demographics whose non-members are added to this demographic.
IdList	getIncludedIntersectingDemographicIds() Gets a list of Demographic Ids whose intersection is added to this demographic.
DemographicList	getIncludedIntersectingDemographics() Gets a list of Demographics whose intersection is added to this demographic.
IdList	getIncludedResourceIds() Gets a list of individual Resource Ids to be added to this demographic.
ResourceList	getIncludedResources() Gets a list of individual Resources to be added to this demographic.

Methods inherited from interface org.osid.OsidRule

getRule, getRuleId, hasRule

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Method Detail

getIncludedDemographicIds

IdList getIncludedDemographicIds()

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

Returns:

the demographic Ids

Compliance:

mandatory - This method must be implemented.

getIncludedDemographics

DemographicList getIncludedDemographics()
                                        throws OperationFailedException

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

Returns:

the demographics

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getIncludedIntersectingDemographicIds

IdList getIncludedIntersectingDemographicIds()

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

Returns:

the intersecting demographic Ids

Compliance:

mandatory - This method must be implemented.

getIncludedIntersectingDemographics

DemographicList getIncludedIntersectingDemographics()
                                                    throws OperationFailedException

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

Returns:

the intersecting demographics

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getIncludedExclusiveDemographicIds

IdList getIncludedExclusiveDemographicIds()

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

Returns:

the exclusive demographic Ids

Compliance:

mandatory - This method must be implemented.

getIncludedExclusiveDemographics

DemographicList getIncludedExclusiveDemographics()
                                                 throws OperationFailedException

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

Returns:

the exclusive demographics

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getExcludedDemographicIds

IdList getExcludedDemographicIds()

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

Returns:

the excluded demographic Ids

Compliance:

mandatory - This method must be implemented.

getExcludedDemographics

DemographicList getExcludedDemographics()
                                        throws OperationFailedException

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

Returns:

the excluded demographics

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getIncludedResourceIds

IdList getIncludedResourceIds()

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

Returns:

the included resource Ids

Compliance:

mandatory - This method must be implemented.

getIncludedResources

ResourceList getIncludedResources()
                                  throws OperationFailedException

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

Returns:

the included resources

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getExcludedResourceIds

IdList getExcludedResourceIds()

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

Returns:

the excluded resource Ids

Compliance:

mandatory - This method must be implemented.

getExcludedResources

ResourceList getExcludedResources()
                                  throws OperationFailedException

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

Returns:

the exempted resource

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getDemographicRecord

DemographicRecord getDemographicRecord(Type demographicRecordType)
                                       throws OperationFailedException

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:

demographicRecordType - the type of demographic record to retrieve

Returns:

the demographic record

Throws:

NullArgumentException - demographicRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(demographicRecordType) is false

Compliance:

mandatory - This method must be implemented.