oracle.epm.fm.domainobject.journal

Class JournalOM

java.lang.Object

oracle.epm.fm.domainobject.journal.JournalOM

All Implemented Interfaces:

Serializable

public class JournalOM
extends Object
implements Serializable

This class contains the methods to manage journals

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JournalOM(SessionInfo sessionInfo)

Method Summary

Modifier and Type	Method and Description
void	addJournalGroups(List<JournalGroup> journalGroups) Adds one or more journal groups to the application
Journal	checkForValidJournal(String journalLabel, String scenario, String year, String period) This function checks whether a journal is valid or not
GridDefinition	constructGridDef(List<JournalLineItem> lineItems, List<JournalDimension> jrnlPOV) Constructs the grid definition from the given line items.
void	deleteAllJournalGroups() Deletes all the journal groups currently in the application
void	deleteJournalGroups(List<JournalGroup> journalGroups) Deletes one or more journal groups from the application
void	deleteJournalTemplates(List<String> templateLabels) Deletes one or more journal templates from the application
List<JournalGroup>	enumJournalGroups() Enumerates the journal groups found for the current application
List<Integer>	enumJournalIds(String scenario, String year, String period, String value, JournalFilter filter) Retrieves the journal ids for a given pov and filter
List<JournalPeriod>	enumJournalPeriods(String scenario, String year) Get the journal periods for the scenario/year combination
List<JournalDisplayLine>	enumJournals(String scenario, String year, String period, String value, JournalFilter filter) Retrieves the journal line info for the filter and pov
List<JournalDisplayLine>	enumJournalsByIds(String scenario, String year, String period, String value, List<Integer> journalIds, List<JOURNAL_COLUMN_TYPES> columnTypes) Retrieves the journal info for the requested journal ids
List<JournalDisplayLine>	enumJournalTemplates(TemplateFilter filter) Gets the Journal Templates that match the file
List<JournalErrorDetail>	generateJournalFromTemplate(String scenario, String year, String period, List<String> journalLabels) Method for generating labels from a template
JournalFilter	getCurrentJournalFilter(boolean getSystemFilter) Gets the currently set journal filter
TemplateFilter	getCurrentTemplateFilter(boolean getSystemFilter) Gets the currently set template filter
Journal	getJournal(int journalId, String scenario, String year, String period)
Journal	getJournal(int journalId, String scenario, String year, String period, boolean varianceRequired)
Journal	getJournalByName(String journalLabel, String scenario, String year, String period) Gets a journal with the specified name
Journal	getJournalByName(String journalLabel, String scenario, String year, String period, boolean varianceRequired) Gets a journal with the specified name
Journal	getJournalTemplate(String templateLabel) Retrieves a journal template with a given name
Journal	getJournalTemplate(String templateLabel, boolean varianceRequired) Retrieves a journal template with a given name
JournalVariance	getVariance(Journal journal, REPORT_QUERY_TYPE type)
void	manageJournalPeriods(String scenario, String year, List<JournalPeriod> journalPeriods) Set the journal periods for the specificed scenario/year combination
List<String>	performJournalAction(List<String> journalLabels, String scenario, String year, String period, JOURNAL_ACTION journalAction) Executes a journal action for a given set of journal labels, and pov
List<JournalErrorDetail>	performScan(Journal journal) Validates the contents of a journal
int	saveJournal(Journal journal) Saves the journal
void	saveJournalTemplate(Journal template) Saves the journal template
void	setCurrentJournalFilter(JournalFilter journalFilter) Sets the current journal filter for the user in the current applicaiton
void	setCurrentTemplateFilter(TemplateFilter templateFilter) Sets the current template filter for the user in the current applicaiton
String	validateJournalPOV(String povStr) Validates the POV for a Journal, checks that the account is valid, that the custom members are contained in the decendants list of the account's customXTopMember and that if ICP is enabled and the ICP member is valid

Methods inherited from class java.lang.Object

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

Constructor Detail

JournalOM

public JournalOM(SessionInfo sessionInfo)
          throws HFMException

Throws:

HFMException

Method Detail

enumJournalGroups

public List<JournalGroup> enumJournalGroups()
                                     throws HFMException

Enumerates the journal groups found for the current application

Returns:

the list of journal groups

Throws:

HFMException

addJournalGroups

public void addJournalGroups(List<JournalGroup> journalGroups)
                      throws HFMException

Adds one or more journal groups to the application

Parameters:

journalGroups - the groups to add

Throws:

HFMException

deleteJournalGroups

public void deleteJournalGroups(List<JournalGroup> journalGroups)
                         throws HFMException

Deletes one or more journal groups from the application

Parameters:

journalGroups - the groups to delete

Throws:

HFMException

deleteAllJournalGroups

