org.gatein.mop.api.content
Interface CustomizationContext

All Known Subinterfaces:

Page, Site, UIWindow, Workspace, WorkspaceCustomizationContext

public interface CustomizationContext

The customization context defines where customization applies, it can be an entity, an identity, or anything else that is subject to customization.

Contexts are partitionned by their type, i.e all the context that share the same value returned by the invocation of the method getContextType() are considered to belong to the same type.

Within a partition it is possible to find out the relationship between two contexts thanks to the contains(CustomizationContext) method.

• Two contexts are considered equals when they contain each other.
• Two contexts are not related when no context contains the other one.
• Otherwise one contexts belongs to the other.

The contains relationship is transitive.

Version:

$Revision$

Author:

Julien Viet

Method Summary

boolean	contains(CustomizationContext that) Returns true if the context contains the provided context.
String	getContextId() Returns the identifier of the context.
String	getContextType() Returns the customization context type.

Method Detail

getContextId

String getContextId()

Returns the identifier of the context.

Returns:

the context identifier

getContextType

String getContextType()

Returns the customization context type.

Returns:

the customization context type

contains

boolean contains(CustomizationContext that)

Returns true if the context contains the provided context.

Parameters:

that - the context to test

Returns:

a boolean indicated whether the provided context is contained by this context