DataOM (Java API Reference for Oracle Hyperion Financial Management Release 11.2)

java.lang.Object
- oracle.epm.fm.domainobject.data.DataOM

All Implemented Interfaces:: Serializable

public class DataOM
extends Object
implements Serializable

This class contains the API's for common data funtions.

Since:

PS2

 
 getCellsInfo API is used to retrieve information about Data cells.

   DataOM dataOM = new DataOM(session);
   String pov = "S#Actual.Y#2015.P#January.W#<Scenario View>.E#[None].V#<Entity Currency>.A#[None].I#[ICP None].PROD#[None].CUST#[None].CHNL#[None].FLOW#[None].GRDE#[None].BRND#[None].DEST#[None]";
   List<String> povs = new ArrayList<String>(1);
   povs.add(pov);
   List<CellInfo> results = dataOM.getCellsInfo(povs);

 setCells API is used to write Data into Data cells.

   DataOM dataOM = new DataOM(session);
   String pov = "S#Actual.Y#2015.P#January.W#<Scenario View>.E#[None].V#<Entity Currency>.A#[None].I#[ICP None].PROD#[None].CUST#[None].CHNL#[None].FLOW#[None].GRDE#[None].BRND#[None].DEST#[None]";
   List<String> povs = new ArrayList<String>(1);
   povs.add(pov);

   List<Double> dataList = new ArrayList<Double>(1);
   dataList.add(1234.00);
   List<Boolean> noDataFlagList = new ArrayList<Boolean>(1);
   noDataFlagList.add(false);
   List<String> errors = dataOM.setCells(povs, dataList, noDataFlagList);

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

DataOM(SessionInfo sessionInfo)
Constructor to create an instance of DataOM object.

Constructors
Constructor and Description
`DataOM(SessionInfo sessionInfo)` Constructor to create an instance of DataOM object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clearCellText(String povSlice)` This method clears all the cell texts in the subcube by first getting all the descriptions internally from the sub cube and finally based upon access rights it clears the descriptions.
`void`	`detachDocumentFromCell(String povSlice, String docPath, String docFile)` This method detaches the document from the [Default] cell text label of the cell.
`void`	`deteleLineItemDetails(String povSlice, List<String> details)` Method to remove list of line item details for a given pov.
`boolean`	`doesCellSupportICTransaction(String povSlice)` This method gives information whether the Cell supports IC Transactions.
`ServerTaskInfo`	`executeOnDemandRule(String onDemandRule, List<String> povSlice)` Execute OnDemand rules on list of povs.
`ServerPMTaskInfo`	`executeServerPMTaskForPovs(PROCESS_FLOW_ACTION action, List<String> povs, PMTaskOptions taskOptions)` Executes a Process Management Task for specified list of povs.
`ServerTaskInfo`	`executeServerTask(WEBOMDATAGRIDTASKMASKENUM task, List<String> povSliceList)` Executes a serverTask like consolidation, calculate baed on WEBOMDATAGRIDTASKMASKENUM and povSliceList.
`List<String>`	`getCellAdjustmentsInfo(String povSlice)` Retrieve cell adjustment information for a given pov.
`List<CellHistory>`	`getCellHistory(String povSlice)` Retrieve cell history information.
`CellInfo`	`getCellInfo(String povSlice)` Get detailed info about a specific cell.
`List<CellDataAndStatusInfo>`	`getCellsDataAndStatus(List<String> povSlices)` Get info about Data and Status of specific cells.
`List<CellInfo>`	`getCellsInfo(List<String> povSlices)` Get detailed info about a specific cell.
`List<CellStatusInfo>`	`getCellStatus(List<String> povs, List<Boolean> includeTransType)` Retrieve the cell status which includes Metadata status, Calc Status, CellText Status for the given point of view.
`List<WebCellTextInfo>`	`getCellTextAndAttachmentsUsingPov(String povSlice)` Get the cell text and attachment information for a given pov.
`List<List<CellTextInfo>>`	`getCellTextUsingPovs(List<String> povs)` This method returns the cell text for all labels for the given list of pov.
`List<CellTextInfoWithErrorDetail>`	`getCellTextWithErrorDetailUsingPovs(List<String> povs)` This method returns the cell text for all labels for the given list of pov, and error details for invalid povs.
`CellTransactionsInfo`	`getDestinationTransactionInfo(String povSlice)` Retrieve cell destination transaction information.
`List<DynamicAccountInfo>`	`getDynamicAccountInfo()` Internal Use Only Gets the Dynamic Account Information.
`EntityDetailInfo`	`getEntityDetails(String povSlice, EntityDetailReportOptions entityDetOptions)` Retrieve entity details information.
`ProcessFlowGroupPhase`	`getGroupPhaseFromCell(String povSlice)` Gets the Group phase info the given pov.
`List<LineItemsOMObject>`	`getLineItemsDetails(String povSlice, boolean isSinglePeriod, List<String> periodPOVList)` Method to retrieve line item details.
`List<String>`	`getOnDemandRules()` Retrieve OnDemand Rules.
`ProcessFlowInfo`	`getProcessFlowInformation(String povSlice)` Method to retrieve process flow information.
`ProcessFlowInfo`	`getProcessFlowInformationByPhase(String povSlice, int phaseId)` Method to retrieve process flow information for a specific phase
`CellTransactionsInfo`	`getSourceTransactionInfo(String povSlice)` Retrieve cell source transactions information.
`List<DataCellDrillBack>`	`getUrlsForCell(String povSlice)` Get drill back url information for a given pov.
`void`	`lockUnlockCell(String povSlice, boolean lock)` This method sets the calc status of the cell to locked, if lock is set to true, and unlocked if lock is set to false.
`void`	`setCellDescriptions(List<String> povs, List<List<CellText>> cellTexts)` This method sets the descriptions and attachments for the cell.
`void`	`setCellLineItemDetailsUsingPovs(List<String> povs, List<List<CellLineItemDetail>> detailsList)` Method to set the line item details for list of povs.
`List<String>`	`setCells(List<String> povs, List<Double> data, List<Boolean> isNoData)` Method to set/write the cell data.
`List<SetCellsDataAndStatusInfo>`	`setCellsAndGetCellsDataAndStatusSV(List<String> povSlices, List<Double> values, List<Boolean> nodataFlags)` Get info about Data and Status of specific cells.
`List<String>`	`setCellsSV(List<String> povs, List<Double> data, List<Boolean> isNoData)` Method to set/write the cell data.
`void`	`submitFormData(GridData data)` Method to submit Form Data which includes Data, Cell Text, Attachment, Line items.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DataOM
```
public DataOM(SessionInfo sessionInfo)
       throws HFMException
