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

java.lang.Object
- oracle.epm.fm.domainobject.intercompany.IntercompanyOM

All Implemented Interfaces:

Serializable
```
public class IntercompanyOM
extends Object
implements Serializable
```
This class contains all Intercompany related APIs.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

IntercompanyOM(SessionInfo sessionInfo)
Creates an instance of the IntercompanyOM object.

Constructors
Constructor and Description
`IntercompanyOM(SessionInfo sessionInfo)` Creates an instance of the IntercompanyOM object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTransaction(String scenario, String year, String period, ICTransaction icTransaction)` This api saves a new transaction.
`ICPeriodsResponseInfo`	`closeICTPeriod(String scenario, String year, ICPeriodsDetailedInfo periods)` Closes the selected period.
`List<ErrorDescriptions>`	`deleteICReasonCodes(List<ICReasonCode> reasonCodes)` This method will delete one or more ICReasonCodes.
`void`	`editICTransaction(String scenario, String year, String period, ICRowFilterInfo icRowfiler, ICColumnFilterInfo icColumnFilter, ICTransaction updatedTransaction)` Method to edit ic transaction
`List<ICReasonCode>`	`enumICReasonCodes()` This method will return list of ICReasonCode objects.
`ICEmailInfo`	`generateICEmail(EmailTargets emailTargets)` This method will generate the email info needed to send to the java mailer class.
`double`	`getDefaultExchangeRate(String povSlice, String fromCurrency, String toCurrency)` Method to get default exchange rate
`List<ICEntity>`	`getICEntities(String scenario, String year, String period, ICEntityFilter icEntityFilter)` Method to get list of ICEntity objects.
`long`	`getICEntitiesSize(String scenario, String year, String period, ICEntityFilter icEntityFilter)` Method to get the size of entities.
`ICEntityDetailInfo`	`getICEntityDetail(String scenario, String year, String period, String entity)` Method to get Transaction detail object.
`ICEntitySummaryInfo`	`getICEntitySummary(String scenario, String year, String period, List<String> entities)` Method to get icentities summary info.
`ICPeriodsDetailedInfo`	`getICPeriods(String scenario, String year)` This method populates the ICT Period table.
`ICTransaction`	`getICTransactionDetail(String scenario, String year, String period, String sequenceId)` Method to get an IC Transaction in its raw values.
`List<ICTransaction>`	`getICTransactions(String scenario, String year, String period, int startIndex, int rangeSize, ICRowFilterInfo icRowfiler, ICColumnFilterInfo icColumnFilter)` Method to get list of ICTransaction objects. For the ICColumnFilterInfo parameter: For each custom dimension, call addToCustoms() with an ICCustomColumnFilter object whose name is set to the custom dimension name. For the ICRowFilterInfo parameter, at least one of the following should be called with a value of true: setIncludeMatched; setIncludeMisMatched setIncludeUnMatched setIncludePosted setIncludeUnPosted setDisplayEntityTrans setDisplayPartnerTrans
`long`	`getICTransactionsSize(String scenario, String year, String period, ICRowFilterInfo icRowfiler, ICColumnFilterInfo icColumnFilter)` Method to get the total size of ICTransaction objects satisfying the filter criteria.
`List<MatchedTransactionsInfo>`	`getMatchedTransactions(String scenario, String year, String period, List<String> sequenceId, ICColumnFilterInfo columnFilter)` method return list of matched transactions with match code.
`List<LockUnlockEntity>`	`lockEntities(String scenario, String year, String period, List<String> entities)` Method to Lock the selected entities.
`ICPeriodsResponseInfo`	`openICTPeriod(String scenario, String year, ICPeriodsDetailedInfo periods)` Opens the selected periods.
`List<ICTransactionErrorInfo>`	`processICTransactions(String scenario, String year, String period, ICTRANSPROCESSACTION action, List<String> sequenceId)` Method handles post Selected,UnPost Selected,Delete selected etc.
`List<ICTransactionErrorInfo>`	`processICTransactionsByFilter(String scenario, String year, String period, ICTRANSPROCESSACTION action, ICRowFilterInfo rowFilter)` Method handles Post All,UnPost All,Delete All,UnMatch All,based on filter settings.
`List<ErrorDescriptions>`	`saveICReasonCodes(List<ICReasonCode> reasonCodes)` This method will save a list of ICReasonCodes.
`ICPeriodsResponseInfo`	`saveICTPeriodProperties(String scenario, String year, ICPeriodsDetailedInfo periods)` Save the selected period settings.
`void`	`saveTransaction(String scenario, String year, String period, ICTransaction icTransaction, boolean amountChanged)` This api Saves an edited transaction.
`List<ICTransactionErrorInfo>`	`setReasonCode(String scenario, String year, String period, String reasonCode, List<String> sequenceIds)` This api is to set reasonCode for a transaction or set of transactions.
`void`	`setReasonCodeandComment2(String scenario, String year, String period, String entity, String icp, String reasonCode, String comment2, String seqId)` This api is to set reasonCode and comment 2 for a transaction.
`void`	`startAutoMatchByAccount(String scenario, String year, String period, ICAUTOMATCHTYPE type, AutoMatchByAccountInfo automatchByAccountInfo)` This method will start IC AUTO Match.
`void`	`startAutoMatchById(String scenario, String year, String period, ICAUTOMATCHTYPE type, AutoMatchByIDInfo automatchByIdInfo)` This method will start IC AUTO Match.
`List<LockUnlockEntity>`	`unlockEntities(String scenario, String year, String period, List<String> entities)` Method to UnLock the selected entities.
`List<ICTransactionErrorInfo>`	`unMatchTransactions(String scenario, String year, String period, List<String> matchCodes)` Method to un match set of transactions.

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

Constructor Detail
- IntercompanyOM
```
public IntercompanyOM(SessionInfo sessionInfo)
               throws HFMException
