Interface ResourceDemographicManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, ResourceDemographicProfile, Sourceable

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

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime)	Rolls back this service to a point in time.

Methods inherited from interface OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface ResourceDemographicProfile

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

Modifier and Type	Method	Description
TypeList	getDemographicEnablerRecordTypes()	Gets the supported DemographicEnabler record types.
TypeList	getDemographicEnablerSearchRecordTypes()	Gets the supported DemographicEnabler search record types.
TypeList	getDemographicRecordTypes()	Gets the supported Demographic record types.
TypeList	getDemographicSearchRecordTypes()	Gets the supported Demographic search record types.
boolean	supportsDemographicAdmin()	Tests if a demographic administrative service is supported.
boolean	supportsDemographicBin()	Tests if a demographic bin lookup service is supported.
boolean	supportsDemographicBinAssignment()	Tests if a demographic bin service is supported.
boolean	supportsDemographicBuilder()	Tests if a demographic builder service is supported.
boolean	supportsDemographicEnablerAdmin()	Tests if a demographic enabler administrative service is supported.
boolean	supportsDemographicEnablerBin()	Tests if a demographic enabler bin lookup service is supported.
boolean	supportsDemographicEnablerBinAssignment()	Tests if a demographic enabler bin service is supported.
boolean	supportsDemographicEnablerLookup()	Tests if looking up demographic enablers is supported.
boolean	supportsDemographicEnablerNotification()	Tests if a demographic enabler notification service is supported.
boolean	supportsDemographicEnablerQuery()	Tests if querying demographic enablers is supported.
boolean	supportsDemographicEnablerRecordType(Type demographicEnablerRecordType)	Tests if the given DemographicEnabler record type is supported.
boolean	supportsDemographicEnablerRuleApplication()	Tests if a demographic enabler rule application service is supported.
boolean	supportsDemographicEnablerRuleLookup()	Tests if a demographic enabler rule lookup service is supported.
boolean	supportsDemographicEnablerSearch()	Tests if searching demographic enablers is supported.
boolean	supportsDemographicEnablerSearchRecordType(Type demographicEnablerSearchRecordType)	Tests if the given DemographicEnabler search record type is supported.
boolean	supportsDemographicEnablerSmartBin()	Tests if a demographic enabler bin lookup service is supported.
boolean	supportsDemographicLookup()	Tests if looking up demographic is supported.
boolean	supportsDemographicNotification()	Tests if a demographic notification service is supported.
boolean	supportsDemographicQuery()	Tests if querying demographic is supported.
boolean	supportsDemographicRecordType(Type demographicRecordType)	Tests if the given Demographic record type is supported.
boolean	supportsDemographics()	Tests if demographic is supported.
boolean	supportsDemographicSearch()	Tests if searching demographic is supported.
boolean	supportsDemographicSearchRecordType(Type demographicSearchRecordType)	Tests if the given Demographic search record type is supported.
boolean	supportsDemographicSmartBin()	Tests if a demographic bin lookup service is supported.
boolean	supportsVisibleFederation()	Tests if any broker federation is exposed.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getDemographicLookupSession

DemographicLookupSession getDemographicLookupSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the demographic lookup service.

Returns:

a DemographicLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicLookup()} is {@code true} .

getDemographicLookupSessionForBin

DemographicLookupSession getDemographicLookupSessionForBin(Id binId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the demographic lookup service for the given bin.

Parameters:

binId - the Id of the Bin

Returns:

a DemographicLookupSession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getDemographicQuerySession

DemographicQuerySession getDemographicQuerySession()
                                            throws OperationFailedException

Gets the OsidSession associated with the demographic query service.

Returns:

a DemographicQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicQuery()} is {@code true} .

getDemographicQuerySessionForBin

DemographicQuerySession getDemographicQuerySessionForBin(Id binId)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the demographic query service for the given bin.

Parameters:

binId - the Id of the Bin

Returns:

a DemographicQuerySession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getDemographicSearchSession

DemographicSearchSession getDemographicSearchSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the demographic search service.

Returns:

a DemographicSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicSearch()} is {@code true} .

getDemographicSearchSessionForBin

DemographicSearchSession getDemographicSearchSessionForBin(Id binId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the demographic earch service for the given bin.

Parameters:

binId - the Id of the Bin

Returns:

a DemographicSearchSession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getDemographicAdminSession

DemographicAdminSession getDemographicAdminSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the demographic administration service.

Returns:

a DemographicAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicAdmin()} is {@code true} .

