oracle.epm.fm.domainobject.data.processflow

Class ProcessFlowOM

java.lang.Object

oracle.epm.fm.domainobject.data.processflow.ProcessFlowOM

All Implemented Interfaces:

Serializable

public class ProcessFlowOM
extends Object
implements Serializable

This class contains the API's for Process Flow.

Since:

PS2

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ProcessFlowOM(SessionInfo sessionInfo) Constructor to create ProcessFlowOM object.

Method Summary

Modifier and Type	Method and Description
EmailInfo	generatePMEmailAlerts(ServerPMTaskInfo taskInfo) Method to generate Email alerts information for the given task.
PhasedSubmissionInfo	getPhasedSubmissionGroupInfo(String scenario, List<Integer> phasesToDisplay) Method to get phase submission group information for the given scenario.
ProcessFlowInfo	getProcessFlowInfo(String povSlice) Method to retrieve process flow information for given pov.
ProcessFlowInfo	getProcessFlowInfo(String gridId, CellLocator cellLoc, int phaseId) Method to get process flow information for the process flow grid ID and specified cell and phase.
List<String>	getUnassignedGroups(String scenario, String period) Method to get phase submission group information for the given scenario and period.
Grid	getValidationGrid(String slice, int phase, WEBOM_PROCESS_CONTROL_DATA_VIEW dataView, boolean suppressNoData, boolean suppressZeros, boolean formatData) Method to get the validation grid for process flow.
ProcessControlGridCalcStatusSummary	retrieveCalcStatusSummary(String gridId) Method to retrieve Process Flow Calc Status.
void	setPhasedSubmissionGroups(String scenario, PhasedSubmissionInfo phaseSubmissioUpdates) Method to set phase submission group information for the given scenario.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProcessFlowOM

public ProcessFlowOM(SessionInfo sessionInfo)
              throws HFMException

Constructor to create ProcessFlowOM object.

Parameters:

sessionInfo - SessionInfo object which contain the session ID, servername and port number

Throws:

HFMException

Method Detail

retrieveCalcStatusSummary

public ProcessControlGridCalcStatusSummary retrieveCalcStatusSummary(String gridId)
                                                              throws HFMException

Method to retrieve Process Flow Calc Status.

Parameters:

gridId - The process flow grid id

Returns:

ProcessControlGridCalcStatusSummary object containing the requested data

Throws:

HFMException

getProcessFlowInfo

public ProcessFlowInfo getProcessFlowInfo(String povSlice)
                                   throws HFMException

Method to retrieve process flow information for given pov.

Parameters:

povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...

Returns:

ProcessFlowInfo object containing the requested information

Throws:

HFMException

getProcessFlowInfo

public ProcessFlowInfo getProcessFlowInfo(String gridId,
                                          CellLocator cellLoc,
                                          int phaseId)
                                   throws HFMException

Method to get process flow information for the process flow grid ID and specified cell and phase.

Parameters:

gridId - The process flow grid ID

cellLoc - The object that contains cell locator

phaseId - The phase ID

Returns:

ProcessFlowInfo object containing the requested information

Throws:

HFMException

getValidationGrid

public Grid getValidationGrid(String slice,
                              int phase,
                              WEBOM_PROCESS_CONTROL_DATA_VIEW dataView,
                              boolean suppressNoData,
                              boolean suppressZeros,
                              boolean formatData)
                       throws HFMException

Method to get the validation grid for process flow.

Parameters:

slice - POV in HFM standard notation, e.g., S#Actual.Y#2011...

phase - phase ID

dataView - Enum to specify process flow data view

suppressNoData - If true supress NoData

suppressZeros - If true supress zeros

formatData - If true format data

Returns:

Grid object containing the requested information

Throws:

HFMException

generatePMEmailAlerts

public EmailInfo generatePMEmailAlerts(ServerPMTaskInfo taskInfo)
                                throws HFMException

Method to generate Email alerts information for the given task.

Parameters:

taskInfo - ServerPMTaskInfo object containing the task information

Returns:

EmailInfo object containing requested information

Throws:

HFMException

getPhasedSubmissionGroupInfo

public PhasedSubmissionInfo getPhasedSubmissionGroupInfo(String scenario,
                                                         List<Integer> phasesToDisplay)
                                                  throws HFMException

Method to get phase submission group information for the given scenario.

Parameters:

scenario - The scenario

Returns:

PhasedSubmissionInfo object containing the requested information

Throws:

HFMException

getUnassignedGroups

public List<String> getUnassignedGroups(String scenario,
                                        String period)
                                 throws HFMException

Method to get phase submission group information for the given scenario and period.

Parameters:

scenario - The scenario

period - The Period

Returns:

List of unasigned phase submission groups for given scenario and period

Throws:

HFMException

setPhasedSubmissionGroups

public void setPhasedSubmissionGroups(String scenario,
                                      PhasedSubmissionInfo phaseSubmissioUpdates)
                               throws HFMException

Method to set phase submission group information for the given scenario.

Parameters:

scenario - The scenario

phaseSubmissioUpdates - Updated phase submission groups for scenario.

Throws:

HFMException