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.
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. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
IdList getIncludedDemographicIds()
Demographic
Ids
whose
members are added to this demographic. The union of these demographics
is added to this demographic. Ids
mandatory
- This method must be implemented. DemographicList getIncludedDemographics() throws OperationFailedException
Demographics
whose members are added to
this demographic. The union of these demographics is added to this
demographic.OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getIncludedIntersectingDemographicIds()
Demographic
Ids
whose
intersection is added to this demographic. The intersection of these
demographics is added to this demographic. Ids
mandatory
- This method must be implemented. DemographicList getIncludedIntersectingDemographics() throws OperationFailedException
Demographics
whose intersection is added
to this demographic. The intersection of these demographics is added
to this demographic.OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getIncludedExclusiveDemographicIds()
Demographic
Ids
whose
non-members are added to this demographic. Ids
mandatory
- This method must be implemented. DemographicList getIncludedExclusiveDemographics() throws OperationFailedException
Demographics
whose non-members are added
to this demographic.OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getExcludedDemographicIds()
Demographic
Ids
whose
members are subtracted from in this demographic. Ids
mandatory
- This method must be implemented. DemographicList getExcludedDemographics() throws OperationFailedException
Demographics
whose members subtracted
from this demographic.OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getIncludedResourceIds()
Resource
Ids
to be added to this demographic. Ids
mandatory
- This method must be implemented. ResourceList getIncludedResources() throws OperationFailedException
Resources
to be added to this
demographic.OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getExcludedResourceIds()
Resource
Ids
to be
subtracted from this demographic. Ids
mandatory
- This method must be implemented. ResourceList getExcludedResources() throws OperationFailedException
Resources
to be subtracted from this
demographic.OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. DemographicRecord getDemographicRecord(Type demographicRecordType) throws OperationFailedException
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
.demographicRecordType
- the type of demographic record to
retrieveNullArgumentException
- demographicRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(demographicRecordType)
is false
mandatory
- This method must be implemented.