Package lumis.portal.structure.areatag

Interface IAreaTagManagerSPI

All Known Implementing Classes:

AreaTagManager

public interface IAreaTagManagerSPI

Area Tag service provider interface.

Since:

7.1.0

Version:

$Revision: 16037 $ $Date: 2013-11-21 20:58:50 -0200 (Thu, 21 Nov 2013) $

Field Summary

Fields

Modifier and Type	Field	Description
static String	APPLIED_AREA_TAG_PROPERTY_BAG_NAME	Applied area tag property bag name.

Method Summary

Modifier and Type	Method	Description
Set<String>	getAppliedAreaTags(ChannelConfig channel)	Return the applied area tags in the given channel.
Set<String>	getAppliedAreaTags(ServiceInstanceConfig serviceInstance)	Returns the applied area tags in the given service instance.
AreaTagUsageConfig	getLocalAreaTags(ChannelConfig channel)	Returns the area tag usage for the given channel.
AreaTagUsageConfig	getLocalAreaTags(ServiceInstanceConfig serviceInstance)	Returns the area tag usage for the given service instance.
void	updateLocalAreaTagUsage(ChannelConfig channel, AreaTagUsageConfig areaTagAppliance)	Updates the theme appliance for the given channel.
void	updateLocalAreaTagUsage(ServiceInstanceConfig serviceInstance, AreaTagUsageConfig areaTagAppliance)	Updates the theme appliance for the given service instance.

Field Detail

APPLIED_AREA_TAG_PROPERTY_BAG_NAME

static final String APPLIED_AREA_TAG_PROPERTY_BAG_NAME

Applied area tag property bag name.

Since:

7.1.0

See Also:

Constant Field Values

Method Detail

getAppliedAreaTags

Set<String> getAppliedAreaTags(ServiceInstanceConfig serviceInstance)
                        throws PortalException

Returns the applied area tags in the given service instance.

Parameters:

serviceInstance - the Service Instance.

Returns:

the applied area tags in the given service instance.

Throws:

PortalException

Since:

7.1.0

getAppliedAreaTags

Set<String> getAppliedAreaTags(ChannelConfig channel)
                        throws PortalException

Return the applied area tags in the given channel.

Parameters:

channel - the channel.

Returns:

the applied area tags in the given channel.

Throws:

PortalException

Since:

7.1.0

updateLocalAreaTagUsage

void updateLocalAreaTagUsage(ChannelConfig channel,
                             AreaTagUsageConfig areaTagAppliance)
                      throws PortalException

Updates the theme appliance for the given channel.

Parameters:

channel - the service instance.

areaTagAppliance - the area tag appliance.

Throws:

PortalException

Since:

7.1.0

updateLocalAreaTagUsage

void updateLocalAreaTagUsage(ServiceInstanceConfig serviceInstance,
                             AreaTagUsageConfig areaTagAppliance)
                      throws PortalException

Updates the theme appliance for the given service instance.

Parameters:

serviceInstance - the service instance.

areaTagAppliance - the area tag appliance.

Throws:

PortalException

Since:

7.1.0

getLocalAreaTags

AreaTagUsageConfig getLocalAreaTags(ServiceInstanceConfig serviceInstance)
                             throws PortalException

Returns the area tag usage for the given service instance.

Parameters:

serviceInstance - the service instance.

Returns:

the area tag usage for the given service instance.

Throws:

PortalException

Since:

7.1.0

getLocalAreaTags

AreaTagUsageConfig getLocalAreaTags(ChannelConfig channel)
                             throws PortalException

Returns the area tag usage for the given channel.

Parameters:

channel - the channel.

Returns:

the area tag usage for the given channel.

Throws:

PortalException

Since:

7.1.0