org.carewebframework.shell.layout

Interface ILayoutService

All Known Implementing Classes:

LayoutService

public interface ILayoutService

Interface for implementing layout management.

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) Returns content of 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.

Method Detail

validateName

boolean validateName(String name)

Validates a layout name.

Parameters:

name - Layout name to validate.

Returns:

True if the name is valid.

layoutExists

boolean layoutExists(LayoutIdentifier layout)

Returns true if the specified layout exists.

Parameters:

layout - The layout identifier.

Returns:

True if layout exists.

saveLayout

void saveLayout(LayoutIdentifier layout,
                String content)

Saves a layout with the specified name and content.

Parameters:

layout - The layout identifier.

content - The layout content.

renameLayout

void renameLayout(LayoutIdentifier layout,
                  String newName)

Rename a layout.

Parameters:

layout - The original layout identifier.

newName - The new layout name.

cloneLayout

void cloneLayout(LayoutIdentifier layout,
                 LayoutIdentifier layout2)

Clone a layout.

Parameters:

layout - The original layout identifier.

layout2 - The new layout identifier.

deleteLayout

void deleteLayout(LayoutIdentifier layout)

Delete a layout.

Parameters:

layout - The layout identifier.

getLayoutContent

String getLayoutContent(LayoutIdentifier layout)

Returns the layout content.

Parameters:

layout - The layout identifier.

Returns:

The layout content.

getLayoutContentByAppId

String getLayoutContentByAppId(String appId)

Returns content of the layout associated with the specified application id.

Parameters:

appId - An application id.

Returns:

The layout content.

getLayouts

List<String> getLayouts(boolean shared)

Returns a list of saved layouts.

Parameters:

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

Returns:

List of saved layouts.