org.gatein.mop.api.content

Interface Customization<S>

Type Parameters:

S - the content state type parameter

public interface Customization<S>

An entity representing the customization of a content.

Version:

$Revision$

Author:

Julien Viet

Method Summary

Methods

Modifier and Type	Method and Description
Customization<S>	customize(Collection<CustomizationContext> contexts) Customize the state with respect to the provided customization context.
void	destroy() Destroys the customization.
Content<S>	getContent() Returns the content this customization refers to.
String	getContentId() Returns the content id this customization refers to.
CustomizationContext	getContext() Returns the related context of this customization.
Set<CustomizationContext>	getContexts() Returns the contexts that are associated with this customization.
Customization<S>	getCustomization(Set<CustomizationContext> contexts) Returns the stateful content associated with the specified customization contexts or null if no customization can be created for the desired contexts.
String	getId() Returns the customization id
Customization	getParent() Returns the parent customization or null if this customization is full featured clone.
S	getState() Returns the customization state.
ContentType<S>	getType() Returns the content type this customization refers to.
S	getVirtualState() Returns the customization virtual state that is computed from various state of the customization hierarchy.
void	setState(S state) Updates the customization state.

Method Detail

getId

String getId()

Returns the customization id

Returns:

the customization id

getContent

Content<S> getContent()

Returns the content this customization refers to.

Returns:

the content

getContentId

String getContentId()

Returns the content id this customization refers to.

Returns:

the content id

getType

ContentType<S> getType()

Returns the content type this customization refers to.

Returns:

The content type

getContext

CustomizationContext getContext()

Returns the related context of this customization.

Returns:

the related context

getContexts

Set<CustomizationContext> getContexts()

Returns the contexts that are associated with this customization. Note that the set returned maintains the hierararchy order of the set from the most specific to the least specific.

Returns:

the contexts

getCustomization

Customization<S> getCustomization(Set<CustomizationContext> contexts)

Returns the stateful content associated with the specified customization contexts or null if no customization can be created for the desired contexts. The returned customization may not honour all provided the customization contexts.

Calling the method with an empty set returns the default customization of the content or null if none is available.

Calling the method with a set of contexts that is not consistent will trigger an IllegalArgumentException to be thrown. For instance two workspace contexts specifying different pages cannot lead to determine a final context.

Parameters:

contexts - the customization contexts

Returns:

the content state

customize

Customization<S> customize(Collection<CustomizationContext> contexts)

Customize the state with respect to the provided customization context.

Parameters:

contexts - the customization context

Returns:

the customization

getParent

Customization getParent()

Returns the parent customization or null if this customization is full featured clone.

Returns:

the parent customization

getVirtualState

S getVirtualState()

Returns the customization virtual state that is computed from various state of the customization hierarchy.

Returns:

the virtual state

getState

S getState()

Returns the customization state.

Returns:

the state

setState

void setState(S state)

Updates the customization state.

Parameters:

state - the customization state

destroy

void destroy()

Destroys the customization.