public class DataOM extends Object implements Serializable
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);
| Constructor and Description |
|---|
DataOM(SessionInfo sessionInfo)
Constructor to create an instance of DataOM object.
|
| 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.
|
public DataOM(SessionInfo sessionInfo) throws HFMException
sessionInfo - SessionInfo object which contain the session ID, servername and port numberHFMExceptionpublic CellInfo getCellInfo(String povSlice) throws HFMException
povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...HFMExceptionpublic List<CellInfo> getCellsInfo(List<String> povSlices) throws HFMException
povSlices - list of POVs in HFM standard notation, e.g., S#Actual.Y#2011...HFMExceptionpublic List<CellDataAndStatusInfo> getCellsDataAndStatus(List<String> povSlices) throws HFMException
povSlices - list of POVs in HFM standard notation, e.g., S#Actual.Y#2011...HFMExceptionpublic List<SetCellsDataAndStatusInfo> setCellsAndGetCellsDataAndStatusSV(List<String> povSlices, List<Double> values, List<Boolean> nodataFlags) throws HFMException
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 povnodataFlags - List of booleans, flag that tells whether NODATA has to be setHFMExceptionpublic List<CellHistory> getCellHistory(String povSlice) throws HFMException
povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...HFMExceptionpublic EntityDetailInfo getEntityDetails(String povSlice, EntityDetailReportOptions entityDetOptions) throws HFMException
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 reportHFMExceptionpublic CellTransactionsInfo getSourceTransactionInfo(String povSlice) throws HFMException
povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...HFMExceptionpublic CellTransactionsInfo getDestinationTransactionInfo(String povSlice) throws HFMException
povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...HFMExceptionpublic ServerTaskInfo executeServerTask(WEBOMDATAGRIDTASKMASKENUM task, List<String> povSliceList) throws HFMException
task - Enum that specifies which task to executepovSliceList - List of POV in HFM standard notation, e.g., S#Actual.Y#2011...HFMException - throws HFMException if povSliceList is null or empty or invalid or exrcution error then throw HFMExceptionpublic List<LineItemsOMObject> getLineItemsDetails(String povSlice, boolean isSinglePeriod, List<String> periodPOVList) throws HFMException
povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...isSinglePeriod - true if single periodperiodPOVList - List of POV in HFM standard notation, e.g., S#Actual.Y#2011...HFMExceptionpublic ProcessFlowInfo getProcessFlowInformation(String povSlice) throws HFMException
povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...HFMExceptionpublic ProcessFlowInfo getProcessFlowInformationByPhase(String povSlice, int phaseId) throws HFMException
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)HFMExceptionpublic void submitFormData(GridData data) throws HFMException
data - Grid Data which includes Data, Cell Text, Attachment, Line itemsHFMExceptionpublic ServerPMTaskInfo executeServerPMTaskForPovs(PROCESS_FLOW_ACTION action, List<String> povs, PMTaskOptions taskOptions) throws HFMException
action - Enum that specifies which action to executepovs - Array of POVs in HFM standard notation, e.g., S#Actual.Y#2011...taskOptions - Options that control how the execute action happensHFMExceptionpublic List<WebCellTextInfo> getCellTextAndAttachmentsUsingPov(String povSlice) throws HFMException
povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...HFMException - HFMExceptionpublic List<DataCellDrillBack> getUrlsForCell(String povSlice) throws HFMException
povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...HFMExceptionpublic List<String> getCellAdjustmentsInfo(String povSlice) throws HFMException
povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...HFMExceptionpublic void deteleLineItemDetails(String povSlice, List<String> details) throws HFMException
povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...details - List of line item that needs to be removedHFMExceptionpublic void setCellLineItemDetailsUsingPovs(List<String> povs, List<List<CellLineItemDetail>> detailsList) throws HFMException
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 listHFMExceptionpublic List<String> getOnDemandRules() throws HFMException
HFMExceptionpublic ServerTaskInfo executeOnDemandRule(String onDemandRule, List<String> povSlice) throws HFMException
onDemandRule - OnDemand rulepovSlice - List of POV in HFM standard notation, e.g., S#Actual.Y#2011...HFMExceptionpublic List<CellStatusInfo> getCellStatus(List<String> povs, List<Boolean> includeTransType) throws HFMException
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 statusHFMExceptionpublic List<String> setCells(List<String> povs, List<Double> data, List<Boolean> isNoData) throws HFMException
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 povisNoData - List of booleans, flag that tells whether NODATA has to be setHFMExceptionpublic List<String> setCellsSV(List<String> povs, List<Double> data, List<Boolean> isNoData) throws HFMException
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 povisNoData - List of booleans, flag that tells whether NODATA has to be setHFMExceptionpublic void detachDocumentFromCell(String povSlice, String docPath, String docFile) throws HFMException
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 cellHFMExceptionpublic void setCellDescriptions(List<String> povs, List<List<CellText>> cellTexts) throws HFMException
povs - The list of POV strings for which cell text has to be setcellTexts - The list of lists of cell text objects which has label, cell text and cell attachmentsHFMExceptionpublic void lockUnlockCell(String povSlice, boolean lock) throws HFMException
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 falseHFMExceptionpublic void clearCellText(String povSlice) throws HFMException
povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...HFMExceptionpublic boolean doesCellSupportICTransaction(String povSlice) throws HFMException
povSlice - POV in HFM standard notation, e.g., S#Actual.Y#2011...HFMExceptionpublic List<List<CellTextInfo>> getCellTextUsingPovs(List<String> povs) throws HFMException
povs - list of POVs in HFM standard notation, e.g., S#Actual.Y#2011...HFMExceptionpublic List<CellTextInfoWithErrorDetail> getCellTextWithErrorDetailUsingPovs(List<String> povs) throws HFMException
povs - list of POVs in HFM standard notation, e.g., S#Actual.Y#2011...HFMExceptionpublic List<DynamicAccountInfo> getDynamicAccountInfo() throws HFMException
HFMExceptionpublic ProcessFlowGroupPhase getGroupPhaseFromCell(String povSlice) throws HFMException
povSlice - string representing single pov.HFMExceptionCopyright 2007, 2026, Oracle. All rights reserved.