org.carewebframework.shell.layout

Class LayoutService

java.lang.Object

org.carewebframework.shell.layout.LayoutService

All Implemented Interfaces:

ILayoutService

public class LayoutService
extends Object
implements ILayoutService

Default layout service implementation using property service for persistence.

Constructor Summary

Constructors

Constructor and Description
LayoutService(org.carewebframework.api.property.IPropertyService propertyService)

Method Summary

Modifier and Type	Method and Description
void	cloneLayout(LayoutIdentifier layout, LayoutIdentifier layout2) Clone a layout.
void	deleteLayout(LayoutIdentifier layout) Delete a layout.
String	getLayoutContent(LayoutIdentifier layout) Returns the layout content.
String	getLayoutContentByAppId(String appId) Load the layout associated with the specified application id.
List<String>	getLayouts(boolean shared) Returns a list of saved layouts.
boolean	layoutExists(LayoutIdentifier layout) Returns true if the specified layout exists.
void	renameLayout(LayoutIdentifier layout, String newName) Rename a layout.
void	saveLayout(LayoutIdentifier layout, String content) Saves a layout with the specified name and content.
boolean	validateName(String name) Validates a layout name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LayoutService

public LayoutService(org.carewebframework.api.property.IPropertyService propertyService)

Method Detail

validateName

public boolean validateName(String name)

Validates a layout name.

Specified by:

validateName in interface ILayoutService

Parameters:

name - Layout name to validate.

Returns:

True if the name is valid.

layoutExists

public boolean layoutExists(LayoutIdentifier layout)

Returns true if the specified layout exists.

Specified by:

layoutExists in interface ILayoutService

Parameters:

layout - The layout identifier.

Returns:

True if layout exists.

saveLayout

public void saveLayout(LayoutIdentifier layout,
                       String content)

Saves a layout with the specified name and content.

Specified by:

saveLayout in interface ILayoutService

Parameters:

layout - The layout identifier.

content - The layout content.

renameLayout

public void renameLayout(LayoutIdentifier layout,
                         String newName)

Rename a layout.

Specified by:

renameLayout in interface ILayoutService

Parameters:

layout - The original layout identifier.

newName - The new layout name.

cloneLayout

public void cloneLayout(LayoutIdentifier layout,
                        LayoutIdentifier layout2)

Clone a layout.

Specified by:

cloneLayout in interface ILayoutService

Parameters:

layout - The original layout identifier.

layout2 - The new layout identifier.

deleteLayout

public void deleteLayout(LayoutIdentifier layout)

Delete a layout.

Specified by:

deleteLayout in interface ILayoutService

Parameters:

layout - The layout identifier.

getLayoutContent

public String getLayoutContent(LayoutIdentifier layout)

Returns the layout content.

Specified by:

getLayoutContent in interface ILayoutService

Parameters:

layout - The layout identifier.

Returns:

The layout content.

getLayoutContentByAppId

public String getLayoutContentByAppId(String appId)

Load the layout associated with the specified application id.

Specified by:

getLayoutContentByAppId in interface ILayoutService

Parameters:

appId - An application id.

Returns:

The layout content.

getLayouts

public List<String> getLayouts(boolean shared)

Returns a list of saved layouts.

Specified by:

getLayouts in interface ILayoutService

Parameters:

shared - If true, return shared layouts; otherwise, return personal layouts.

Returns:

List of saved layouts.