```
  Creates an instance of the IntercompanyOM object.
  
  Parameters:
  
  sessionInfo - session information
  
  Throws:
  
  HFMException

Method Detail

generateICEmail
```
public ICEmailInfo generateICEmail(EmailTargets emailTargets)
                            throws HFMException
```
This method will generate the email info needed to send to the java mailer class.

Parameters:

emailTargets - email object formed by the IC events

Returns:

The object needed to send to the java mailer class to generate IC emails

Throws:

HFMException

getICEntities

public List<ICEntity> getICEntities(String scenario,
                                    String year,
                                    String period,
                                    ICEntityFilter icEntityFilter)
                             throws HFMException

Method to get list of ICEntity objects.

Parameters:: scenario - Selected scenario name; year - Selected year name; period - Selected period name; icEntityFilter - IC entity filter object
Returns:: list of ICEntity objects.
Throws:: HFMException

getICEntitiesSize

public long getICEntitiesSize(String scenario,
                              String year,
                              String period,
                              ICEntityFilter icEntityFilter)
                       throws HFMException

Method to get the size of entities.

Parameters:: scenario - Selected scenario name; year - Selected year name; period - Selected period name; icEntityFilter - IC entity filter object
Returns:: size of entities.
Throws:: HFMException

getICEntityDetail

public ICEntityDetailInfo getICEntityDetail(String scenario,
                                            String year,
                                            String period,
                                            String entity)
                                     throws HFMException

Method to get Transaction detail object.

Parameters:: scenario - Selected scenario name; year - Selected year name; period - Selected period name; entity - Selected entity name
Returns:: ICEntityDetailInfo object containing transaction detail info.
Throws:: HFMException

getICEntitySummary

public ICEntitySummaryInfo getICEntitySummary(String scenario,
                                              String year,
                                              String period,
                                              List<String> entities)
                                       throws HFMException

Method to get icentities summary info.

Parameters:: scenario - Selected scenario name; year - Selected year name; period - Selected period name; entities - Selected list of entities
Returns:: ICEntitySummaryInfo object containing the summary info.
Throws:: HFMException

lockEntities

public List<LockUnlockEntity> lockEntities(String scenario,
                                           String year,
                                           String period,
                                           List<String> entities)
                                    throws HFMException

Method to Lock the selected entities.

Parameters:: scenario - Selected scenario name; year - Selected year name; period - Selected period name; entities - Selected list of entities to be locked
Returns:: error if any.
Throws:: HFMException

unlockEntities

public List<LockUnlockEntity> unlockEntities(String scenario,
                                             String year,
                                             String period,
                                             List<String> entities)
                                      throws HFMException

Method to UnLock the selected entities.

Parameters:: scenario - Selected scenario name; year - Selected year name; period - Selected period name; entities - Selected list of entities to be unlocked
Returns:: error if any.
Throws:: HFMException

getICPeriods

public ICPeriodsDetailedInfo getICPeriods(String scenario,
                                          String year)
                                   throws HFMException

This method populates the ICT Period table.

Parameters:: scenario - Selected scenario member; year - Selected year member
Returns:: List Returns a List of ICPeriod with its current status
Throws:: HFMException

openICTPeriod

public ICPeriodsResponseInfo openICTPeriod(String scenario,
                                           String year,
                                           ICPeriodsDetailedInfo periods)
                                    throws HFMException

Opens the selected periods.

Parameters:: scenario - Selected scenario member; year - Selected year member; periods - Period object with period to open
Returns:: List of ICError
Throws:: HFMException

closeICTPeriod

public ICPeriodsResponseInfo closeICTPeriod(String scenario,
                                            String year,
                                            ICPeriodsDetailedInfo periods)
                                     throws HFMException

Closes the selected period.

Parameters:: scenario - Selected scenario member; year - Selected year member; periods - List of ICPeriod with its current status
Returns:: List of ICError
Throws:: HFMException

saveICTPeriodProperties

public ICPeriodsResponseInfo saveICTPeriodProperties(String scenario,
                                                     String year,
                                                     ICPeriodsDetailedInfo periods)
                                              throws HFMException

Save the selected period settings.

Parameters:: scenario - Selected scenario member; year - Selected year member; periods - List of ICPeriod with its current status
Returns:: List of ICError
Throws:: HFMException

enumICReasonCodes
```
public List<ICReasonCode> enumICReasonCodes()
                                     throws HFMException