public void deleteAllJournalGroups()
                            throws HFMException

Deletes all the journal groups currently in the application

Throws:

HFMException

enumJournalPeriods

public List<JournalPeriod> enumJournalPeriods(String scenario,
                                              String year)
                                       throws HFMException

Get the journal periods for the scenario/year combination

Parameters:

scenario - the scenario for which the periods will be retrieved

year - the year for which the periods will be retrieved

Returns:

the list of journal periods with thier current status

Throws:

HFMException

manageJournalPeriods

public void manageJournalPeriods(String scenario,
                                 String year,
                                 List<JournalPeriod> journalPeriods)
                          throws HFMException

Set the journal periods for the specificed scenario/year combination

Parameters:

scenario - the scenario for the journal periods

year - the year for the journal periods

journalPeriods - the periods and the status that they need to be set to

Throws:

HFMException

enumJournals

public List<JournalDisplayLine> enumJournals(String scenario,
                                             String year,
                                             String period,
                                             String value,
                                             JournalFilter filter)
                                      throws HFMException

Retrieves the journal line info for the filter and pov

Parameters:

scenario - Scenario for which journals display info to be retreived

year - Year for which journals display info to be retreived

period - Period for which journals display info to be retreived

value - Value for which journals display info to be retreived

filter - journal filter options

Returns:

list of JournalDisplayLine for the pov and filter

Throws:

HFMException

enumJournalsByIds

public List<JournalDisplayLine> enumJournalsByIds(String scenario,
                                                  String year,
                                                  String period,
                                                  String value,
                                                  List<Integer> journalIds,
                                                  List<JOURNAL_COLUMN_TYPES> columnTypes)
                                           throws HFMException

Retrieves the journal info for the requested journal ids

Parameters:

scenario - Scenario for which journals display info to be retreived

year - Yesr for which journals display info to be retreived

period - Period for which journals display info to be retreived

value - Value for which journals display info to be retreived

journalIds - journal ids for which data has to be retreived

columnTypes - columns to be retrieved

Returns:

list of JournalDisplayLine for the pov and filter

Throws:

HFMException

enumJournalIds

public List<Integer> enumJournalIds(String scenario,
                                    String year,
                                    String period,
                                    String value,
                                    JournalFilter filter)
                             throws HFMException

Retrieves the journal ids for a given pov and filter

Parameters:

scenario - Scenario for which journals display info to be retrieved

year - Year for which journals display info to be retrieved

period - Period for which journals display info to be retrieved

value - Value for which journals display info to be retrieved

filter - journal filter options

Returns:

list of journal ids for the specified pov and filter

Throws:

HFMException

enumJournalTemplates

public List<JournalDisplayLine> enumJournalTemplates(TemplateFilter filter)
                                              throws HFMException

Gets the Journal Templates that match the file

Parameters:

filter - the filter to match

Returns:

the journal templates that match.

Throws:

HFMException

getJournal

public Journal getJournal(int journalId,
                          String scenario,
                          String year,
                          String period)
                   throws HFMException

Throws:

HFMException

getJournal

public Journal getJournal(int journalId,
                          String scenario,
                          String year,
                          String period,
                          boolean varianceRequired)
                   throws HFMException

Throws:

HFMException

getJournalByName

public Journal getJournalByName(String journalLabel,
                                String scenario,
                                String year,
                                String period)
                         throws HFMException

Gets a journal with the specified name

Parameters:

journalLabel - the name of the journal

scenario - the scenario for the journal

year - the year for the journal

period - the period for the journal

Returns:

Jouranl with the specified name

Throws:

HFMException

getJournalByName

public Journal getJournalByName(String journalLabel,
                                String scenario,
                                String year,
                                String period,
                                boolean varianceRequired)
                         throws HFMException

Gets a journal with the specified name

Parameters:

journalLabel - the name of the journal

scenario - the scenario for the journal

year - the year for the journal

period - the period for the journal

varianceRequired - whether to return variance info

Returns:

Jouranl with the specified name

Throws:

HFMException

checkForValidJournal

public Journal checkForValidJournal(String journalLabel,
                                    String scenario,
                                    String year,
                                    String period)
                             throws HFMException

This function checks whether a journal is valid or not

Parameters:

journalLabel - the journal name

scenario - the scenario for the journal

year - the year for the journal

period - the period for the journal

Returns:

the journal object if it is valid, null if it is not

Throws:

HFMException

getJournalTemplate

public Journal getJournalTemplate(String templateLabel)
                           throws HFMException

Retrieves a journal template with a given name

Parameters:

templateLabel - the name of the template

Returns:

the represenatation of the template

Throws:

HFMException

getJournalTemplate

public Journal getJournalTemplate(String templateLabel,
                                  boolean varianceRequired)
                           throws HFMException

