com.flowcentraltech.flowcentral.chart.business

Interface ChartModuleService

All Superinterfaces:

com.tcdng.unify.core.business.BusinessService, com.tcdng.unify.core.application.FeatureInstaller<ModuleInstall>, FlowCentralService, com.tcdng.unify.core.UnifyComponent

All Known Implementing Classes:

ChartModuleServiceImpl

public interface ChartModuleService
extends FlowCentralService

Chart business service.

Since:

1.0

Author:

FlowCentral Technologies Limited

Method Summary

Modifier and Type	Method and Description
Chart	findChart(Long chartId) Finds chart by ID.
List<Long>	findChartIdList(String applicationName) Finds chart ID list for application.
List<Chart>	findCharts(ChartQuery query) Finds charts by criteria.
List<ChartSnapshot>	findChartSnapshots(ChartSnapshotQuery query) Finds snapshots by criteria.
ChartDef	getChartDef(String chartName) Gets a chart definition.
ChartSnapshotDef	getChartSnapshotDef(String snapshotName) Gets a chart snapshot definition.
boolean	isChartSnapshotExist(String snapshotName) Checks if chart snapshot exists.
void	saveChartSnapshot(ChartSnapshot chartSnapshot) Saves a chart snapshot.

Methods inherited from interface com.tcdng.unify.core.business.BusinessService

getExtendedInstance, getNow, getToday, tm

Methods inherited from interface com.tcdng.unify.core.application.FeatureInstaller

installFeatures

Methods inherited from interface com.tcdng.unify.core.UnifyComponent

getName, getUnifyComponentContext, initialize, isInitialized, terminate

Method Detail

findCharts

List<Chart> findCharts(ChartQuery query)
                throws com.tcdng.unify.core.UnifyException

Finds charts by criteria.

Parameters:

query - the query object

Returns:

list of charts

Throws:

com.tcdng.unify.core.UnifyException - if an error occurs

findChart

Chart findChart(Long chartId)
         throws com.tcdng.unify.core.UnifyException

Finds chart by ID.

Parameters:

chartId - the chart ID

Returns:

the chart

Throws:

com.tcdng.unify.core.UnifyException - if chart with ID is not found. If an error occurs

findChartIdList

List<Long> findChartIdList(String applicationName)
                    throws com.tcdng.unify.core.UnifyException

Finds chart ID list for application.

Parameters:

applicationName - the application name

Returns:

list of application chart IDs

Throws:

com.tcdng.unify.core.UnifyException - if an error occurs

findChartSnapshots

List<ChartSnapshot> findChartSnapshots(ChartSnapshotQuery query)
                                throws com.tcdng.unify.core.UnifyException

Finds snapshots by criteria.

Parameters:

query - the query object

Returns:

list of chart snapshots

Throws:

com.tcdng.unify.core.UnifyException - if an error occurs

getChartDef

ChartDef getChartDef(String chartName)
              throws com.tcdng.unify.core.UnifyException

Gets a chart definition.

Parameters:

chartName - the chart long name

Returns:

the chart definition

Throws:

com.tcdng.unify.core.UnifyException - if an error occurs

getChartSnapshotDef

ChartSnapshotDef getChartSnapshotDef(String snapshotName)
                              throws com.tcdng.unify.core.UnifyException

Gets a chart snapshot definition.

Parameters:

snapshotName - the snapshot name

Returns:

the chart snapshot

Throws:

com.tcdng.unify.core.UnifyException - if an error occurs

isChartSnapshotExist

boolean isChartSnapshotExist(String snapshotName)
                      throws com.tcdng.unify.core.UnifyException

Checks if chart snapshot exists.

Parameters:

snapshotName - the snapshot name

Returns:

true if snapshot with name exists otherwise false

Throws:

com.tcdng.unify.core.UnifyException - if an error occurs

saveChartSnapshot

void saveChartSnapshot(ChartSnapshot chartSnapshot)
                throws com.tcdng.unify.core.UnifyException

Saves a chart snapshot. Updates existing record or creates a new one if necessary.

Parameters:

chartSnapshot - the snapshot to save

Throws:

com.tcdng.unify.core.UnifyException - if an error occurs