```
This method will return list of ICReasonCode objects.

Returns:

List of ICReasonCode objects

Throws:

HFMException

saveICReasonCodes
```
public List<ErrorDescriptions> saveICReasonCodes(List<ICReasonCode> reasonCodes)
                                          throws HFMException
```
This method will save a list of ICReasonCodes.

Parameters:

reasonCodes - List of Reason codes to be saved

Returns:

List of ReasoncodeError objects

Throws:

HFMException

deleteICReasonCodes
```
public List<ErrorDescriptions> deleteICReasonCodes(List<ICReasonCode> reasonCodes)
                                            throws HFMException
```
This method will delete one or more ICReasonCodes.

Parameters:

reasonCodes - List of Reason codes to be deleted

Returns:

List of ReasoncodeError objects

Throws:

HFMException

startAutoMatchById

public void startAutoMatchById(String scenario,
                               String year,
                               String period,
                               ICAUTOMATCHTYPE type,
                               AutoMatchByIDInfo automatchByIdInfo)
                        throws HFMException

This method will start IC AUTO Match.

Parameters:: scenario - selected scenario name; year - selected year name; period - selected period name; type - selected automatch type; automatchByIdInfo - automatchById info object
Throws:: HFMException

startAutoMatchByAccount

public void startAutoMatchByAccount(String scenario,
                                    String year,
                                    String period,
                                    ICAUTOMATCHTYPE type,
                                    AutoMatchByAccountInfo automatchByAccountInfo)
                             throws HFMException

This method will start IC AUTO Match.

Parameters:: scenario - selected scenario name; year - selected year name; period - selected period name; type - selected automatch type; automatchByAccountInfo - automathbyaccount info object
Throws:: HFMException

getICTransactions
```
public List<ICTransaction> getICTransactions(String scenario,
                                             String year,
                                             String period,
                                             int startIndex,
                                             int rangeSize,
                                             ICRowFilterInfo icRowfiler,
                                             ICColumnFilterInfo icColumnFilter)
                                      throws HFMException
