pe.pase

Interface DashboardService

public interface DashboardService

DashboardService API.

Since:

Agentflow 3.0

Author:

Kyle

Method Summary

Modifier and Type	Method and Description
boolean	addPortletIDByDashboardId(java.lang.String dboardId, java.lang.String portletID)
boolean	deleteDashboard(java.lang.String boardId) Deletes a Dashboard and its style list.
boolean	deleteDashboardStyle(java.lang.String styleId) Deletes a DashboardStyle from table.
boolean	deletePortalIDByPortletID(java.lang.String portletID)
java.util.List	getAllDashboardIdList()
Dashboard	getDashboard(java.lang.String boardId) Returns a Dashboard object by a given Dashboard id.
java.util.HashMap	getDashboardByPortletID(java.lang.String getDashboardIDByPortletID) Get the DashboardID to show Dashboard in Portlet.
java.util.List	getDashboardDetailTaskList(java.lang.String proID, java.lang.String taskState, java.lang.String startTime, java.lang.String endTime, boolean isExcludeDrafts, int sortTypeFromSession, java.lang.Object isFullAndTinyListExist, boolean isInComplete, java.lang.Object isViewFullRange, java.lang.Object isFullTinyListNextPageExist, boolean isDESCFromSession)
java.util.List	getDashboardFilterDetailTaskList(java.lang.String proID, java.lang.String filterType, java.lang.String filterKeywords, java.lang.String startTime, java.lang.String endTime, boolean isExcludeDrafts, int sortTypeFromSession, boolean isInComplete, boolean isDESCFromSession)
java.util.List	getDashboardGroupList() Gets a list of group from Dashboard without duplicated.
java.util.List	getDashboardGroupList(java.lang.String proId) Gets a list of group from Dashboard by the given process id.
java.util.List	getDashboardGroupListOfUser(java.lang.String memId, boolean isMainRoleOnly) Gets a list of group of user's from Dashboard without duplicated.
java.lang.String	getDashboardId(java.lang.String prjId, java.lang.String proId, java.lang.String grpId) Gets a Dashboard id by the given value.
java.util.List	getDashboardIdListByGroup(java.lang.String grpId)
java.util.List	getDashboardList() Gets a dashboard list.
java.util.List	getDashboardListByConditionType(java.lang.String columnName, int relation, java.lang.String columnValue) Gets a dashboard list by condition type.
java.util.List	getDashboardListByConditionType(java.lang.String columnName, int relation, java.lang.String columnValue, java.lang.String locale)
java.util.List	getDashboardListByGroup(java.lang.String grpId) Gets a dashboard list by the given group id, which contains each id's name.
java.util.List	getDashboardProcessList(java.lang.String prjId) Gets a list of process from Dashboard by the given project id.
java.util.List	getDashboardProjectList() Gets a list of project form Dashboard without duplicate.
java.util.List	getDashboardStyleIdList(java.lang.String boardId) Gets DashboardStyle id list of a dashboard by a given value.
java.util.List	getDashboardStyleList(java.lang.String boardId) Gets a DashboardStyle list by a given value.
java.util.List	getDashboardTaskList(java.lang.String proID, java.lang.String taskState, java.lang.String startTime, java.lang.String endTime, boolean isExcludeDrafts)
boolean	insertDashboard(Dashboard dboard) Adds a Dashboard only.
boolean	insertDashboardStyle(DashboardStyle dstyle) Adds a DashboardStyle into table.
boolean	isDashboardExist(java.lang.String prjId, java.lang.String proId, java.lang.String grpId) Test dashboard exist or not by the given value.
boolean	isDashboardStyleSiblingOrderExist(java.lang.String boardId, int siblingOrder) Tests whether the dashboard style's SiblingOrder exist or not.
Dashboard	newDashboard() Create a new Dashboard with a new system id which get from System.
DashboardStyle	newDashboardStyle(java.lang.String boardId) Create a new DashboardStyle with a new system id which get from System.
boolean	updateDashboard(Dashboard dboard) Updates a Dashboard only.
boolean	updateDashboardStyle(DashboardStyle dstyle) Updates a DashboardStyle from table.
boolean	updateDashOfPortletByPortletId(java.lang.String dboardId, java.lang.String portletId)

