MOP API 1.3.4.Final-SNAPSHOT
A B C D E F G H I K L M N O P R S T U V W 

A

adapt(Class<A>) - Method in interface org.gatein.mop.api.Adaptable
Returns an adapter for the specified type.
Adaptable - Interface in org.gatein.mop.api
The adapter pattern.
add(ObjectType<T>, String) - Method in interface org.gatein.mop.api.workspace.ui.UIContainer
 
add(int, ObjectType<T>, String) - Method in interface org.gatein.mop.api.workspace.ui.UIContainer
 
addChild(String) - Method in interface org.gatein.mop.api.workspace.Navigation
Adds a child navigation that will be added to the last position among the ordered children list.
addChild(Integer, String) - Method in interface org.gatein.mop.api.workspace.Navigation
Adds a child navigation that will be added to the specified position among the ordered children list.
addChild(String) - Method in interface org.gatein.mop.api.workspace.Page
Create a child page and returns it.
addSite(ObjectType<S>, String) - Method in interface org.gatein.mop.api.workspace.Workspace
Creates a new site.
ANY - Static variable in class org.gatein.mop.api.workspace.ObjectType
.
Attributes - Interface in org.gatein.mop.api
This interface extends a map to provide convenient method for dealing with attribute values in a type safe manner when the interface client knows the type of an attribute and wants to deal with it accordingly.

B

BODY - Static variable in class org.gatein.mop.api.workspace.ObjectType
.
BOOLEAN - Static variable in class org.gatein.mop.api.ValueType
.

C

cast(Object) - Method in class org.gatein.mop.api.ValueType
Casts the object to the underlying java type.
cast(Object) - Method in class org.gatein.mop.api.workspace.ObjectType
 
close() - Method in interface org.gatein.mop.api.Model
 
COMPONENT - Static variable in class org.gatein.mop.api.workspace.ObjectType
.
CONTAINER - Static variable in class org.gatein.mop.api.workspace.ObjectType
.
contains(CustomizationContext) - Method in interface org.gatein.mop.api.content.CustomizationContext
Returns true if the context contains the provided context.
Content<S> - Interface in org.gatein.mop.api.content
Representation of a content.
ContentLink - Interface in org.gatein.mop.api.workspace.link
A link to a content.
ContentType<S> - Class in org.gatein.mop.api.content
Represents a content type.
ContentType(String, Class<S>) - Constructor for class org.gatein.mop.api.content.ContentType
Create a new content type.
create(String, ValueType<T>) - Static method in class org.gatein.mop.api.Key
 
Customization<S> - Interface in org.gatein.mop.api.content
An entity representing the customization of a content.
CustomizationContext - Interface in org.gatein.mop.api.content
The customization context defines where customization applies, it can be an entity, an identity, or anything else that is subject to customization.
customize(Collection<CustomizationContext>) - Method in interface org.gatein.mop.api.content.Customization
Customize the state with respect to the provided customization context.
customize(ContentType<S>, String, S) - Method in interface org.gatein.mop.api.workspace.ui.UIWindow
Customizes the specified content.
customize(Customization<S>) - Method in interface org.gatein.mop.api.workspace.ui.UIWindow
Specialize the specified customization.
customize(String, ContentType<S>, String, S) - Method in interface org.gatein.mop.api.workspace.WorkspaceCustomizationContext
Configure a root customization for the specified content.
customize(String, Customization<S>) - Method in interface org.gatein.mop.api.workspace.WorkspaceCustomizationContext
Configure a customization for extending the specified customization.

D

DATE - Static variable in class org.gatein.mop.api.ValueType
.
decode(T) - Static method in class org.gatein.mop.api.ValueType
Returns the corresponding value type for the specified object or null if no valid one can be found.
destroy() - Method in interface org.gatein.mop.api.content.Customization
Destroys the customization.
destroy() - Method in interface org.gatein.mop.api.workspace.Navigation
Destroys this navigation.
destroy() - Method in interface org.gatein.mop.api.workspace.Page
Destroys the page.
destroy() - Method in interface org.gatein.mop.api.workspace.Site
Destroy the site.
DOUBLE - Static variable in class org.gatein.mop.api.ValueType
.