getDemographicAdminSessionForBin

DemographicAdminSession getDemographicAdminSessionForBin(Id binId)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the demographic administration service for the given bin.

Parameters:

binId - the Id of the Bin

Returns:

a DemographicAdminSession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getDemographicBuilderSession

DemographicBuilderSession getDemographicBuilderSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the demographic builder service.

Returns:

a DemographicBuilderSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicBuilder() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicBuilder()} is {@code true} .

getDemographicBuilderSessionForBin

DemographicBuilderSession getDemographicBuilderSessionForBin(Id binId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the demographic builder service for the given bin.

Parameters:

binId - the Id of the Bin

Returns:

a DemographicBuilderSession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicBuilder() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicBuilder()} and {@code supportsVisibleFederation()} are {@code true} .

getDemographicNotificationSession

DemographicNotificationSession getDemographicNotificationSession(DemographicReceiver demographicReceiver)
                                                          throws OperationFailedException

Gets the OsidSession associated with the demographic notification service.

Parameters:

demographicReceiver - the notification callback

Returns:

a DemographicNotificationSession

Throws:

NullArgumentException - demographicReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicNotification()} is {@code true} .

getDemographicNotificationSessionForBin

DemographicNotificationSession getDemographicNotificationSessionForBin(DemographicReceiver demographicReceiver,
 Id binId)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the demographic notification service for the given bin.

Parameters:

demographicReceiver - the notification callback

binId - the Id of the Bin

Returns:

a DemographicNotificationSession

Throws:

NotFoundException - no bin found by the given Id

NullArgumentException - demographicReceiver or binId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getDemographicBinSession

DemographicBinSession getDemographicBinSession()
                                        throws OperationFailedException

Gets the OsidSession to lookup demographic/bin mappings for demographics.

Returns:

a DemographicBinSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicBin() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicBin()} is {@code true} .

getDemographicBinAssignmentSession

DemographicBinAssignmentSession getDemographicBinAssignmentSession()
                                                            throws OperationFailedException

Gets the OsidSession associated with assigning demographic to bins.

Returns:

a DemographicBinAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicBinAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicBinAssignment()} is {@code true} .

getDemographicSmartBinSession

DemographicSmartBinSession getDemographicSmartBinSession(Id binId)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage demographic smart bins.

Parameters:

binId - the Id of the Bin

Returns:

a DemographicSmartBinSession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicSmartBin() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicSmartBin()} is {@code true} .

getDemographicEnablerLookupSession

DemographicEnablerLookupSession getDemographicEnablerLookupSession()
                                                            throws OperationFailedException

Gets the OsidSession associated with the demographic enabler lookup service.

Returns:

a DemographicEnablerLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicEnablerLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicEnablerLookup()} is {@code true} .

getDemographicEnablerLookupSessionForBin

DemographicEnablerLookupSession getDemographicEnablerLookupSessionForBin(Id binId)
                                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the demographic enabler lookup service for the given bin.

Parameters:

binId - the Id of the Bin

Returns:

a DemographicEnablerLookupSession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicEnablerLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getDemographicEnablerQuerySession

DemographicEnablerQuerySession getDemographicEnablerQuerySession()
                                                          throws OperationFailedException

Gets the OsidSession associated with the demographic enabler query service.

Returns:

a DemographicEnablerQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicEnablerQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicEnablerQuery()} is {@code true} .

getDemographicEnablerQuerySessionForBin

DemographicEnablerQuerySession getDemographicEnablerQuerySessionForBin(Id binId)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the demographic enabler query service for the given bin.

Parameters:

binId - the Id of the Bin

Returns:

a DemographicEnablerQuerySession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicEnablerQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

getDemographicEnablerSearchSession

DemographicEnablerSearchSession getDemographicEnablerSearchSession()
                                                            throws OperationFailedException

Gets the OsidSession associated with the demographic enabler search service.

Returns:

a DemographicEnablerSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicEnablerSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicEnablerSearch()} is {@code true} .

getDemographicEnablerSearchSessionForBin

DemographicEnablerSearchSession getDemographicEnablerSearchSessionForBin(Id binId)
                                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the demographic enablers earch service for the given bin.

Parameters:

binId - the Id of the Bin

Returns:

a DemographicEnablerSearchSession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicEnablerSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

getDemographicEnablerAdminSession

DemographicEnablerAdminSession getDemographicEnablerAdminSession()
                                                          throws OperationFailedException

Gets the OsidSession associated with the demographic enabler administration service.

Returns:

a DemographicEnablerAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicEnablerAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicEnablerAdmin()} is {@code true} .

getDemographicEnablerAdminSessionForBin

DemographicEnablerAdminSession getDemographicEnablerAdminSessionForBin(Id binId)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the demographic enabler administration service for the given bin.

Parameters:

binId - the Id of the Bin

Returns:

a DemographicEnablerAdminSession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicEnablerAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

getDemographicEnablerNotificationSession

DemographicEnablerNotificationSession getDemographicEnablerNotificationSession(DemographicEnablerReceiver demographicEnablerReceiver)
                                                                        throws OperationFailedException

Gets the OsidSession associated with the demographic enabler notification service.

Parameters:

demographicEnablerReceiver - the notification callback

Returns:

a DemographicEnablerNotificationSession

Throws:

NullArgumentException - demographicEnablerReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicEnablerNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicEnablerNotification()} is {@code true} .

getDemographicEnablerNotificationSessionForBin

DemographicEnablerNotificationSession getDemographicEnablerNotificationSessionForBin(DemographicEnablerReceiver demographicEnablerReceiver,
 Id binId)
                                                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the demographic enabler notification service for the given bin.

Parameters:

demographicEnablerReceiver - the notification callback

binId - the Id of the Bin

Returns:

a DemographicEnablerNotificationSession

Throws:

NotFoundException - no bin found by the given Id

NullArgumentException - demographicEnablerReceiver or binId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicEnablerNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

getDemographicEnablerBinSession

DemographicEnablerBinSession getDemographicEnablerBinSession()
                                                      throws OperationFailedException

Gets the OsidSession to lookup demographic enabler/bin mappings for demographic enablers.

Returns:

a DemographicEnablerBinSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicEnablerBin() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicEnablerBin()} is {@code true} .

getDemographicEnablerBinAssignmentSession

DemographicEnablerBinAssignmentSession getDemographicEnablerBinAssignmentSession()
                                                                          throws OperationFailedException

Gets the OsidSession associated with assigning demographic enablers to bins.

Returns:

a DemographicEnablerBinAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicEnablerBinAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicEnablerBinAssignment()} is {@code true} .

getDemographicEnablerSmartBinSession

DemographicEnablerSmartBinSession getDemographicEnablerSmartBinSession(Id binId)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage demographic enabler smart bins.

Parameters:

binId - the Id of the Bin

Returns:

a DemographicEnablerSmartBinSession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicEnablerSmartBin() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicEnablerSmartBin()} is {@code true} .

getDemographicEnablerRuleLookupSession

DemographicEnablerRuleLookupSession getDemographicEnablerRuleLookupSession()
                                                                    throws OperationFailedException

Gets the OsidSession associated with the demographic enabler mapping lookup service.

Returns:

a DemographicEnablerRuleLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicEnablerRuleLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicEnablerRuleLookup()} is {@code true} .

getDemographicEnablerRuleLookupSessionForBin

DemographicEnablerRuleLookupSession getDemographicEnablerRuleLookupSessionForBin(Id binId)
                                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the demographic enabler mapping lookup service.

Parameters:

binId - the Id of the Bin

Returns:

a DemographicEnablerRuleLookupSession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicEnablerRuleLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

getDemographicEnablerRuleApplicationSession

DemographicEnablerRuleApplicationSession getDemographicEnablerRuleApplicationSession()
                                                                              throws OperationFailedException

Gets the OsidSession associated with the demographic enabler assignment service.

Returns:

a DemographicEnablerRuleApplicationSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicEnablerRuleApplication() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicEnablerRuleApplication()} is {@code true} .

getDemographicEnablerRuleApplicationSessionForBin

DemographicEnablerRuleApplicationSession getDemographicEnablerRuleApplicationSessionForBin(Id binId)
                                                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the demographic enabler assignment service for the given bin.

Parameters:

binId - the Id of the Bin

Returns:

a DemographicEnablerRuleApplicationSession

Throws:

NotFoundException - no Bin found by the given Id

NullArgumentException - binId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDemographicEnablerRuleApplication() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsDemographicEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .