com.day.cq.mcm.api

Interface MCMFacade

public interface MCMFacade

This is the central entry point for accessing plugins and configuration info on MCM. Provides accessors to the known component types, too.

Method Summary

Methods

Modifier and Type	Method and Description
void	addExperienceIndirection(java.lang.String fromCompType, java.lang.String toCompType) Change configuration by adding an indirection.
void	addTouchpointIndirection(java.lang.String fromCompType, java.lang.String toCompType) Change configuration by adding an indirection.
java.util.Iterator<Experience>	findExperiences(ResourceResolver rr, Touchpoint t) Finds all posts that are related to the given account, in campaigns and under account.
java.util.Iterator<Resource>	findResources(ResourceResolver rr, java.util.Collection<java.lang.String> rootComponents, java.lang.String path, java.lang.String additionalPropertyCondition) Find all social feed resources underneath a given path.
MCMResourceType	getMCMType(java.lang.String resourceTypeToTest) Gets the type of a given sling:resourceType .
MCMPlugin	getPlugin(Resource r) Get a plugin for a resource found using component types returned by MCMFacade.
MCMPlugin	getPluginForType(java.lang.String componentTypeToProvideFrom) Get a plugin if the type is known to the MCMFacade.
java.util.Collection<MCMPlugin>	getPlugins() Get the complete list of registered plugins.
java.util.Collection<java.lang.String>	getRegisteredExperienceComponents() The component types known to be used for Experience components.
java.util.Collection<java.lang.String>	getRegisteredTouchpointComponents() The component types known to be used for Touchpoint components.
void	removeExperienceIndirection(java.lang.String fromCompType) Change configuration by removing an indirection.
void	removeTouchpointIndirection(java.lang.String fromCompType) Change configuration by removing an indirection.

Method Detail

getPlugin

MCMPlugin getPlugin(Resource r)

Get a plugin for a resource found using component types returned by MCMFacade. Returns null if the resource's type isn't known.

Parameters:

r -

Returns:

getPlugins

java.util.Collection<MCMPlugin> getPlugins()

Get the complete list of registered plugins.

Returns:

getPluginForType

MCMPlugin getPluginForType(java.lang.String componentTypeToProvideFrom)

Get a plugin if the type is known to the MCMFacade. Otherwise null is returned.

Parameters:

componentTypeToProvideFrom -

Returns:

getMCMType

MCMResourceType getMCMType(java.lang.String resourceTypeToTest)

Gets the type of a given sling:resourceType .

Parameters:

componentToTest -

getRegisteredExperienceComponents

java.util.Collection<java.lang.String> getRegisteredExperienceComponents()

The component types known to be used for Experience components. Might contain indirections, too.

Returns:

getRegisteredTouchpointComponents

java.util.Collection<java.lang.String> getRegisteredTouchpointComponents()

The component types known to be used for Touchpoint components. Might contain indirections, too.

Returns:

findExperiences

java.util.Iterator<Experience> findExperiences(ResourceResolver rr,
                                             Touchpoint t)

Finds all posts that are related to the given account, in campaigns and under account.

Parameters:

account -

Returns:

findResources

java.util.Iterator<Resource> findResources(ResourceResolver rr,
                                         java.util.Collection<java.lang.String> rootComponents,
                                         java.lang.String path,
                                         java.lang.String additionalPropertyCondition)

Find all social feed resources underneath a given path.

Parameters:

rootComponents -

path -

additionalPropertyCondition - can be null, or a additional condition to be added to the property checking.

Returns:

addExperienceIndirection

void addExperienceIndirection(java.lang.String fromCompType,
                            java.lang.String toCompType)

Change configuration by adding an indirection. No checking done for the existence of the toCompType.

Parameters:

fromCompType -

toCompType -

addTouchpointIndirection

void addTouchpointIndirection(java.lang.String fromCompType,
                            java.lang.String toCompType)

Change configuration by adding an indirection. No checking done for the existence of the toCompType.

Parameters:

fromCompType -

toCompType -

removeExperienceIndirection

void removeExperienceIndirection(java.lang.String fromCompType)

Change configuration by removing an indirection. If the indirection is inexistent or if the fromCompType is not an indirection nothing is done.

Parameters:

fromCompType -

removeTouchpointIndirection

void removeTouchpointIndirection(java.lang.String fromCompType)

Change configuration by removing an indirection. If the indirection is inexistent or if the fromCompType is not an indirection nothing is done.

Parameters:

fromCompType -