public interface ResourceDemographicManager extends OsidManager, ResourceDemographicProfile
The resource demographic manager provides access to resource demographic sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
DemographicLookupSession:
a session to retrieve
demographic DemographicQuerySession:
a session to query for
demographic DemographicSearchSession:
a session to search for
demographic DemographicAdminSession:
a session to create and
delete demographic DemographicBuilderSession:
a session to build
demographics from searches DemographicNotificationSession:
a session to
receive notifications pertaining to demographic changes DemographicBinSession:
a session to look up
demographic bin mappings DemographicBinAssignmentSession:
a session to
manage demographic to bin mappings DemographicSmartBinSession:
a session to manage
dynamic bins of demographic DemographicEnablerLookupSession:
a session to
retrieve demographic enablers DemographicEnablerQuerySession:
a session to query
for demographic enablers DemographicEnablerSearchSession:
a session to
search for demographic enablers DemographicEnablerAdminSession:
a session to
create and delete demographic enablers DemographicEnablerNotificationSession:
a session
to receive notifications pertaining to demographic enabler changes
DemographicEnablerBinSession:
a session to look up
demographic enabler bin mappings DemographicEnablerBinAssignmentSession:
a session
to manage demographic enabler to bin mappings DemographicEnablerSmartBinSession:
a session to
manage dynamic bins of demographic enablers DemographicEnablerRuleLookupSession:
a session to
look up demographic enabler mappings DemographicEnablerRuleApplicationSession:
a
session to apply demographic enablers Modifier and Type | Method and Description |
---|---|
DemographicAdminSession |
getDemographicAdminSession()
Gets the
OsidSession associated with the demographic
administration service. |
DemographicAdminSession |
getDemographicAdminSessionForBin(Id binId)
Gets the
OsidSession associated with the demographic
administration service for the given bin. |
DemographicBinAssignmentSession |
getDemographicBinAssignmentSession()
Gets the
OsidSession associated with assigning
demographic to bins. |
DemographicBinSession |
getDemographicBinSession()
Gets the
OsidSession to lookup demographic/bin mappings
for demographics. |
DemographicBuilderSession |
getDemographicBuilderSession()
Gets the
OsidSession associated with the demographic
builder service. |
DemographicBuilderSession |
getDemographicBuilderSessionForBin(Id binId)
Gets the
OsidSession associated with the demographic
builder service for the given bin. |
DemographicEnablerAdminSession |
getDemographicEnablerAdminSession()
Gets the
OsidSession associated with the demographic
enabler administration service. |
DemographicEnablerAdminSession |
getDemographicEnablerAdminSessionForBin(Id binId)
Gets the
OsidSession associated with the demographic
enabler administration service for the given bin. |
DemographicEnablerBinAssignmentSession |
getDemographicEnablerBinAssignmentSession()
Gets the
OsidSession associated with assigning
demographic enablers to bins. |
DemographicEnablerBinSession |
getDemographicEnablerBinSession()
Gets the
OsidSession to lookup demographic enabler/bin
mappings for demographic enablers. |
DemographicEnablerLookupSession |
getDemographicEnablerLookupSession()
Gets the
OsidSession associated with the demographic
enabler lookup service. |
DemographicEnablerLookupSession |
getDemographicEnablerLookupSessionForBin(Id binId)
Gets the
OsidSession associated with the demographic
enabler lookup service for the given bin. |
DemographicEnablerNotificationSession |
getDemographicEnablerNotificationSession(DemographicEnablerReceiver demographicEnablerReceiver)
Gets the
OsidSession associated with the demographic
enabler notification service. |
DemographicEnablerNotificationSession |
getDemographicEnablerNotificationSessionForBin(DemographicEnablerReceiver demographicEnablerReceiver,
Id binId)
Gets the
OsidSession associated with the demographic
enabler notification service for the given bin. |
DemographicEnablerQuerySession |
getDemographicEnablerQuerySession()
Gets the
OsidSession associated with the demographic
enabler query service. |
DemographicEnablerQuerySession |
getDemographicEnablerQuerySessionForBin(Id binId)
Gets the
OsidSession associated with the demographic
enabler query service for the given bin. |
DemographicEnablerRuleApplicationSession |
getDemographicEnablerRuleApplicationSession()
Gets the
OsidSession associated with the demographic
enabler assignment service. |
DemographicEnablerRuleApplicationSession |
getDemographicEnablerRuleApplicationSessionForBin(Id binId)
Gets the
OsidSession associated with the demographic
enabler assignment service for the given bin. |
DemographicEnablerRuleLookupSession |
getDemographicEnablerRuleLookupSession()
Gets the
OsidSession associated with the demographic
enabler mapping lookup service. |
DemographicEnablerRuleLookupSession |
getDemographicEnablerRuleLookupSessionForBin(Id binId)
Gets the
OsidSession associated with the demographic
enabler mapping lookup service. |
DemographicEnablerSearchSession |
getDemographicEnablerSearchSession()
Gets the
OsidSession associated with the demographic
enabler search service. |
DemographicEnablerSearchSession |
getDemographicEnablerSearchSessionForBin(Id binId)
Gets the
OsidSession associated with the demographic
enablers earch service for the given bin. |
DemographicEnablerSmartBinSession |
getDemographicEnablerSmartBinSession(Id binId)
Gets the
OsidSession to manage demographic enabler
smart bins. |
DemographicLookupSession |
getDemographicLookupSession()
Gets the
OsidSession associated with the demographic
lookup service. |
DemographicLookupSession |
getDemographicLookupSessionForBin(Id binId)
Gets the
OsidSession associated with the demographic
lookup service for the given bin. |
DemographicNotificationSession |
getDemographicNotificationSession(DemographicReceiver demographicReceiver)
Gets the
OsidSession associated with the demographic
notification service. |
DemographicNotificationSession |
getDemographicNotificationSessionForBin(DemographicReceiver demographicReceiver,
Id binId)
Gets the
OsidSession associated with the demographic
notification service for the given bin. |
DemographicQuerySession |
getDemographicQuerySession()
Gets the
OsidSession associated with the demographic
query service. |
DemographicQuerySession |
getDemographicQuerySessionForBin(Id binId)
Gets the
OsidSession associated with the demographic
query service for the given bin. |
DemographicSearchSession |
getDemographicSearchSession()
Gets the
OsidSession associated with the demographic
search service. |
DemographicSearchSession |
getDemographicSearchSessionForBin(Id binId)
Gets the
OsidSession associated with the demographic
earch service for the given bin. |
DemographicSmartBinSession |
getDemographicSmartBinSession(Id binId)
Gets the
OsidSession to manage demographic smart bins. |
changeBranch, initialize, rollbackService
close
getDemographicEnablerRecordTypes, getDemographicEnablerSearchRecordTypes, getDemographicRecordTypes, getDemographicSearchRecordTypes, supportsDemographicAdmin, supportsDemographicBin, supportsDemographicBinAssignment, supportsDemographicBuilder, supportsDemographicEnablerAdmin, supportsDemographicEnablerBin, supportsDemographicEnablerBinAssignment, supportsDemographicEnablerLookup, supportsDemographicEnablerNotification, supportsDemographicEnablerQuery, supportsDemographicEnablerRecordType, supportsDemographicEnablerRuleApplication, supportsDemographicEnablerRuleLookup, supportsDemographicEnablerSearch, supportsDemographicEnablerSearchRecordType, supportsDemographicEnablerSmartBin, supportsDemographicLookup, supportsDemographicNotification, supportsDemographicQuery, supportsDemographicRecordType, supportsDemographics, supportsDemographicSearch, supportsDemographicSearchRecordType, supportsDemographicSmartBin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
DemographicLookupSession getDemographicLookupSession() throws OperationFailedException
OsidSession
associated with the demographic
lookup service. DemographicLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicLookup()
is false
optional
- This method must be implemented if
supportsDemographicLookup()
is true.
DemographicLookupSession getDemographicLookupSessionForBin(Id binId) throws NotFoundException, OperationFailedException
OsidSession
associated with the demographic
lookup service for the given bin.binId
- the Id
of the Bin
DemographicLookupSession
NotFoundException
- no Bin
found by the
given Id
NullArgumentException
- binId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDemographicLookup()
and
supportsVisibleFederation()
are true.
DemographicQuerySession getDemographicQuerySession() throws OperationFailedException
OsidSession
associated with the demographic
query service. DemographicQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicQuery()
is false
optional
- This method must be implemented if
supportsDemographicQuery()
is true.
DemographicQuerySession getDemographicQuerySessionForBin(Id binId) throws NotFoundException, OperationFailedException
OsidSession
associated with the demographic
query service for the given bin.binId
- the Id
of the Bin
DemographicQuerySession
NotFoundException
- no Bin
found by the
given Id
NullArgumentException
- binId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDemographicQuery()
and
supportsVisibleFederation()
are true.
DemographicSearchSession getDemographicSearchSession() throws OperationFailedException
OsidSession
associated with the demographic
search service. DemographicSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicSearch()
is false
optional
- This method must be implemented if
supportsDemographicSearch()
is true.
DemographicSearchSession getDemographicSearchSessionForBin(Id binId) throws NotFoundException, OperationFailedException
OsidSession
associated with the demographic
earch service for the given bin.binId
- the Id
of the Bin
DemographicSearchSession
NotFoundException
- no Bin
found by the
given Id
NullArgumentException
- binId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDemographicSearch()
and
supportsVisibleFederation()
are true.
DemographicAdminSession getDemographicAdminSession() throws OperationFailedException
OsidSession
associated with the demographic
administration service. DemographicAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicAdmin()
is false
optional
- This method must be implemented if
supportsDemographicAdmin()
is true.
DemographicAdminSession getDemographicAdminSessionForBin(Id binId) throws NotFoundException, OperationFailedException
OsidSession
associated with the demographic
administration service for the given bin.binId
- the Id
of the Bin
DemographicAdminSession
NotFoundException
- no Bin
found by the
given Id
NullArgumentException
- binId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDemographicAdmin()
and
supportsVisibleFederation()
are true.
DemographicBuilderSession getDemographicBuilderSession() throws OperationFailedException
OsidSession
associated with the demographic
builder service. DemographicBuilderSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicBuilder()
is false
optional
- This method must be implemented if
supportsDemographicBuilder()
is true.
DemographicBuilderSession getDemographicBuilderSessionForBin(Id binId) throws NotFoundException, OperationFailedException
OsidSession
associated with the demographic
builder service for the given bin.binId
- the Id
of the Bin
DemographicBuilderSession
NotFoundException
- no Bin
found by the
given Id
NullArgumentException
- binId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicBuilder()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDemographicBuilder()
and
supportsVisibleFederation()
are true.
DemographicNotificationSession getDemographicNotificationSession(DemographicReceiver demographicReceiver) throws OperationFailedException
OsidSession
associated with the demographic
notification service.demographicReceiver
- the notification callback DemographicNotificationSession
NullArgumentException
- demographicReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicNotification()
is false
optional
- This method must be implemented if
supportsDemographicNotification()
is true.
DemographicNotificationSession getDemographicNotificationSessionForBin(DemographicReceiver demographicReceiver, Id binId) throws NotFoundException, OperationFailedException
OsidSession
associated with the demographic
notification service for the given bin.demographicReceiver
- the notification callbackbinId
- the Id
of the Bin
DemographicNotificationSession
NotFoundException
- no bin found by the given Id
NullArgumentException
- demographicReceiver
or binId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDemographicNotification()
and
supportsVisibleFederation()
are true.
DemographicBinSession getDemographicBinSession() throws OperationFailedException
OsidSession
to lookup demographic/bin mappings
for demographics. DemographicBinSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicBin()
is false
optional
- This method must be implemented if
supportsDemographicBin()
is true.
DemographicBinAssignmentSession getDemographicBinAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning
demographic to bins. DemographicBinAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicBinAssignment()
is false
optional
- This method must be implemented if
supportsDemographicBinAssignment()
is true.
DemographicSmartBinSession getDemographicSmartBinSession(Id binId) throws NotFoundException, OperationFailedException
OsidSession
to manage demographic smart bins.binId
- the Id
of the Bin
DemographicSmartBinSession
NotFoundException
- no Bin
found by the
given Id
NullArgumentException
- binId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicSmartBin()
is false
optional
- This method must be implemented if
supportsDemographicSmartBin()
is true.
DemographicEnablerLookupSession getDemographicEnablerLookupSession() throws OperationFailedException
OsidSession
associated with the demographic
enabler lookup service. DemographicEnablerLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicEnablerLookup()
is false
optional
- This method must be implemented if
supportsDemographicEnablerLookup()
is true.
DemographicEnablerLookupSession getDemographicEnablerLookupSessionForBin(Id binId) throws NotFoundException, OperationFailedException
OsidSession
associated with the demographic
enabler lookup service for the given bin.binId
- the Id
of the Bin
DemographicEnablerLookupSession
NotFoundException
- no Bin
found by the
given Id
NullArgumentException
- binId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicEnablerLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDemographicEnablerLookup()
and
supportsVisibleFederation()
are true.
DemographicEnablerQuerySession getDemographicEnablerQuerySession() throws OperationFailedException
OsidSession
associated with the demographic
enabler query service. DemographicEnablerQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicEnablerQuery()
is false
optional
- This method must be implemented if
supportsDemographicEnablerQuery()
is true.
DemographicEnablerQuerySession getDemographicEnablerQuerySessionForBin(Id binId) throws NotFoundException, OperationFailedException
OsidSession
associated with the demographic
enabler query service for the given bin.binId
- the Id
of the Bin
DemographicEnablerQuerySession
NotFoundException
- no Bin
found by the
given Id
NullArgumentException
- binId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicEnablerQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDemographicEnablerQuery()
and
supportsVisibleFederation()
are true.
DemographicEnablerSearchSession getDemographicEnablerSearchSession() throws OperationFailedException
OsidSession
associated with the demographic
enabler search service. DemographicEnablerSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicEnablerSearch()
is false
optional
- This method must be implemented if
supportsDemographicEnablerSearch()
is true.
DemographicEnablerSearchSession getDemographicEnablerSearchSessionForBin(Id binId) throws NotFoundException, OperationFailedException
OsidSession
associated with the demographic
enablers earch service for the given bin.binId
- the Id
of the Bin
DemographicEnablerSearchSession
NotFoundException
- no Bin
found by the
given Id
NullArgumentException
- binId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicEnablerSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDemographicEnablerSearch()
and
supportsVisibleFederation()
are true.
DemographicEnablerAdminSession getDemographicEnablerAdminSession() throws OperationFailedException
OsidSession
associated with the demographic
enabler administration service. DemographicEnablerAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicEnablerAdmin()
is false
optional
- This method must be implemented if
supportsDemographicEnablerAdmin()
is true.
DemographicEnablerAdminSession getDemographicEnablerAdminSessionForBin(Id binId) throws NotFoundException, OperationFailedException
OsidSession
associated with the demographic
enabler administration service for the given bin.binId
- the Id
of the Bin
DemographicEnablerAdminSession
NotFoundException
- no Bin
found by the
given Id
NullArgumentException
- binId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicEnablerAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDemographicEnablerAdmin()
and
supportsVisibleFederation()
are true.
DemographicEnablerNotificationSession getDemographicEnablerNotificationSession(DemographicEnablerReceiver demographicEnablerReceiver) throws OperationFailedException
OsidSession
associated with the demographic
enabler notification service.demographicEnablerReceiver
- the notification callback DemographicEnablerNotificationSession
NullArgumentException
-
demographicEnablerReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicEnablerNotification()
is
false
optional
- This method must be implemented if
supportsDemographicEnablerNotification()
is
true.
DemographicEnablerNotificationSession getDemographicEnablerNotificationSessionForBin(DemographicEnablerReceiver demographicEnablerReceiver, Id binId) throws NotFoundException, OperationFailedException
OsidSession
associated with the demographic
enabler notification service for the given bin.demographicEnablerReceiver
- the notification callbackbinId
- the Id
of the Bin
DemographicEnablerNotificationSession
NotFoundException
- no bin found by the given Id
NullArgumentException
-
demographicEnablerReceiver
or binId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicEnablerNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDemographicEnablerNotification()
and
supportsVisibleFederation()
are
true.
DemographicEnablerBinSession getDemographicEnablerBinSession() throws OperationFailedException
OsidSession
to lookup demographic enabler/bin
mappings for demographic enablers. DemographicEnablerBinSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicEnablerBin()
is false
optional
- This method must be implemented if
supportsDemographicEnablerBin()
is true.
DemographicEnablerBinAssignmentSession getDemographicEnablerBinAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning
demographic enablers to bins. DemographicEnablerBinAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicEnablerBinAssignment()
is
false
optional
- This method must be implemented if
supportsDemographicEnablerBinAssignment()
is
true.
DemographicEnablerSmartBinSession getDemographicEnablerSmartBinSession(Id binId) throws NotFoundException, OperationFailedException
OsidSession
to manage demographic enabler
smart bins.binId
- the Id
of the Bin
DemographicEnablerSmartBinSession
NotFoundException
- no Bin
found by the
given Id
NullArgumentException
- binId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicEnablerSmartBin()
is false
optional
- This method must be implemented if
supportsDemographicEnablerSmartBin()
is
true.
DemographicEnablerRuleLookupSession getDemographicEnablerRuleLookupSession() throws OperationFailedException
OsidSession
associated with the demographic
enabler mapping lookup service. DemographicEnablerRuleLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicEnablerRuleLookup()
is false
optional
- This method must be implemented if
supportsDemographicEnablerRuleLookup()
is
true.
DemographicEnablerRuleLookupSession getDemographicEnablerRuleLookupSessionForBin(Id binId) throws NotFoundException, OperationFailedException
OsidSession
associated with the demographic
enabler mapping lookup service.binId
- the Id
of the Bin
DemographicEnablerRuleLookupSession
NotFoundException
- no Bin
found by the
given Id
NullArgumentException
- binId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicEnablerRuleLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDemographicEnablerRuleLookup()
and
supportsVisibleFederation()
are true.
DemographicEnablerRuleApplicationSession getDemographicEnablerRuleApplicationSession() throws OperationFailedException
OsidSession
associated with the demographic
enabler assignment service. DemographicEnablerRuleApplicationSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicEnablerRuleApplication()
is
false
optional
- This method must be implemented if
supportsDemographicEnablerRuleApplication()
is
true.
DemographicEnablerRuleApplicationSession getDemographicEnablerRuleApplicationSessionForBin(Id binId) throws NotFoundException, OperationFailedException
OsidSession
associated with the demographic
enabler assignment service for the given bin.binId
- the Id
of the Bin
DemographicEnablerRuleApplicationSession
NotFoundException
- no Bin
found by the
given Id
NullArgumentException
- binId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsDemographicEnablerRuleApplication()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsDemographicEnablerRuleApplication()
and
supportsVisibleFederation()
are
true.