oracle.epm.fm.domainobject.data.manage

Class ManageDataOM

java.lang.Object

oracle.epm.fm.domainobject.data.manage.ManageDataOM

All Implemented Interfaces:

Serializable

public class ManageDataOM
extends Object
implements Serializable

This class contains the API's for Database management e.g. copy data, clear data.

Since:

PS2

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	clearData(ClearDataOptions clearDataOptions) Method to clears data for One Scenario and Year, and many Periods, Accounts, and Entities.
String	clearInvalidRecords(boolean bScanOnly) Method to clear all invalid records that exist because of changes in metadata.
String	copyData(CopyDataOptions copyDataOptions) Method to copy data based on a source and destination Scenario, Year, and Periods, given a list of Accounts and Entities.

Methods inherited from class java.lang.Object

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

Constructor Detail

ManageDataOM

public ManageDataOM(SessionInfo sessionInfo)
             throws HFMException

Constructor to create ManageDataOM object.

Parameters:

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

Throws:

HFMException

Method Detail

copyData

public String copyData(CopyDataOptions copyDataOptions)
                throws HFMException

Method to copy data based on a source and destination Scenario, Year, and Periods, given a list of Accounts and Entities.

Parameters:

copyDataOptions - Contains the Source, Destination, and Member POVs as well as all the copy options defining the operation.

Returns:

The path to the log file generated by the server.

Throws:

HFMException - ErrorCodeConsts.ERROR_COPYING_DATA

clearData

public String clearData(ClearDataOptions clearDataOptions)
                 throws HFMException

Method to clears data for One Scenario and Year, and many Periods, Accounts, and Entities.

Parameters:

clearDataOptions - Contains the Scenario, Year, Periods, Entities, and Accounts, as well as all the clear options defining the operation.

Returns:

The path to the log file generated by the server.

Throws:

HFMException - ErrorCodeConsts.ERROR_CLEARING_DATA

clearInvalidRecords

public String clearInvalidRecords(boolean bScanOnly)
                           throws HFMException

Method to clear all invalid records that exist because of changes in metadata.

Parameters:

bScanOnly - If true, only scan for the records to clear. This will not remove invalid records from the DB.

Returns:

The path to the log file generated by the server.

Throws:

HFMException - ErrorCodeConsts.ERROR_CLEARING_INVALID_DATA