E

equals(Object) - Method in class org.gatein.mop.api.content.ContentType
 
equals(Object) - Method in class org.gatein.mop.api.Key
 

F

findCustomizationById(String) - Method in interface org.gatein.mop.api.Model
 
findObject(ObjectType<O>, String) - Method in interface org.gatein.mop.api.Model
 
findObjectById(ObjectType<O>, String) - Method in interface org.gatein.mop.api.Model
Returns a specified object or null if it cannot be found.
findObjectByPath(ObjectType<? extends O>, String) - Method in interface org.gatein.mop.api.Model
 

G

get(T) - Static method in class org.gatein.mop.api.ValueType
Returns the corresponding value type for the specified object.
get(String) - Method in interface org.gatein.mop.api.workspace.ui.UIContainer
 
getAttributes() - Method in interface org.gatein.mop.api.workspace.WorkspaceObject
Returns the object attributes.
getBoolean(String) - Method in interface org.gatein.mop.api.Attributes
 
getChild(String) - Method in interface org.gatein.mop.api.workspace.Navigation
Returns a specified navigation.
getChild(String) - Method in interface org.gatein.mop.api.workspace.Page
Returns a named child or null if it does not exist.
getChildren() - Method in interface org.gatein.mop.api.workspace.Navigation
Returns the child navigations.
getChildren() - Method in interface org.gatein.mop.api.workspace.Page
Returns the children.
getComponents() - Method in interface org.gatein.mop.api.workspace.ui.UIContainer
 
getContent() - Method in interface org.gatein.mop.api.content.Customization
Returns the content this customization refers to.
getContent() - Method in interface org.gatein.mop.api.workspace.link.ContentLink
Returns the link to a content.
getContentId() - Method in interface org.gatein.mop.api.content.Customization
Returns the content id this customization refers to.
getContext() - Method in interface org.gatein.mop.api.content.Customization
Returns the related context of this customization.
getContextId() - Method in interface org.gatein.mop.api.content.CustomizationContext
Returns the identifier of the context.
getContexts() - Method in interface org.gatein.mop.api.content.Customization
Returns the contexts that are associated with this customization.
getContextType() - Method in interface org.gatein.mop.api.content.CustomizationContext
Returns the customization context type.
getCustomization(Set<CustomizationContext>) - Method in interface org.gatein.mop.api.content.Customization
Returns the stateful content associated with the specified customization contexts or null if no customization can be created for the desired contexts.
getCustomization() - Method in interface org.gatein.mop.api.workspace.ui.UIWindow
Returns the customization of this window or null if no customization exists.
getCustomization(String) - Method in interface org.gatein.mop.api.workspace.WorkspaceCustomizationContext
The root customization.
getCustomizationContext() - Method in interface org.gatein.mop.api.workspace.Page
Returns the customization context of this object;
getCustomizationContext() - Method in interface org.gatein.mop.api.workspace.Site
Returns the customization context of this object;
getCustomizationContext() - Method in interface org.gatein.mop.api.workspace.Workspace
Returns the customization context of this object;
getDate(String) - Method in interface org.gatein.mop.api.Attributes
 
getDouble(String) - Method in interface org.gatein.mop.api.Attributes
 
getId() - Method in interface org.gatein.mop.api.content.Content
Returns the content id.
getId() - Method in interface org.gatein.mop.api.content.Customization
Returns the customization id
getIndex() - Method in interface org.gatein.mop.api.workspace.Navigation
Returns the index of this navigation.
getInteger(String) - Method in interface org.gatein.mop.api.Attributes
 