Method Detail

getDashboardList

java.util.List getDashboardList()

Gets a dashboard list.

Returns:

each element is a Dashboard object.

See Also:

com.flowring.dashboard.Dashboard

getDashboardListByConditionType

java.util.List getDashboardListByConditionType(java.lang.String columnName,
                                               int relation,
                                               java.lang.String columnValue,
                                               java.lang.String locale)

getDashboardListByConditionType

java.util.List getDashboardListByConditionType(java.lang.String columnName,
                                               int relation,
                                               java.lang.String columnValue)

Gets a dashboard list by condition type. For a example:

 String columnName = "GID"; //MUST be a AF_Dashboard column name
 int relation = "LIKE";
 String columnValue = "value";
 
 List dboards = wfci.getDashboardListByConditionType(columnName, relation, columnValue);
 

Returns:

each element is a Dashboard object.

getDashboardListByGroup

java.util.List getDashboardListByGroup(java.lang.String grpId)

Gets a dashboard list by the given group id, which contains each id's name.

Parameters:

grpId - a group id, see PASEGroup.

Returns:

each element is a Dashboard object.

See Also:

PASEGroup, com.flowring.dashboard.Dashboard

newDashboard

Dashboard newDashboard()

Create a new Dashboard with a new system id which get from System.

Returns:

a new Dashboard object.

getDashboard

Dashboard getDashboard(java.lang.String boardId)

Returns a Dashboard object by a given Dashboard id.

Parameters:

boardId - a Dashboard id.

Returns:

a Dashboard object.

getDashboardProjectList

java.util.List getDashboardProjectList()

Gets a list of project form Dashboard without duplicate.

Returns:

each element is a Project object.

See Also:

Project

getDashboardProcessList

java.util.List getDashboardProcessList(java.lang.String prjId)

Gets a list of process from Dashboard by the given project id.

Parameters:

prjId - a project id.

Returns:

each element is a DBProcess object, and each process is a root process.

See Also:

DBProcess

getDashboardGroupList

java.util.List getDashboardGroupList()

Gets a list of group from Dashboard without duplicated.

Returns:

each element is a PASEGroup object.

See Also:

PASEGroup

getDashboardGroupListOfUser

java.util.List getDashboardGroupListOfUser(java.lang.String memId,
                                           boolean isMainRoleOnly)

Gets a list of group of user's from Dashboard without duplicated.

Parameters:

memId - a member id.

isMainRoleOnly - if true, only the MainRole will be retrived; if false ,all role will be retrived.

Returns:

each element is a PASEGroup object.

See Also:

PASEGroup

getDashboardGroupList

java.util.List getDashboardGroupList(java.lang.String proId)

Gets a list of group from Dashboard by the given process id.

Parameters:

proId - a process id.

Returns:

each element is a PASEGroup object.

See Also:

PASEGroup

insertDashboard

boolean insertDashboard(Dashboard dboard)

Adds a Dashboard only.

NOTE: It will not insert its style list, using insertDashboardStyle(DashboardStyle) to insert its style.

Parameters:

dboard - a Dashboard object.

Returns:

true if insert success; false otherwise.

See Also:

com.flowring.dashboard.Dashboard

updateDashboard

boolean updateDashboard(Dashboard dboard)

Updates a Dashboard only.

NOTE: It will not update its style list, using updateDashboardStyle(DashboardStyle) to update its style.

Parameters:

dboard - a Dashboard object.

Returns:

true if update success; false otherwise.

See Also:

com.flowring.dashboard.Dashboard

deleteDashboard

boolean deleteDashboard(java.lang.String boardId)

Deletes a Dashboard and its style list.

NOTE: It will delete its style list.

Parameters:

boardId - a dashboard id.

Returns:

true if delete success; false otherwise.

getDashboardId

java.lang.String getDashboardId(java.lang.String prjId,
                                java.lang.String proId,
                                java.lang.String grpId)

Gets a Dashboard id by the given value.

Parameters:

prjId - a project id.

proId - a process id.

grpId - a group id.

Returns:

a dashboard id, or null if not found.

See Also:

Project, DBProcess, PASEGroup

isDashboardExist

boolean isDashboardExist(java.lang.String prjId,
                         java.lang.String proId,
                         java.lang.String grpId)

