com.foreach.across.modules.webcms.domain.component.model

Interface WebCmsComponentModelService

public interface WebCmsComponentModelService

Core API for interacting with renderable/editable WebCmsComponentModels.

Since:

0.0.1

Author:

Arne Vandamme

Method Summary

Modifier and Type	Method and Description
WebCmsComponentModelSet	buildComponentModelSetForOwner(WebCmsObject object, boolean eager) Build a WebCmsComponentModelSet for all components owned by the WebCmsObject, and attached to the current domain.
WebCmsComponentModelSet	buildComponentModelSetForOwner(WebCmsObject object, WebCmsDomain domain, boolean eager) Build a WebCmsComponentModelSet for all components owned by the WebCmsObject, and attached to the specified domain.
WebCmsComponentModel	buildModelForComponent(WebCmsComponent component) Build the WebCmsComponentModel for a particular WebCmsComponent entity.
<U extends WebCmsComponentModel> U	buildModelForComponent(WebCmsComponent component, Class<U> expectedType) Build the WebCmsComponentModel for a particular WebCmsComponent entity.
<U extends WebCmsComponentModel> U	createComponentModel(String componentTypeKey, Class<U> expectedType) Create a new component model for a specific component type.
<U extends WebCmsComponentModel> U	createComponentModel(String componentTypeKey, WebCmsDomain domain, Class<U> expectedType) Create a new component model for a specific component type on the specified domain.
<U extends WebCmsComponentModel> U	createComponentModel(WebCmsComponentType componentType, Class<U> expectedType) Create a new component model for a specific component type, on the current domain.
WebCmsComponentModel	getComponentModel(String objectId) Get the component model for a specific WebCmsComponent identified by its object id.
<U extends WebCmsComponentModel> U	getComponentModel(String objectId, Class<U> expectedType) Get the component model for a specific WebCmsComponent identified by its object id.
WebCmsComponentModel	getComponentModelByName(String componentName, WebCmsObject owner) Get a single WebCmsComponentModel for a specific owner by name.
<U extends WebCmsComponentModel> U	getComponentModelByName(String componentName, WebCmsObject owner, Class<U> expectedType) Get a single WebCmsComponentModel by name.
WebCmsComponentModel	getComponentModelByNameAndDomain(String componentName, WebCmsObject owner, WebCmsDomain domain) Get a single WebCmsComponentModel for a specific owner by name and domain.
<U extends WebCmsComponentModel> U	getComponentModelByNameAndDomain(String componentName, WebCmsObject owner, WebCmsDomain domain, Class<U> expectedType) Get a single WebCmsComponentModel for a specific owner by name and domain.
Collection<WebCmsComponentModel>	getComponentModelsForOwner(WebCmsObject object) Return all components owned by the WebCmsObject on the current domain, according to their sort order.
Collection<WebCmsComponentModel>	getComponentModelsForOwner(WebCmsObject object, WebCmsDomain domain) Return all components owned by the WebCmsObject on the specific domain, according to their sort order.
WebCmsComponentType	getComponentType(String componentTypeKey) Get the component type represented by the type key.
WebCmsComponentType	getComponentType(String componentTypeKey, WebCmsDomain domain) Get the component type represented by the type key on the specified domain.
WebCmsComponent	save(WebCmsComponent component) Save a WebCmsComponent to the repository.
WebCmsComponent	save(WebCmsComponentModel componentModel) Save a WebCmsComponentModel to the repository.

Method Detail

getComponentType

WebCmsComponentType getComponentType(String componentTypeKey)

Get the component type represented by the type key. Will use the current domain to look for component types.

Parameters:

componentTypeKey - type key

Returns:

type or null if not found

getComponentType

WebCmsComponentType getComponentType(String componentTypeKey,
                                     WebCmsDomain domain)

Get the component type represented by the type key on the specified domain.

Parameters:

componentTypeKey - type key

domain - to scan

Returns:

type of null if not found

createComponentModel

<U extends WebCmsComponentModel> U createComponentModel(String componentTypeKey,
                                                        Class<U> expectedType)

Create a new component model for a specific component type.

Parameters:

componentTypeKey - to create model for

expectedType - type to coerce to

Returns:

model

createComponentModel

<U extends WebCmsComponentModel> U createComponentModel(String componentTypeKey,
                                                        WebCmsDomain domain,
                                                        Class<U> expectedType)

Create a new component model for a specific component type on the specified domain. Component will be added to that domain and component type will be looked for in the domain.

Parameters:

componentTypeKey - to create model for

expectedType - type to coerce to

Returns:

model

createComponentModel

<U extends WebCmsComponentModel> U createComponentModel(WebCmsComponentType componentType,
                                                        Class<U> expectedType)

Create a new component model for a specific component type, on the current domain.

Parameters:

componentType - to create model for