getJavaType() - Method in class org.gatein.mop.api.ValueType
Returns the java type.
getJavaType() - Method in class org.gatein.mop.api.workspace.ObjectType
 
getKeys() - Method in interface org.gatein.mop.api.Attributes
 
getLink() - Method in interface org.gatein.mop.api.workspace.Navigation
Returns the current link related to this navitation object.
getMimeType() - Method in class org.gatein.mop.api.content.ContentType
 
getName() - Method in class org.gatein.mop.api.Key
Returns the key name.
getName() - Method in interface org.gatein.mop.api.workspace.Navigation
Returns the navigation name.
getName() - Method in interface org.gatein.mop.api.workspace.Page
Returns the page name.
getName() - Method in interface org.gatein.mop.api.workspace.Site
Returns the site name.
getName() - Method in interface org.gatein.mop.api.workspace.ui.UIComponent
 
getNavigations() - Method in interface org.gatein.mop.api.workspace.Page
Returns the set of navigations pointing to this page.
getObject(String) - Method in interface org.gatein.mop.api.Attributes
 
getObjectId() - Method in interface org.gatein.mop.api.workspace.WorkspaceObject
Returns an id that uniquely identify the object in the workspace.
getObjectType() - Method in interface org.gatein.mop.api.workspace.Navigation
Extends the object type to navigation.
getObjectType() - Method in interface org.gatein.mop.api.workspace.Page
Returns the page type.
getObjectType() - Method in interface org.gatein.mop.api.workspace.Site
Returns a type that extends the site.
getObjectType() - Method in interface org.gatein.mop.api.workspace.ui.UIComponent
 
getObjectType() - Method in interface org.gatein.mop.api.workspace.WorkspaceObject
Returns the object type.
getPage() - Method in interface org.gatein.mop.api.workspace.link.PageLink
The target page.
getPage() - Method in interface org.gatein.mop.api.workspace.ui.UIComponent
 
getParent() - Method in interface org.gatein.mop.api.content.Customization
Returns the parent customization or null if this customization is full featured clone.
getParent() - Method in interface org.gatein.mop.api.workspace.Navigation
Return the navigation parent or null if it is a root.
getParent() - Method in interface org.gatein.mop.api.workspace.Page
Returns the parent page
getParent() - Method in interface org.gatein.mop.api.workspace.ui.UIComponent
 
getRootComponent() - Method in interface org.gatein.mop.api.workspace.Page
Returns the layout of the page.
getRootNavigation() - Method in interface org.gatein.mop.api.workspace.Site
Returns the site root navigation.
getRootPage() - Method in interface org.gatein.mop.api.workspace.Site
Returns the site root page.
getScope() - Method in interface org.gatein.mop.api.workspace.Templatized
Returns the scope of the related template.
getSite() - Method in interface org.gatein.mop.api.workspace.Navigation
Returns the site this navigation belongs to
getSite() - Method in interface org.gatein.mop.api.workspace.Page
Returns the site that owns the page.
getSite(ObjectType<S>, String) - Method in interface org.gatein.mop.api.workspace.Workspace
Returns a specified site or null if it cannot be found.
getSites(ObjectType<S>) - Method in interface org.gatein.mop.api.workspace.Workspace
Returns the sites of a given type.
getSites() - Method in interface org.gatein.mop.api.workspace.Workspace
Returns all the sites.
getState() - Method in interface org.gatein.mop.api.content.Customization
Returns the customization state.
getStateClass() - Method in class org.gatein.mop.api.content.ContentType
 
getString(String) - Method in interface org.gatein.mop.api.Attributes
 
getTemplate() - Method in interface org.gatein.mop.api.workspace.Templatized
Returns the page template or null if no page template exists.
getTemplatized() - Method in interface org.gatein.mop.api.workspace.Navigation
Returns the templatized aspect of this navigation when it exists.
getType(String) - Method in interface org.gatein.mop.api.Attributes
 