```
    Constructor to create an instance of DataOM object.
    
    Parameters:
    
    sessionInfo - SessionInfo object which contain the session ID, servername and port number
    
    Throws:
    
    HFMException
- Method Detail
  - getCellInfo
```
public CellInfo getCellInfo(String povSlice)
                     throws HFMException
```
    Get detailed info about a specific cell.
    
    Parameters:
    
    povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    Returns:
    
    CellInfo containing details of the cell
    
    Throws:
    
    HFMException
  - getCellsInfo
```
public List<CellInfo> getCellsInfo(List<String> povSlices)
                            throws HFMException
```
    Get detailed info about a specific cell.
    
    Parameters:
    
    povSlices - list of POVs in HFM standard notation, e.g., S#Actual.Y#2011...
    
    Returns:
    
    list of CellInfo containing details of the cells
    
    Throws:
    
    HFMException
  - getCellsDataAndStatus
```
public List<CellDataAndStatusInfo> getCellsDataAndStatus(List<String> povSlices)
                                                  throws HFMException
```
    Get info about Data and Status of specific cells.
    
    Parameters:
    
    povSlices - list of POVs in HFM standard notation, e.g., S#Actual.Y#2011...
    
    Returns:
    
    list of CellDataAndStatusInfo containing StoredData and Status info of the cells
    
    Throws:
    
    HFMException
  - setCellsAndGetCellsDataAndStatusSV
```
public List<SetCellsDataAndStatusInfo> setCellsAndGetCellsDataAndStatusSV(List<String> povSlices,
                                                                          List<Double> values,
                                                                          List<Boolean> nodataFlags)
                                                                   throws HFMException
```
    Get info about Data and Status of specific cells.
    
    Parameters:
    
    povSlices - list of POVs in HFM standard notation, e.g., S#Actual.Y#2011...
    
    values - List of data which is to be set for the given list of pov
    
    nodataFlags - List of booleans, flag that tells whether NODATA has to be set
    
    Returns:
    
    list of SetCellsDataAndStatusInfo containing StoredData and Status info of the cells. String correspond to each pov in same order. The string will contain error message there is a failure to commit the data for that pov.
    
    Throws:
    
    HFMException
  - getCellHistory
```
public List<CellHistory> getCellHistory(String povSlice)
                                 throws HFMException
```
    Retrieve cell history information.
    
    Parameters:
    
    povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    Returns:
    
    List of CellHistory objects that contains cell history information
    
    Throws:
    
    HFMException
  - getEntityDetails
```
public EntityDetailInfo getEntityDetails(String povSlice,
                                         EntityDetailReportOptions entityDetOptions)
                                  throws HFMException
```
    Retrieve entity details information.
    
    Parameters:
    
    povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    entityDetOptions - Options object dictate which information is returned as part of the entity detail report
    
    Returns:
    
    EntityDetailInfo object which contains the entity detail information for the cell
    
    Throws:
    
    HFMException
  - getSourceTransactionInfo
```
public CellTransactionsInfo getSourceTransactionInfo(String povSlice)
                                              throws HFMException
```
    Retrieve cell source transactions information.
    
    Parameters:
    
    povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    Returns:
    
    CellTransactionsInfo object which contains source transcations information
    
    Throws:
    
    HFMException
  - getDestinationTransactionInfo
```
public CellTransactionsInfo getDestinationTransactionInfo(String povSlice)
                                                   throws HFMException
```
    Retrieve cell destination transaction information.
    
    Parameters:
    
    povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    Returns:
    
    CellTransactionsInfo object which contains destination transcations information
    
    Throws:
    
    HFMException
  - executeServerTask
```
public ServerTaskInfo executeServerTask(WEBOMDATAGRIDTASKMASKENUM task,
                                        List<String> povSliceList)
                                 throws HFMException
```
    Executes a serverTask like consolidation, calculate baed on WEBOMDATAGRIDTASKMASKENUM and povSliceList.
    
    Parameters:
    
    task - Enum that specifies which task to execute
    
    povSliceList - List of POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    Returns:
    
    ServerTaskInfo
    
    Throws:
    
    HFMException - throws HFMException if povSliceList is null or empty or invalid or exrcution error then throw HFMException
  - getLineItemsDetails
```
public List<LineItemsOMObject> getLineItemsDetails(String povSlice,
                                                   boolean isSinglePeriod,
                                                   List<String> periodPOVList)
                                            throws HFMException
```
    Method to retrieve line item details.
    
    Parameters:
    
    povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    isSinglePeriod - true if single period
    
    periodPOVList - List of POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    Returns:
    
    list of line item details objects
    
    Throws:
    
    HFMException
  - getProcessFlowInformation
```
public ProcessFlowInfo getProcessFlowInformation(String povSlice)
                                          throws HFMException
```
    Method to retrieve process flow information.
    
    Parameters:
    
    povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    Returns:
    
    ProcessFlowInfo object containing process flow information
    
    Throws:
    
    HFMException
  - getProcessFlowInformationByPhase
```
public ProcessFlowInfo getProcessFlowInformationByPhase(String povSlice,
                                                        int phaseId)
                                                 throws HFMException
```
    Method to retrieve process flow information for a specific phase
    
    Parameters:
    
    povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    phaseId - Phase id for which process flow information is required (1 to 9)
    
    Returns:
    
    ProcessFlowInfo object containing process flow information
    
    Throws:
    
    HFMException
  - submitFormData
```
public void submitFormData(GridData data)
                    throws HFMException
```
    Method to submit Form Data which includes Data, Cell Text, Attachment, Line items.
    
    Parameters:
    
    data - Grid Data which includes Data, Cell Text, Attachment, Line items
    
    Throws:
    
    HFMException
  - executeServerPMTaskForPovs
```
public ServerPMTaskInfo executeServerPMTaskForPovs(PROCESS_FLOW_ACTION action,
                                                   List<String> povs,
                                                   PMTaskOptions taskOptions)
                                            throws HFMException
```
    Executes a Process Management Task for specified list of povs.
    
    Parameters:
    
    action - Enum that specifies which action to execute
    
    povs - Array of POVs in HFM standard notation, e.g., S#Actual.Y#2011...
    
    taskOptions - Options that control how the execute action happens
    
    Returns:
    
    ServerPMTaskInfo object containing required information
    
    Throws:
    
    HFMException
  - getCellTextAndAttachmentsUsingPov
```
public List<WebCellTextInfo> getCellTextAndAttachmentsUsingPov(String povSlice)
                                                        throws HFMException
```
    Get the cell text and attachment information for a given pov.
    
    Parameters:
    
    povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    Returns:
    
    List of CellTextInfo objects that contain the information
    
    Throws:
    
    HFMException - HFMException
  - getUrlsForCell
```
public List<DataCellDrillBack> getUrlsForCell(String povSlice)
                                       throws HFMException
```
    Get drill back url information for a given pov.
    
    Parameters:
    
    povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    Returns:
    
    List of DataCellDrillBack objects
    
    Throws:
    
    HFMException
  - getCellAdjustmentsInfo
```
public List<String> getCellAdjustmentsInfo(String povSlice)
                                    throws HFMException
```
    Retrieve cell adjustment information for a given pov.
    
    Parameters:
    
    povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    Returns:
    
    List of strings
    
    Throws:
    
    HFMException
  - deteleLineItemDetails
```
public void deteleLineItemDetails(String povSlice,
                                  List<String> details)
                           throws HFMException
```
    Method to remove list of line item details for a given pov.
    
    Parameters:
    
    povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    details - List of line item that needs to be removed
    
    Throws:
    
    HFMException
  - setCellLineItemDetailsUsingPovs
```
public void setCellLineItemDetailsUsingPovs(List<String> povs,
                                            List<List<CellLineItemDetail>> detailsList)
                                     throws HFMException
```
    Method to set the line item details for list of povs.
    
    Parameters:
    
    povs - List of POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    detailsList - List of lists of line item details for each pov in the list
    
    Throws:
    
    HFMException
  - getOnDemandRules
```
public List<String> getOnDemandRules()
                              throws HFMException
```
    Retrieve OnDemand Rules.
    
    Returns:
    
    OnDemand rules
    
    Throws:
    
    HFMException
  - executeOnDemandRule
```
public ServerTaskInfo executeOnDemandRule(String onDemandRule,
                                          List<String> povSlice)
                                   throws HFMException
```
    Execute OnDemand rules on list of povs.
    
    Parameters:
    
    onDemandRule - OnDemand rule
    
    povSlice - List of POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    Returns:
    
    ServerTaskInfo object for execution status
    
    Throws:
    
    HFMException
  - getCellStatus
```
public List<CellStatusInfo> getCellStatus(List<String> povs,
                                          List<Boolean> includeTransType)
                                   throws HFMException
```
    Retrieve the cell status which includes Metadata status, Calc Status, CellText Status for the given point of view. Incase if any errors while retrieving the status,status will not be retrieved. For eg:- Invalid input, error string will be returned as CellStatusInfo.errorDetail = �The POV selected for this function is invalid�. Incase if there are no errors , status will be retrieved and there will not be any errors in the CellStatusInfo.errorDetail string.
    
    Parameters:
    
    povs - List of POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    includeTransType - List of booleans, parameter which explains to include transtype part of the cell status
    
    Returns:
    
    List of CellStatusInfo object that contains the information
    
    Throws:
    
    HFMException
  - setCells
```
public List<String> setCells(List<String> povs,
                             List<Double> data,
                             List<Boolean> isNoData)
                      throws HFMException
```
    Method to set/write the cell data.
    
    Parameters:
    
    povs - List of POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    data - List of data which is to be set for the given list of pov
    
    isNoData - List of booleans, flag that tells whether NODATA has to be set
    
    Returns:
    
    List of String correspond to each pov in same order. The string will contain error message there is a failure to commit the data for that pov.
    
    Throws:
    
    HFMException
  - setCellsSV
```
public List<String> setCellsSV(List<String> povs,
                               List<Double> data,
                               List<Boolean> isNoData)
                        throws HFMException
```
    Method to set/write the cell data. specific for smart view
    
    Parameters:
    
    povs - List of POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    data - List of data which is to be set for the given list of pov
    
    isNoData - List of booleans, flag that tells whether NODATA has to be set
    
    Returns:
    
    List of String correspond to each pov in same order. The string will contain error message there is a failure to commit the data for that pov.
    
    Throws:
    
    HFMException
  - detachDocumentFromCell
```
public void detachDocumentFromCell(String povSlice,
                                   String docPath,
                                   String docFile)
                            throws HFMException
```
    This method detaches the document from the [Default] cell text label of the cell.
    
    Parameters:
    
    povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    docPath - The string containing the document path from where file has to be detached.
    
    docFile - The string containing the document file name which has to be detached from the cell
    
    Throws:
    
    HFMException
  - setCellDescriptions
```
public void setCellDescriptions(List<String> povs,
                                List<List<CellText>> cellTexts)
                         throws HFMException
```
    This method sets the descriptions and attachments for the cell.
    
    Parameters:
    
    povs - The list of POV strings for which cell text has to be set
    
    cellTexts - The list of lists of cell text objects which has label, cell text and cell attachments
    
    Throws:
    
    HFMException
  - lockUnlockCell
```
public void lockUnlockCell(String povSlice,
                           boolean lock)
                    throws HFMException
```
    This method sets the calc status of the cell to locked, if lock is set to true, and unlocked if lock is set to false.
    
    Parameters:
    
    povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    lock - The boolean sets the calc status to locked, if lock is set to true, and unlocked if lock is set to false
    
    Throws:
    
    HFMException
  - clearCellText
```
public void clearCellText(String povSlice)
                   throws HFMException
```
    This method clears all the cell texts in the subcube by first getting all the descriptions internally from the sub cube and finally based upon access rights it clears the descriptions.
    
    Parameters:
    
    povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    Throws:
    
    HFMException
  - doesCellSupportICTransaction
```
public boolean doesCellSupportICTransaction(String povSlice)
                                     throws HFMException
```
    This method gives information whether the Cell supports IC Transactions.
    
    Parameters:
    
    povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...
    
    Returns:
    
    True if the cell supports IC Transactions otherwise false.
    
    Throws:
    
    HFMException
  - getCellTextUsingPovs
```
public List<List<CellTextInfo>> getCellTextUsingPovs(List<String> povs)
                                              throws HFMException
```
    This method returns the cell text for all labels for the given list of pov.
    
    Parameters:
    
    povs - list of POVs in HFM standard notation, e.g., S#Actual.Y#2011...
    
    Returns:
    
    List of lists, where the outer list represents the POV, and the inner list the labels for that POV
    
    Throws:
    
    HFMException
  - getCellTextWithErrorDetailUsingPovs
```
public List<CellTextInfoWithErrorDetail> getCellTextWithErrorDetailUsingPovs(List<String> povs)
                                                                      throws HFMException
```
    This method returns the cell text for all labels for the given list of pov, and error details for invalid povs.
    
    Parameters:
    
    povs - list of POVs in HFM standard notation, e.g., S#Actual.Y#2011...
    
    Returns:
    
    List of lists, where the outer list represents the POV, and the inner list the labels for that POV
    
    Throws:
    
    HFMException
  - getDynamicAccountInfo
```
public List<DynamicAccountInfo> getDynamicAccountInfo()
                                               throws HFMException
```
    Internal Use Only Gets the Dynamic Account Information.
    
    Returns:
    
    List of Dynamic Account Information.If there is no dynamic account info available then list size will be zero.
    
    Throws:
    
    HFMException
  - getGroupPhaseFromCell
```
public ProcessFlowGroupPhase getGroupPhaseFromCell(String povSlice)
                                            throws HFMException
```
    Gets the Group phase info the given pov.
    
    Parameters:
    
    povSlice - string representing single pov.
    
    Returns:
    
    Group phase info.
    
    Throws:
    
    HFMException

Class DataOM

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DataOM

Method Detail

getCellInfo

getCellsInfo

getCellsDataAndStatus

setCellsAndGetCellsDataAndStatusSV

getCellHistory

getEntityDetails

getSourceTransactionInfo

getDestinationTransactionInfo

executeServerTask

getLineItemsDetails

getProcessFlowInformation

getProcessFlowInformationByPhase

submitFormData

executeServerPMTaskForPovs

getCellTextAndAttachmentsUsingPov

getUrlsForCell

getCellAdjustmentsInfo

deteleLineItemDetails

setCellLineItemDetailsUsingPovs

getOnDemandRules

executeOnDemandRule

getCellStatus

setCells

setCellsSV

detachDocumentFromCell

setCellDescriptions

lockUnlockCell

clearCellText

doesCellSupportICTransaction

getCellTextUsingPovs

getCellTextWithErrorDetailUsingPovs

getDynamicAccountInfo

getGroupPhaseFromCell