org.osid.resource.demographic

Interface ResourceDemographicProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

ResourceDemographicManager, ResourceDemographicProxyManager

public interface ResourceDemographicProfile
extends OsidProfile

The resource demographic profile describes the interoperability among resource demographic services.

Method Summary

Methods

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

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

Tests if any broker federation is exposed. Federation is exposed when a specific broker may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of brokers appears as a single broker.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographics

boolean supportsDemographics()

Tests if demographic is supported.

Returns:

true if demographic query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicLookup

boolean supportsDemographicLookup()

Tests if looking up demographic is supported.

Returns:

true if demographic lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicQuery

boolean supportsDemographicQuery()

Tests if querying demographic is supported.

Returns:

true if demographic query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicSearch

boolean supportsDemographicSearch()

Tests if searching demographic is supported.

Returns:

true if demographic search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicAdmin

boolean supportsDemographicAdmin()

Tests if a demographic administrative service is supported.

Returns:

true if demographic administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicBuilder

boolean supportsDemographicBuilder()

Tests if a demographic builder service is supported.

Returns:

true if demographic builder service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicNotification

boolean supportsDemographicNotification()

Tests if a demographic notification service is supported.

Returns:

true if demographic notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicBin

boolean supportsDemographicBin()

Tests if a demographic bin lookup service is supported.

Returns:

true if a demographic bin lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicBinAssignment

boolean supportsDemographicBinAssignment()

Tests if a demographic bin service is supported.

Returns:

true if demographic bin assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicSmartBin

boolean supportsDemographicSmartBin()

Tests if a demographic bin lookup service is supported.

Returns:

true if a demographic bin service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicEnablerLookup

boolean supportsDemographicEnablerLookup()

Tests if looking up demographic enablers is supported.

Returns:

true if demographic enabler lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicEnablerQuery

boolean supportsDemographicEnablerQuery()

Tests if querying demographic enablers is supported.

Returns:

true if demographic enabler query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicEnablerSearch

boolean supportsDemographicEnablerSearch()

Tests if searching demographic enablers is supported.

Returns:

true if demographic enabler search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicEnablerAdmin

boolean supportsDemographicEnablerAdmin()

Tests if a demographic enabler administrative service is supported.

Returns:

true if demographic enabler administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicEnablerNotification

boolean supportsDemographicEnablerNotification()

Tests if a demographic enabler notification service is supported.

Returns:

true if demographic enabler notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicEnablerBin

boolean supportsDemographicEnablerBin()

Tests if a demographic enabler bin lookup service is supported.

Returns:

true if a demographic enabler bin lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicEnablerBinAssignment

boolean supportsDemographicEnablerBinAssignment()

Tests if a demographic enabler bin service is supported.

Returns:

true if demographic enabler bin assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicEnablerSmartBin

boolean supportsDemographicEnablerSmartBin()

Tests if a demographic enabler bin lookup service is supported.

Returns:

true if a demographic enabler bin service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicEnablerRuleLookup

boolean supportsDemographicEnablerRuleLookup()

Tests if a demographic enabler rule lookup service is supported.

Returns:

true if a processor enabler rule lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDemographicEnablerRuleApplication

boolean supportsDemographicEnablerRuleApplication()

Tests if a demographic enabler rule application service is supported.

Returns:

true if demographic enabler rule application service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getDemographicRecordTypes

TypeList getDemographicRecordTypes()

Gets the supported Demographic record types.

Returns:

a list containing the supported Demographic record types

Compliance:

mandatory - This method must be implemented.

supportsDemographicRecordType

boolean supportsDemographicRecordType(Type demographicRecordType)

Tests if the given Demographic record type is supported.

Parameters:

demographicRecordType - a Type indicating a Demographic record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - demographicRecordType is null

Compliance:

mandatory - This method must be implemented.

getDemographicSearchRecordTypes

TypeList getDemographicSearchRecordTypes()

Gets the supported Demographic search record types.

Returns:

a list containing the supported Demographic search record types

Compliance:

mandatory - This method must be implemented.

supportsDemographicSearchRecordType

boolean supportsDemographicSearchRecordType(Type demographicSearchRecordType)

Tests if the given Demographic search record type is supported.

Parameters:

demographicSearchRecordType - a Type indicating a Demographic search record type

Returns:

true if the given search record type is supported, false otherwise

Throws:

NullArgumentException - demographicSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getDemographicEnablerRecordTypes

TypeList getDemographicEnablerRecordTypes()

Gets the supported DemographicEnabler record types.

Returns:

a list containing the supported DemographicEnabler record types

Compliance:

mandatory - This method must be implemented.

supportsDemographicEnablerRecordType

boolean supportsDemographicEnablerRecordType(Type demographicEnablerRecordType)

Tests if the given DemographicEnabler record type is supported.

Parameters:

demographicEnablerRecordType - a Type indicating a DemographicEnabler record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - demographicEnablerRecordType is null

Compliance:

mandatory - This method must be implemented.

getDemographicEnablerSearchRecordTypes

TypeList getDemographicEnablerSearchRecordTypes()

Gets the supported DemographicEnabler search record types.

Returns:

a list containing the supported DemographicEnabler search record types

Compliance:

mandatory - This method must be implemented.

supportsDemographicEnablerSearchRecordType

boolean supportsDemographicEnablerSearchRecordType(Type demographicEnablerSearchRecordType)

Tests if the given DemographicEnabler search record type is supported.

Parameters:

demographicEnablerSearchRecordType - a Type indicating a DemographicEnabler search record type

Returns:

true if the given search record type is supported, false otherwise

Throws:

NullArgumentException - demographicEnablerSearchRecordType is null

Compliance:

mandatory - This method must be implemented.