getType() - Method in interface org.gatein.mop.api.content.Content
Returns the content type.
getType() - Method in interface org.gatein.mop.api.content.Customization
Returns the content type this customization refers to.
getType() - Method in class org.gatein.mop.api.Key
Returns the key type.
getURL() - Method in interface org.gatein.mop.api.workspace.link.URLLink
Returns the link URL.
getValue(Key<T>) - Method in interface org.gatein.mop.api.Attributes
 
getValue(Key<T>, T) - Method in interface org.gatein.mop.api.Attributes
 
getVirtualState() - Method in interface org.gatein.mop.api.content.Customization
Returns the customization virtual state that is computed from various state of the customization hierarchy.
getWorkspace() - Method in interface org.gatein.mop.api.Model
Returns the workspace.
getWorkspace() - Method in interface org.gatein.mop.api.workspace.Site
Returns the site workspace.
GROUP_SITE - Static variable in class org.gatein.mop.api.workspace.ObjectType
.

H

hashCode() - Method in class org.gatein.mop.api.content.ContentType
 
hashCode() - Method in class org.gatein.mop.api.Key
 

I

INTEGER - Static variable in class org.gatein.mop.api.ValueType
.
isAdapted(Class<A>) - Method in interface org.gatein.mop.api.Adaptable
Returns true if the workspace object is adapted to the specified type.
isAssignableFrom(ObjectType<?>) - Method in class org.gatein.mop.api.workspace.ObjectType
 
isInstance(Object) - Method in class org.gatein.mop.api.ValueType
Returns true if the object matches the type.

K

Key<T> - Class in org.gatein.mop.api
A key is a typed name.
Key(String, ValueType<T>) - Constructor for class org.gatein.mop.api.Key
Creates a new key.

L

Link - Interface in org.gatein.mop.api.workspace.link
Symbolizes a link.
linkTo(ObjectType<L>) - Method in interface org.gatein.mop.api.workspace.Navigation
Link the navigation to a specifed type and returns the corresponding link subclass that allows the configuration of the link.

M

Model - Interface in org.gatein.mop.api
Provides access to the model.

N

nameOf(Customization) - Method in interface org.gatein.mop.api.workspace.WorkspaceCustomizationContext
Returns the customization name related to this context or null if the customization is not related to this context.
Navigation - Interface in org.gatein.mop.api.workspace
A navigation denotes a visual item that display a link to a referenced entity like a page.
NAVIGATION - Static variable in class org.gatein.mop.api.workspace.ObjectType
.

O

ObjectType<O extends WorkspaceObject> - Class in org.gatein.mop.api.workspace
A type safe interface for the type of a workspace object.
org.gatein.mop.api - package org.gatein.mop.api
 
org.gatein.mop.api.content - package org.gatein.mop.api.content
 
org.gatein.mop.api.workspace - package org.gatein.mop.api.workspace
 
org.gatein.mop.api.workspace.link - package org.gatein.mop.api.workspace.link
 
org.gatein.mop.api.workspace.ui - package org.gatein.mop.api.workspace.ui
 

P

PAGE - Static variable in class org.gatein.mop.api.workspace.ObjectType
.
Page - Interface in org.gatein.mop.api.workspace
A page is a pointer with useful information pointing to a component structure.
PAGE_LINK - Static variable in class org.gatein.mop.api.workspace.ObjectType
.
PageLink - Interface in org.gatein.mop.api.workspace.link
A link to a page.
pathOf(WorkspaceObject) - Method in interface org.gatein.mop.api.Model
 
PORTAL_SITE - Static variable in class org.gatein.mop.api.workspace.ObjectType
.

R

removeAdapter(Class<A>) - Method in interface org.gatein.mop.api.Adaptable
Removes the adapter from this adaptable object.

S

save() - Method in interface org.gatein.mop.api.Model
 
Scope - Enum in org.gatein.mop.api
A generic notion of scope.
setBoolean(String, Boolean) - Method in interface org.gatein.mop.api.Attributes
 
setContent(Content) - Method in interface org.gatein.mop.api.workspace.link.ContentLink
Updates the content linked.
setDate(String, Date) - Method in interface org.gatein.mop.api.Attributes
 
setDouble(String, Double) - Method in interface org.gatein.mop.api.Attributes
 
setInteger(String, Integer) - Method in interface org.gatein.mop.api.Attributes
 
setName(String) - Method in interface org.gatein.mop.api.workspace.Navigation
Update the navigation name.
setObject(String, T) - Method in interface org.gatein.mop.api.Attributes
 
setPage(Page) - Method in interface org.gatein.mop.api.workspace.link.PageLink
Updates the target page.
setScope(Scope) - Method in interface org.gatein.mop.api.workspace.Templatized
Set the scope of the related template.
setState(S) - Method in interface org.gatein.mop.api.content.Customization
Updates the customization state.
setString(String, String) - Method in interface org.gatein.mop.api.Attributes
 
setTemplate(Page) - Method in interface org.gatein.mop.api.workspace.Templatized
Updates the page template.
setURL(String) - Method in interface org.gatein.mop.api.workspace.link.URLLink
Sets the link URL.
setValue(Key<T>, T) - Method in interface org.gatein.mop.api.Attributes
 
SITE - Static variable in class org.gatein.mop.api.workspace.ObjectType
.
Site - Interface in org.gatein.mop.api.workspace
A site is a collection of pages and navigations.
STRING - Static variable in class org.gatein.mop.api.ValueType
.

T

templatize(WorkspaceObject) - Method in interface org.gatein.mop.api.workspace.Page
Templatize the provided object.
Templatized - Interface in org.gatein.mop.api.workspace
The templatized aspect defined by a related template and a scope that defines the template scope.
toString() - Method in class org.gatein.mop.api.Key
 
toString() - Method in class org.gatein.mop.api.ValueType
 
toString() - Method in class org.gatein.mop.api.workspace.ObjectType
 
TYPE - Static variable in interface org.gatein.mop.api.workspace.WorkspaceCustomizationContext
The context type returned that must be returned by implementations of the CustomizationContext.getContextType() method.

U

UIBody - Interface in org.gatein.mop.api.workspace.ui
The ui body denotes a place holder in a user interface structure.
UIComponent - Interface in org.gatein.mop.api.workspace.ui
 
UIContainer - Interface in org.gatein.mop.api.workspace.ui
 
UIWindow - Interface in org.gatein.mop.api.workspace.ui
The window is user interface component that points to a content.
URL_LINK - Static variable in class org.gatein.mop.api.workspace.ObjectType
.
URLLink - Interface in org.gatein.mop.api.workspace.link
A link to an URL.
USER_SITE - Static variable in class org.gatein.mop.api.workspace.ObjectType
.

V

valueOf(String) - Static method in enum org.gatein.mop.api.Scope
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.gatein.mop.api.Scope
Returns an array containing the constants of this enum type, in the order they are declared.
ValueType<T> - Class in org.gatein.mop.api
The enumeration of value type that are permitted for attributes state.

W

WINDOW - Static variable in class org.gatein.mop.api.workspace.ObjectType
.
WORKSPACE - Static variable in class org.gatein.mop.api.workspace.ObjectType
.
Workspace - Interface in org.gatein.mop.api.workspace
The workspace.
WorkspaceCustomizationContext - Interface in org.gatein.mop.api.workspace
A workspace customization context define root customization contexts.
WorkspaceObject - Interface in org.gatein.mop.api.workspace
A common interface for object living in the workspace.
A B C D E F G H I K L M N O P R S T U V W 
MOP API 1.3.4.Final-SNAPSHOT

Copyright © 2025 JBoss by Red Hat. All Rights Reserved.