Test dashboard exist or not by the given value.

Parameters:

prjId - a project id.

proId - a process id.

grpId - a group id.

Returns:

true if dashboard is exist; false otherwise.

See Also:

Project, DBProcess, PASEGroup

getDashboardStyleList

java.util.List getDashboardStyleList(java.lang.String boardId)

Gets a DashboardStyle list by a given value.

Parameters:

boardId - a Dashboard id.

Returns:

each element is a DashboardStyle object.

See Also:

com.flowring.dashboard.DashboardStyle

newDashboardStyle

DashboardStyle newDashboardStyle(java.lang.String boardId)

Create a new DashboardStyle with a new system id which get from System.

Parameters:

boardId - a Dashboard id.

Returns:

a new DashboardsStyle object.

getDashboardStyleIdList

java.util.List getDashboardStyleIdList(java.lang.String boardId)

Gets DashboardStyle id list of a dashboard by a given value.

Parameters:

boardId - a dashboard id.

Returns:

each element is a dashboard id.

insertDashboardStyle

boolean insertDashboardStyle(DashboardStyle dstyle)

Adds a DashboardStyle into table.

Parameters:

dstyle - a DashboardStyle object.

Returns:

true if insert success; false otherwise.

See Also:

com.flowring.dashboard.DashboardStyle

updateDashboardStyle

boolean updateDashboardStyle(DashboardStyle dstyle)

Updates a DashboardStyle from table.

Parameters:

dstyle - a DashboardStyle object.

Returns:

true if update success; false otherwise.

See Also:

com.flowring.dashboard.DashboardStyle

deleteDashboardStyle

boolean deleteDashboardStyle(java.lang.String styleId)

Deletes a DashboardStyle from table.

Parameters:

styleId - a DashboardStyle id.

Returns:

true if delete success; false otherwise.

isDashboardStyleSiblingOrderExist

boolean isDashboardStyleSiblingOrderExist(java.lang.String boardId,
                                          int siblingOrder)

Tests whether the dashboard style's SiblingOrder exist or not.

Parameters:

boardId - a dashboard id.

siblingOrder - a dashboard style's sibling order for view.

Returns:

true if exist; false otherwise.

getDashboardByPortletID

java.util.HashMap getDashboardByPortletID(java.lang.String getDashboardIDByPortletID)

Get the DashboardID to show Dashboard in Portlet.

Parameters:

PortletID,Which - one protlet to show Dashboard.

Returns:

since version EIP

addPortletIDByDashboardId

boolean addPortletIDByDashboardId(java.lang.String dboardId,
                                  java.lang.String portletID)

updateDashOfPortletByPortletId

boolean updateDashOfPortletByPortletId(java.lang.String dboardId,
                                       java.lang.String portletId)

deletePortalIDByPortletID

boolean deletePortalIDByPortletID(java.lang.String portletID)

getDashboardIdListByGroup

java.util.List getDashboardIdListByGroup(java.lang.String grpId)

getAllDashboardIdList

java.util.List getAllDashboardIdList()

getDashboardTaskList

java.util.List getDashboardTaskList(java.lang.String proID,
                                    java.lang.String taskState,
                                    java.lang.String startTime,
                                    java.lang.String endTime,
                                    boolean isExcludeDrafts)

getDashboardDetailTaskList

java.util.List getDashboardDetailTaskList(java.lang.String proID,
                                          java.lang.String taskState,
                                          java.lang.String startTime,
                                          java.lang.String endTime,
                                          boolean isExcludeDrafts,
                                          int sortTypeFromSession,
                                          java.lang.Object isFullAndTinyListExist,
                                          boolean isInComplete,
                                          java.lang.Object isViewFullRange,
                                          java.lang.Object isFullTinyListNextPageExist,
                                          boolean isDESCFromSession)

getDashboardFilterDetailTaskList

java.util.List getDashboardFilterDetailTaskList(java.lang.String proID,
                                                java.lang.String filterType,
                                                java.lang.String filterKeywords,
                                                java.lang.String startTime,
                                                java.lang.String endTime,
                                                boolean isExcludeDrafts,
                                                int sortTypeFromSession,
                                                boolean isInComplete,
                                                boolean isDESCFromSession)