Retrieves a journal template with a given name

Parameters:

templateLabel - the name of the template

varianceRequired - whether to get variance information

Returns:

the represenatation of the template

Throws:

HFMException

saveJournal

public int saveJournal(Journal journal)
                throws HFMException

Saves the journal

Parameters:

journal - object

Returns:

Returns the journal ID

Throws:

HFMException

saveJournalTemplate

public void saveJournalTemplate(Journal template)
                         throws HFMException

Saves the journal template

Parameters:

template - Journal object

Throws:

HFMException

performJournalAction

public List<String> performJournalAction(List<String> journalLabels,
                                         String scenario,
                                         String year,
                                         String period,
                                         JOURNAL_ACTION journalAction)
                                  throws HFMException

Executes a journal action for a given set of journal labels, and pov

Parameters:

journalLabels - the journals action will be taken on

scenario - the scenario the journals are for

year - the year the journals are for

period - the period the journals are for

journalAction - the action to take

Returns:

List of errors

Throws:

HFMException

deleteJournalTemplates

public void deleteJournalTemplates(List<String> templateLabels)
                            throws HFMException

Deletes one or more journal templates from the application

Parameters:

templateLabels - the name of the templates to delete

Throws:

HFMException

performScan

public List<JournalErrorDetail> performScan(Journal journal)
                                     throws HFMException

Validates the contents of a journal

Parameters:

journal - the journal to validate

Returns:

a list of errors pertaining to the journal

Throws:

HFMException

getCurrentJournalFilter

public JournalFilter getCurrentJournalFilter(boolean getSystemFilter)
                                      throws HFMException

Gets the currently set journal filter

Returns:

the current journal filter for the user in the current applicaiton

Throws:

HFMException

getCurrentTemplateFilter

public TemplateFilter getCurrentTemplateFilter(boolean getSystemFilter)
                                        throws HFMException

Gets the currently set template filter

Returns:

the current template filter for the user in the current applicaition

Throws:

HFMException

setCurrentJournalFilter

public void setCurrentJournalFilter(JournalFilter journalFilter)
                             throws HFMException

Sets the current journal filter for the user in the current applicaiton

Parameters:

journalFilter - the journal filter to set

Throws:

HFMException

setCurrentTemplateFilter

public void setCurrentTemplateFilter(TemplateFilter templateFilter)
                              throws HFMException

Sets the current template filter for the user in the current applicaiton

Parameters:

templateFilter - the template filter to set

Throws:

HFMException

getVariance

public JournalVariance getVariance(Journal journal,
                                   REPORT_QUERY_TYPE type)
                            throws HFMException

Throws:

HFMException

validateJournalPOV

public String validateJournalPOV(String povStr)
                          throws HFMException

Validates the POV for a Journal, checks that the account is valid, that the custom members are contained in the decendants list of the account's customXTopMember and that if ICP is enabled and the ICP member is valid

Parameters:

povStr -

Returns:

Error message

Throws:

HFMException

generateJournalFromTemplate

public List<JournalErrorDetail> generateJournalFromTemplate(String scenario,
                                                            String year,
                                                            String period,
                                                            List<String> journalLabels)
                                                     throws HFMException

Method for generating labels from a template

Parameters:

scenario - The scenario to use

year - The year to use

period - The period to use

journalLabels - The labels of the journals to be generated

Returns:

Sequence number of template and its details if error.

Throws:

HFMException

constructGridDef

public GridDefinition constructGridDef(List<JournalLineItem> lineItems,
                                       List<JournalDimension> jrnlPOV)
                                throws HFMException

Constructs the grid definition from the given line items. The GridDefinition is prepared with the following rules.

• Column will have only "Value" dimension. And its members would vary based on the "Value" member found in jrnlPOV.
  • for "Entity Currency", columns will have 3 value members which will be "Entity Currency, Entity Curr Adjs and Entity Curr Total".
  • for "Parent Curr Adjs", columns will have 3 value members which will be "Parent Currency, Parent Curr Adjs and Parent Curr Total".
  • for "[Parent Adjs]", columns will have 6 value members which will be "Entity Currency, Entity Curr Adjs,Entity Curr Total, [Parent], [Parent Adjs] and [Parent Total]".
  • for "[Contribution Adjs]", columns will have 6 value members which will be "Entity Currency, Entity Curr Adjs,Entity Curr Total, [Contribution],[Contribution Adjs] and [Contribution Total]".

Parameters:

lineItems - list of JournalLineItem which will be parsed for constructing Grid Definition

jrnlPOV - list of JournalDimension

Returns:

instance of GridDefinition, null if lineItems is empty or if jrnlPOV does not have "Value" dimension member

Throws:

HFMException - when the value dimension member is of "[Proportion]" or "[Elimination]"