expectedType - type to coerce to

Returns:

model

getComponentModel

WebCmsComponentModel getComponentModel(String objectId)

Get the component model for a specific WebCmsComponent identified by its object id.

Parameters:

objectId - of the component

Returns:

component model or null if not a valid component

getComponentModel

<U extends WebCmsComponentModel> U getComponentModel(String objectId,
                                                     Class<U> expectedType)

Get the component model for a specific WebCmsComponent identified by its object id.

Parameters:

objectId - of the component

expectedType - type to coerce to

Returns:

component model or null if not a valid component

getComponentModelByName

WebCmsComponentModel getComponentModelByName(String componentName,
                                             WebCmsObject owner)

Get a single WebCmsComponentModel for a specific owner by name. Calls getComponentModelByNameAndDomain(String, WebCmsObject, WebCmsDomain) with the domain of the owner object, if it is an instance of WebCmsComponentType, otherwise with the domain provided by com.foreach.across.modules.webcms.domain.domain.WebCmsMultiDomainService#getCurrentDomainForType(Class).

Parameters:

componentName - name of the component

owner - of the component

Returns:

component or null if not found

getComponentModelByNameAndDomain

WebCmsComponentModel getComponentModelByNameAndDomain(String componentName,
                                                      WebCmsObject owner,
                                                      WebCmsDomain domain)

Get a single WebCmsComponentModel for a specific owner by name and domain.

Parameters:

componentName - name of the component

owner - of the component

domain - domain of the component

Returns:

component or null if not found

getComponentModelByName

<U extends WebCmsComponentModel> U getComponentModelByName(String componentName,
                                                           WebCmsObject owner,
                                                           Class<U> expectedType)

Get a single WebCmsComponentModel by name. Will use the context-bound domain to lookup the component.

Parameters:

componentName - name of the component

owner - of the component

expectedType - type to coerce to

Returns:

component or null if not found

getComponentModelByNameAndDomain

<U extends WebCmsComponentModel> U getComponentModelByNameAndDomain(String componentName,
                                                                    WebCmsObject owner,
                                                                    WebCmsDomain domain,
                                                                    Class<U> expectedType)

Get a single WebCmsComponentModel for a specific owner by name and domain.

Parameters:

componentName - name of the component

owner - of the component

domain - domain of the component

expectedType - type to coerce to

Returns:

component or null if not found

getComponentModelsForOwner

Collection<WebCmsComponentModel> getComponentModelsForOwner(WebCmsObject object)

Return all components owned by the WebCmsObject on the current domain, according to their sort order.

Parameters:

object - owner

Returns:

ordered collection of components

getComponentModelsForOwner

Collection<WebCmsComponentModel> getComponentModelsForOwner(WebCmsObject object,
                                                            WebCmsDomain domain)

Return all components owned by the WebCmsObject on the specific domain, according to their sort order.

Parameters:

object - owner

domain - the components should be attached to

Returns:

ordered collection of components

buildComponentModelSetForOwner

WebCmsComponentModelSet buildComponentModelSetForOwner(WebCmsObject object,
                                                       boolean eager)

Build a WebCmsComponentModelSet for all components owned by the WebCmsObject, and attached to the current domain.

The returned set only contains components with a configured name.

Parameters:

object - owner

eager - true if component models should all be fetched eagerly, if false the set will only fetch the component when it is being requested

Returns:

set of components

buildComponentModelSetForOwner

WebCmsComponentModelSet buildComponentModelSetForOwner(WebCmsObject object,
                                                       WebCmsDomain domain,
                                                       boolean eager)

Build a WebCmsComponentModelSet for all components owned by the WebCmsObject, and attached to the specified domain.

The returned set only contains components with a configured name.

Parameters:

object - owner

domain - the components should be attached to

eager - true if component models should all be fetched eagerly, if false the set will only fetch the component when it is being requested

Returns:

set of components

buildModelForComponent

WebCmsComponentModel buildModelForComponent(WebCmsComponent component)

Build the WebCmsComponentModel for a particular WebCmsComponent entity.

Parameters:

component - to build the model for

Returns:

model

buildModelForComponent

<U extends WebCmsComponentModel> U buildModelForComponent(WebCmsComponent component,
                                                          Class<U> expectedType)

Build the WebCmsComponentModel for a particular WebCmsComponent entity.

Parameters:

component - to build the model for

expectedType - type to coerce to

Returns:

model

save

WebCmsComponent save(WebCmsComponent component)

Save a WebCmsComponent to the repository. If the component is a new component, this will build the component model before saving, ensuring support for component templates.

Parameters:

component - to save

Returns:

component

save

WebCmsComponent save(WebCmsComponentModel componentModel)

Save a WebCmsComponentModel to the repository. The return value is the main WebCmsComponent that this model represents.

Parameters:

componentModel - to save

Returns:

component