Interface ResourceDemographicProxyManager
- All Superinterfaces:
AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, ResourceDemographicProfile, Sourceable
public interface ResourceDemographicProxyManager
extends OsidProxyManager, ResourceDemographicProfile
The resource demographic proxy manager provides access to resource
demographic sessions and provides interoperability tests for various
aspects of this service. Methods in this manager pass a Proxy for
passing information from server environments. 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 TypeMethodDescriptiongetDemographicAdminSession(Proxy proxy) Gets theOsidSessionassociated with the demographic administration service.getDemographicAdminSessionForBin(Id binId, Proxy proxy) Gets theOsidSessionassociated with the demographic administration service for the given bin.Gets theOsidSessionassociated with assigning demographic to bins.getDemographicBinSession(Proxy proxy) Gets theOsidSessionto lookup demographic/bin mappings for demographics.Gets theOsidSessionassociated with the demographic builder service.getDemographicBuilderSessionForBin(Id binId, Proxy proxy) Gets theOsidSessionassociated with the demographic builder service for the given bin.Gets theOsidSessionassociated with the demographic enabler administration service.getDemographicEnablerAdminSessionForBin(Id binId, Proxy proxy) Gets theOsidSessionassociated with the demographic enabler administration service for the given bin.Gets theOsidSessionassociated with assigning demographic enablers to bins.Gets theOsidSessionto lookup demographic enabler/bin mappings for demographic enablers.Gets theOsidSessionassociated with the demographic enabler lookup service.getDemographicEnablerLookupSessionForBin(Id binId, Proxy proxy) Gets theOsidSessionassociated with the demographic enabler lookup service for the given bin.getDemographicEnablerNotificationSession(DemographicEnablerReceiver demographicEnablerReceiver, Proxy proxy) Gets theOsidSessionassociated with the demographic enabler notification service.getDemographicEnablerNotificationSessionForBin(DemographicEnablerReceiver demographicEnablerReceiver, Id binId, Proxy proxy) Gets theOsidSessionassociated with the demographic enabler notification service for the given bin.Gets theOsidSessionassociated with the demographic enabler query service.getDemographicEnablerQuerySessionForBin(Id binId, Proxy proxy) Gets theOsidSessionassociated with the demographic enabler query service for the given bin.Gets theOsidSessionassociated with the demographic enabler assignment service.getDemographicEnablerRuleApplicationSessionForBin(Id binId, Proxy proxy) Gets theOsidSessionassociated with the demographic enabler assignment service for the given bin.Gets theOsidSessionassociated with the demographic enabler mapping lookup service.getDemographicEnablerRuleLookupSessionForBin(Id binId, Proxy proxy) Gets theOsidSessionassociated with the demographic enabler mapping lookup service for the given bin.Gets theOsidSessionassociated with the demographic enabler search service.getDemographicEnablerSearchSessionForBin(Id binId, Proxy proxy) Gets theOsidSessionassociated with the demographic enablers earch service for the given bin.getDemographicEnablerSmartBinSession(Id binId, Proxy proxy) Gets theOsidSessionto manage demographic enabler smart bins.getDemographicLookupSession(Proxy proxy) Gets theOsidSessionassociated with the demographic lookup service.getDemographicLookupSessionForBin(Id binId, Proxy proxy) Gets theOsidSessionassociated with the demographic lookup service for the given bin.getDemographicNotificationSession(DemographicReceiver demographicReceiver, Proxy proxy) Gets theOsidSessionassociated with the demographic notification service.getDemographicNotificationSessionForBin(DemographicReceiver demographicReceiver, Id binId, Proxy proxy) Gets theOsidSessionassociated with the demographic notification service for the given bin.getDemographicQuerySession(Proxy proxy) Gets theOsidSessionassociated with the demographic query service.getDemographicQuerySessionForBin(Id binId, Proxy proxy) Gets theOsidSessionassociated with the demographic query service for the given bin.getDemographicSearchSession(Proxy proxy) Gets theOsidSessionassociated with the demographic search service.getDemographicSearchSessionForBin(Id binId, Proxy proxy) Gets theOsidSessionassociated with the demographic earch service for the given bin.getDemographicSmartBinSession(Id binId, Proxy proxy) Gets theOsidSessionto manage demographic smart bins.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface OsidProxyManager
closeMethods inherited from interface OsidProxyManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId, Proxy proxy) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime, Proxy proxy) Rolls back this service to a point in time.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, supportsVisibleFederationModifier and TypeMethodDescriptionGets the supportedDemographicEnablerrecord types.Gets the supportedDemographicEnablersearch record types.Gets the supportedDemographicrecord types.Gets the supportedDemographicsearch record types.booleanTests if a demographic administrative service is supported.booleanTests if a demographic bin lookup service is supported.booleanTests if a demographic bin service is supported.booleanTests if a demographic builder service is supported.booleanTests if a demographic enabler administrative service is supported.booleanTests if a demographic enabler bin lookup service is supported.booleanTests if a demographic enabler bin service is supported.booleanTests if looking up demographic enablers is supported.booleanTests if a demographic enabler notification service is supported.booleanTests if querying demographic enablers is supported.booleansupportsDemographicEnablerRecordType(Type demographicEnablerRecordType) Tests if the givenDemographicEnablerrecord type is supported.booleanTests if a demographic enabler rule application service is supported.booleanTests if a demographic enabler rule lookup service is supported.booleanTests if searching demographic enablers is supported.booleansupportsDemographicEnablerSearchRecordType(Type demographicEnablerSearchRecordType) Tests if the givenDemographicEnablersearch record type is supported.booleanTests if a demographic enabler bin lookup service is supported.booleanTests if looking up demographic is supported.booleanTests if a demographic notification service is supported.booleanTests if querying demographic is supported.booleansupportsDemographicRecordType(Type demographicRecordType) Tests if the givenDemographicrecord type is supported.booleanTests if demographic is supported.booleanTests if searching demographic is supported.booleansupportsDemographicSearchRecordType(Type demographicSearchRecordType) Tests if the givenDemographicsearch record type is supported.booleanTests if a demographic bin lookup service is supported.booleanTests if any broker federation is exposed.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
getDemographicLookupSession
Gets theOsidSessionassociated with the demographic lookup service.- Parameters:
proxy- a proxy- Returns:
- a
DemographicLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicLookup()} is {@code true} .
-
getDemographicLookupSessionForBin
DemographicLookupSession getDemographicLookupSessionForBin(Id binId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the demographic lookup service for the given bin.- Parameters:
binId- theIdof theBinproxy- a proxy- Returns:
- a
DemographicLookupSession - Throws:
NotFoundException- noBinfound by the givenIdNullArgumentException-binId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getDemographicQuerySession
Gets theOsidSessionassociated with the demographic query service.- Parameters:
proxy- a proxy- Returns:
- a
DemographicQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicQuery()} is {@code true} .
-
getDemographicQuerySessionForBin
DemographicQuerySession getDemographicQuerySessionForBin(Id binId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the demographic query service for the given bin.- Parameters:
binId- theIdof theBinproxy- a proxy- Returns:
- a
DemographicQuerySession - Throws:
NotFoundException- noBinfound by the givenIdNullArgumentException-binId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getDemographicSearchSession
Gets theOsidSessionassociated with the demographic search service.- Parameters:
proxy- a proxy- Returns:
- a
DemographicSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicSearch()} is {@code true} .
-
getDemographicSearchSessionForBin
DemographicSearchSession getDemographicSearchSessionForBin(Id binId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the demographic earch service for the given bin.- Parameters:
binId- theIdof theBinproxy- a proxy- Returns:
- a
DemographicSearchSession - Throws:
NotFoundException- noBinfound by the givenIdNullArgumentException-binId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getDemographicAdminSession
Gets theOsidSessionassociated with the demographic administration service.- Parameters:
proxy- a proxy- Returns:
- a
DemographicAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicAdmin()} is {@code true} .
-
getDemographicAdminSessionForBin
DemographicAdminSession getDemographicAdminSessionForBin(Id binId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the demographic administration service for the given bin.- Parameters:
binId- theIdof theBinproxy- a proxy- Returns:
- a
DemographicAdminSession - Throws:
NotFoundException- noBinfound by the givenIdNullArgumentException-binId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
-
getDemographicBuilderSession
Gets theOsidSessionassociated with the demographic builder service.- Parameters:
proxy- a proxy- Returns:
- a
DemographicBuilderSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicBuilder()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicBuilder()} is {@code true} .
-
getDemographicBuilderSessionForBin
DemographicBuilderSession getDemographicBuilderSessionForBin(Id binId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the demographic builder service for the given bin.- Parameters:
binId- theIdof theBinproxy- a proxy- Returns:
- a
DemographicBuilderSession - Throws:
NotFoundException- noBinfound by the givenIdNullArgumentException-binId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicBuilder()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicBuilder()} and {@code supportsVisibleFederation()} are {@code true} .
-
getDemographicNotificationSession
DemographicNotificationSession getDemographicNotificationSession(DemographicReceiver demographicReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the demographic notification service.- Parameters:
demographicReceiver- the notification callbackproxy- a proxy- Returns:
- a
DemographicNotificationSession - Throws:
NullArgumentException-demographicReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicNotification()} is {@code true} .
-
getDemographicNotificationSessionForBin
DemographicNotificationSession getDemographicNotificationSessionForBin(DemographicReceiver demographicReceiver, Id binId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the demographic notification service for the given bin.- Parameters:
demographicReceiver- the notification callbackbinId- theIdof theBinproxy- a proxy- Returns:
- a
DemographicNotificationSession - Throws:
NotFoundException- no bin found by the givenIdNullArgumentException-demographicReceiver, binId, orproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicNotification()} and {@code supportsVisibleFederation()} are {@code true} .
-
getDemographicBinSession
Gets theOsidSessionto lookup demographic/bin mappings for demographics.- Parameters:
proxy- a proxy- Returns:
- a
DemographicBinSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicBin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicBin()} is {@code true} .
-
getDemographicBinAssignmentSession
DemographicBinAssignmentSession getDemographicBinAssignmentSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with assigning demographic to bins.- Parameters:
proxy- a proxy- Returns:
- a
DemographicBinAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicBinAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicBinAssignment()} is {@code true} .
-
getDemographicSmartBinSession
DemographicSmartBinSession getDemographicSmartBinSession(Id binId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage demographic smart bins.- Parameters:
binId- theIdof theBinproxy- a proxy- Returns:
- a
DemographicSmartBinSession - Throws:
NotFoundException- noBinfound by the givenIdNullArgumentException-binIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicSmartBin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicSmartBin()} is {@code true} .
-
getDemographicEnablerLookupSession
DemographicEnablerLookupSession getDemographicEnablerLookupSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the demographic enabler lookup service.- Parameters:
proxy- a proxy- Returns:
- a
DemographicEnablerLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicEnablerLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicEnablerLookup()} is {@code true} .
-
getDemographicEnablerLookupSessionForBin
DemographicEnablerLookupSession getDemographicEnablerLookupSessionForBin(Id binId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the demographic enabler lookup service for the given bin.- Parameters:
binId- theIdof theBinproxy- a proxy- Returns:
- a
DemographicEnablerLookupSession - Throws:
NotFoundException- noBinfound by the givenIdNullArgumentException-binId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicEnablerLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getDemographicEnablerQuerySession
DemographicEnablerQuerySession getDemographicEnablerQuerySession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the demographic enabler query service.- Parameters:
proxy- a proxy- Returns:
- a
DemographicEnablerQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicEnablerQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicEnablerQuery()} is {@code true} .
-
getDemographicEnablerQuerySessionForBin
DemographicEnablerQuerySession getDemographicEnablerQuerySessionForBin(Id binId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the demographic enabler query service for the given bin.- Parameters:
binId- theIdof theBinproxy- a proxy- Returns:
- a
DemographicEnablerQuerySession - Throws:
NotFoundException- noBinfound by the givenIdNullArgumentException-binId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicEnablerQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getDemographicEnablerSearchSession
DemographicEnablerSearchSession getDemographicEnablerSearchSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the demographic enabler search service.- Parameters:
proxy- a proxy- Returns:
- a
DemographicEnablerSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicEnablerSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicEnablerSearch()} is {@code true} .
-
getDemographicEnablerSearchSessionForBin
DemographicEnablerSearchSession getDemographicEnablerSearchSessionForBin(Id binId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the demographic enablers earch service for the given bin.- Parameters:
binId- theIdof theBinproxy- a proxy- Returns:
- a
DemographicEnablerSearchSession - Throws:
NotFoundException- noBinfound by the givenIdNullArgumentException-binId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicEnablerSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getDemographicEnablerAdminSession
DemographicEnablerAdminSession getDemographicEnablerAdminSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the demographic enabler administration service.- Parameters:
proxy- a proxy- Returns:
- a
DemographicEnablerAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicEnablerAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicEnablerAdmin()} is {@code true} .
-
getDemographicEnablerAdminSessionForBin
DemographicEnablerAdminSession getDemographicEnablerAdminSessionForBin(Id binId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the demographic enabler administration service for the given bin.- Parameters:
binId- theIdof theBinproxy- a proxy- Returns:
- a
DemographicEnablerAdminSession - Throws:
NotFoundException- noBinfound by the givenIdNullArgumentException-binId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicEnablerAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
-
getDemographicEnablerNotificationSession
DemographicEnablerNotificationSession getDemographicEnablerNotificationSession(DemographicEnablerReceiver demographicEnablerReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the demographic enabler notification service.- Parameters:
demographicEnablerReceiver- the notification callbackproxy- a proxy- Returns:
- a
DemographicEnablerNotificationSession - Throws:
NullArgumentException-demographicEnablerReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicEnablerNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicEnablerNotification()} is {@code true} .
-
getDemographicEnablerNotificationSessionForBin
DemographicEnablerNotificationSession getDemographicEnablerNotificationSessionForBin(DemographicEnablerReceiver demographicEnablerReceiver, Id binId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the demographic enabler notification service for the given bin.- Parameters:
demographicEnablerReceiver- the notification callbackbinId- theIdof theBinproxy- a proxy- Returns:
- a
DemographicEnablerNotificationSession - Throws:
NotFoundException- no bin found by the givenIdNullArgumentException-demographicEnablerReceiver, binIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicEnablerNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .
-
getDemographicEnablerBinSession
DemographicEnablerBinSession getDemographicEnablerBinSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionto lookup demographic enabler/bin mappings for demographic enablers.- Parameters:
proxy- a proxy- Returns:
- a
DemographicEnablerBinSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicEnablerBin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicEnablerBin()} is {@code true} .
-
getDemographicEnablerBinAssignmentSession
DemographicEnablerBinAssignmentSession getDemographicEnablerBinAssignmentSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with assigning demographic enablers to bins.- Parameters:
proxy- a proxy- Returns:
- a
DemographicEnablerBinAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicEnablerBinAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicEnablerBinAssignment()} is {@code true} .
-
getDemographicEnablerSmartBinSession
DemographicEnablerSmartBinSession getDemographicEnablerSmartBinSession(Id binId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage demographic enabler smart bins.- Parameters:
binId- theIdof theBinproxy- a proxy- Returns:
- a
DemographicEnablerSmartBinSession - Throws:
NotFoundException- noBinfound by the givenIdNullArgumentException-binIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicEnablerSmartBin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicEnablerSmartBin()} is {@code true} .
-
getDemographicEnablerRuleLookupSession
DemographicEnablerRuleLookupSession getDemographicEnablerRuleLookupSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the demographic enabler mapping lookup service.- Parameters:
proxy- a proxy- Returns:
- a
DemographicEnablerRuleLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicEnablerRuleLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicEnablerRuleLookup()} is {@code true} .
-
getDemographicEnablerRuleLookupSessionForBin
DemographicEnablerRuleLookupSession getDemographicEnablerRuleLookupSessionForBin(Id binId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the demographic enabler mapping lookup service for the given bin.- Parameters:
binId- theIdof theBinproxy- a proxy- Returns:
- a
DemographicEnablerRuleLookupSession - Throws:
NotFoundException- noBinfound by the givenIdNullArgumentException-binIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicEnablerRuleLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getDemographicEnablerRuleApplicationSession
DemographicEnablerRuleApplicationSession getDemographicEnablerRuleApplicationSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the demographic enabler assignment service.- Parameters:
proxy- a proxy- Returns:
- a
DemographicEnablerRuleApplicationSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicEnablerRuleApplication()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicEnablerRuleApplication()} is {@code true} .
-
getDemographicEnablerRuleApplicationSessionForBin
DemographicEnablerRuleApplicationSession getDemographicEnablerRuleApplicationSessionForBin(Id binId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the demographic enabler assignment service for the given bin.- Parameters:
binId- theIdof theBinproxy- a proxy- Returns:
- a
DemographicEnablerRuleApplicationSession - Throws:
NotFoundException- noBinfound by the givenIdNullArgumentException-binIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDemographicEnablerRuleApplication()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDemographicEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .
-