```
Method to get list of ICTransaction objects.

For the ICColumnFilterInfo parameter:
For each custom dimension, call addToCustoms() with an ICCustomColumnFilter object whose name is set to the custom dimension name.

For the ICRowFilterInfo parameter, at least one of the following should be called with a value of true:
setIncludeMatched;
setIncludeMisMatched
setIncludeUnMatched
setIncludePosted
setIncludeUnPosted
setDisplayEntityTrans
setDisplayPartnerTrans

Parameters:

scenario - selected scenario name

year - selected year name

period - selected period name

startIndex - selected startIndex

rangeSize - selected rangeSize

icRowfiler - selected rowFilter

icColumnFilter - selected columnFilter

Returns:

list of ICTransaction objects.

Throws:

HFMException

getICTransactionDetail

public ICTransaction getICTransactionDetail(String scenario,
                                            String year,
                                            String period,
                                            String sequenceId)
                                     throws HFMException

Method to get an IC Transaction in its raw values. No column filter, or display settings applied.

Parameters:: scenario - selected scenario name; year - selected year name; period - selected period name; sequenceId - selected sequenceId name
Returns:: ICTransaction object contains the transaction details
Throws:: HFMException

getICTransactionsSize

public long getICTransactionsSize(String scenario,
                                  String year,
                                  String period,
                                  ICRowFilterInfo icRowfiler,
                                  ICColumnFilterInfo icColumnFilter)
                           throws HFMException

Method to get the total size of ICTransaction objects satisfying the filter criteria.

Parameters:: scenario - selected scenario name; year - selected year name; period - selected period name; icRowfiler - selected rowfilter; icColumnFilter - selected column filter
Returns:: transaction size.
Throws:: HFMException

processICTransactions

public List<ICTransactionErrorInfo> processICTransactions(String scenario,
                                                          String year,
                                                          String period,
                                                          ICTRANSPROCESSACTION action,
                                                          List<String> sequenceId)
                                                   throws HFMException

Method handles post Selected,UnPost Selected,Delete selected etc.

Parameters:: scenario - selected scenario name; year - selected year name; period - selected period name; action - selected process action; sequenceId - selected sequence id list
Returns:: errors
Throws:: HFMException

processICTransactionsByFilter

public List<ICTransactionErrorInfo> processICTransactionsByFilter(String scenario,
                                                                  String year,
                                                                  String period,
                                                                  ICTRANSPROCESSACTION action,
                                                                  ICRowFilterInfo rowFilter)
                                                           throws HFMException

Method handles Post All,UnPost All,Delete All,UnMatch All,based on filter settings.

Parameters:: scenario - selected scenario name; year - selected year name; period - selected period name; action - selected action; rowFilter - selected rowfilter
Returns:: errors
Throws:: HFMException

getMatchedTransactions

public List<MatchedTransactionsInfo> getMatchedTransactions(String scenario,
                                                            String year,
                                                            String period,
                                                            List<String> sequenceId,
                                                            ICColumnFilterInfo columnFilter)
                                                     throws HFMException

method return list of matched transactions with match code.

Parameters:: scenario - selected scenario name; year - selected year name; period - selected period name; sequenceId - selected sequence Id list; columnFilter - selected columnfilter
Returns:: MatchedTransactionsInfo list
Throws:: HFMException

addTransaction

public void addTransaction(String scenario,
                           String year,
                           String period,
                           ICTransaction icTransaction)
                    throws HFMException

This api saves a new transaction.

Parameters:: scenario - selected scenario; year - selected year; period - selected period; icTransaction - to be added
Throws:: HFMException

saveTransaction

public void saveTransaction(String scenario,
                            String year,
                            String period,
                            ICTransaction icTransaction,
                            boolean amountChanged)
                     throws HFMException

This api Saves an edited transaction.

Parameters:: scenario - selected scenario name; year - selected year name; period - selected period name; icTransaction - to be added; amountChanged - flag
Throws:: HFMException

setReasonCode

public List<ICTransactionErrorInfo> setReasonCode(String scenario,
                                                  String year,
                                                  String period,
                                                  String reasonCode,
                                                  List<String> sequenceIds)
                                           throws HFMException

This api is to set reasonCode for a transaction or set of transactions.

Parameters:: scenario - selected scenario name; year - selected year name; period - selected period name; reasonCode - to be added; sequenceIds - sequence Ids of the transactions selected
Returns:: errors
Throws:: HFMException

setReasonCodeandComment2

public void setReasonCodeandComment2(String scenario,
                                     String year,
                                     String period,
                                     String entity,
                                     String icp,
                                     String reasonCode,
                                     String comment2,
                                     String seqId)
                              throws HFMException

This api is to set reasonCode and comment 2 for a transaction.

Parameters:: scenario - selected scenario name; year - selected year name; period - selected period name; entity - selected entity name; icp - selected icp name; reasonCode - to be added; comment2 - to be added; seqId - sequence Id of the transaction selected
Throws:: HFMException

unMatchTransactions

public List<ICTransactionErrorInfo> unMatchTransactions(String scenario,
                                                        String year,
                                                        String period,
                                                        List<String> matchCodes)
                                                 throws HFMException

Method to un match set of transactions.

Parameters:: scenario - selected scenario; year - selected year; period - selected period; matchCodes - of the matched transactions
Returns:: errors
Throws:: HFMException

editICTransaction

public void editICTransaction(String scenario,
                              String year,
                              String period,
                              ICRowFilterInfo icRowfiler,
                              ICColumnFilterInfo icColumnFilter,
                              ICTransaction updatedTransaction)
                       throws HFMException

Method to edit ic transaction

Parameters:: scenario - selected scenario; year - selected year; period - selected period; icRowfiler - selected rowfilter; icColumnFilter - selected columnfilter; updatedTransaction - ic transaction object with the new values. The fields set in this object are consider to be the fields that needs to be updated
Throws:: HFMException

getDefaultExchangeRate
```
public double getDefaultExchangeRate(String povSlice,
                                     String fromCurrency,
                                     String toCurrency)
                              throws HFMException
```
Method to get default exchange rate

Parameters:

povSlice - pov, Scenario, Year, Period and Entity members are mandatory

fromCurrency - member, any member which is part of [Currencies] list in Custom1 dimension

toCurrency - member, any member which is part of [Currencies] list in Custom2 dimension

Returns:

default exchange rate

Throws:

HFMException

Class IntercompanyOM

Constructor Summary