oracle.epm.fm.domainobject.metadata

Class MetadataOM

java.lang.Object

oracle.epm.fm.domainobject.metadata.MetadataOM

All Implemented Interfaces:

Serializable

public class MetadataOM
extends Object
implements Serializable

MetadataOM contains all metadata related APIs.

 
 getMembers API is used to retrieve members of any Dimension.

 Retrieving members of Scenario Dimension using getMembers API is explained below.

   MetadataOM metadataOM = new MetadataOM(session);

   MetadataFilter filter = new MetadataFilter();
   filter.setDimensionName("Scenario");
   filter.setListName("[Hierarchy]");

   MetadataViewOption view = new MetadataViewOption();
   view.setIncludeParent(false);
   view.setIncludeAncestorPath(false);
   view.setIncludeProperties(false);
   RecordSetRange range = new RecordSetRange();
   range.setStartIndex(0);
   range.setEndIndex(-1);
   view.setResultSetRange(range);

   List<Member> members = metadataOM.getMembers(filter, view);

 
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
MetadataOM(SessionInfo sessionInfo) Creates an instance of the MetadataOM object.

Method Summary

Modifier and Type	Method and Description
List<Member>	compareBaseMembers(String sessionID, Dimension dimension, Member fromParent, Member toParent) Internal Use Only returns the list of members from all the base members of top member fromParent.
List<Member>	enumDuplicateMembers(String sessionID, Dimension dimension, Member parent) Internal Use Only Returns the list of duplicate members under the specified parent member.
List<SharedMember>	enumSharedMembers(String sessionID, Dimension dimension) Internal Use Only returns the list of shared members with the dimension along with their parent details.
List<Member>	findMembers(String searchName, MetadataFilter filter, MetadataViewOption viewOptions) For ENUMMEMBERACTIONTYPE.VALIDATE_MEMBER and ENUMMEMBERACTIONTYPE.FIND_MEMBER.
List<Member>	findMembersByProperty(String dimensionName, Map<String,List<String>> propertyValue) find and retuns the list of members has property value specified for specific property in the property value object.
Map<String,String>	getApplicationAttributes(List<String> applicationAttributes) Gets the Application attributes .
Currency	getApplicationCurrency() Gets application level currency and scale.
String	getBaseFrequency() Get the base frequency of Period Dimension.
List<CellTextLabelInfo>	getCellTextLabels() Retrieve the list of cell text label for a given application session.
List<Currency>	getCurrencies(boolean ictOnly) Get the list of transaction currency.
List<Currency>	getCurrenciesForEntities(List<String> entities, List<String> parents, List<String> values) get Currencies for entities.
String	getDefaultParent(String dimensionName, String memberName) Returns the default parent of the member if any.
String	getDefaultPOV() Get default parent of the member.
int	getDefaultValueOfActiveStatusAccount() Get default active status for account.
List<DimensionProperty>	getDimensionProperties(String dimensionName) get the properties of the dimension given as a parameter.
List<Dimension>	getDimensions(List<DIMENSIONTYPE> types) Get the list of Dimension based on DIMENSIONTYPE.
List<String>	getFrequencies() getFrequencies Get the list of frequencies for the application.
String	getFrequency(String periodMember) Get the frequency for the given Period.
Map<String,Map<String,Integer>>	getGenerations(Map<String,List<String>> membersByDimension) get generations for members.
Map<String,List<MemberGenerationInfo>>	getGenerationsEx(Map<String,List<String>> membersByDimension) Get generations for members.
List<String>	getInvalidMembersInList(String dimensionName, String listName, List<String> membersToValidate) This function will validate that members are in a specified memberlist.
List<String>	getMemberIDs(String sessionID, String dimensionName, List<String> memberNames) Internal Use Only retuns the member ids for the member names specified.
List<MemberDetail>	getMemberInformation(List<String> memberNames, PREFERENCES preference) Get member information.
List<MemberList>	getMemberLists(String dimensionName) return all the member list based on dimension name.
List<Member>	getMemberProperties(String dimensionName, List<String> members, List<String> properties) get Members properties of dimension.
List<Member>	getMemberProperties(String dimensionName, List<String> members, List<String> properties, boolean securityAsPartner) get Members properties of dimension.
List<Member>	getMemberPropertiesUsingMembers(String dimensionName, List<Member> members, List<String> properties) get Members properties of dimension.
List<Member>	getMembers(MetadataFilter filter, MetadataViewOption options) For ENUMMEMBERACTIONTYPE.ENUM_MEMBER for ENUMMEMBERACTIONTYPE.ENUM_MEMBER_IN_LIST. get Members based on MetadataFilter and MetadataViewFilter option.
String	getMemberSelectorDef(String taskId) Get the memberselector definition for external tasks.
List<MemberEx>	getMembersEx(MetadataFilterEx filter, MetadataViewOptionEx options) get Members based on MetadataFilterEx and MetadataViewFilterEx option. ORACLE INTERNAL USE ONLY
List<MemberExSv>	getMembersExSv(MetadataFilter filter, MetadataViewOption options) For ENUMMEMBERACTIONTYPE.ENUM_MEMBER for ENUMMEMBERACTIONTYPE.ENUM_MEMBER_IN_LIST. get Members based on MetadataFilter and MetadataViewFilter option. ORACLE INTERNAL USE ONLY This version of getMembers returns additional information about a member (see MemberExSv).
List<FMDocument>	getMemberUsage(String sessionID, Dimension dimension, Member member) Internal Use Only returns all the Documents and Artifacts where the specified member is used.
List<Member>	getNumberOfChildren(String dimensionName, List<Member> members) sets the number of children field in the members passed in.
List<Integer>	getNumDecimalPlacesForAccounts(List<String> accountMembers) Return the number of decimal places for input Account members.
int	getNumPeriodsInFrequency(String frequency) Get the number of periods for the given frequency.
String	getPeriodFromFrequency(String frequency, int periodNumInFrequency) returns the memberlabel of the period that is at a given ordinal position within a frequency
List<MemberWithInternalId>	getPeriodMembersWithInternalIds() Internal Use Only Retreives period members and its internal ids.
List<String>	getPeriodsInScenarioFrequency(String scenario) This method retrieve a list of periods in the input scenario default frequency.
Map<String,CustomTopMember>	getTopCustomMembersForAccount(String accountMember) This method returns custom top member for an account for al the customs.
List<String>	getValidationAccounts() Get the list of validated accounts.
boolean	isMemberADescendantOf(String dimension, String member, String parent) Determines if a member is a descendant of another member.
boolean	isOrgByPeriodApplication() Determine if app is org by period or not.
boolean	isPhaseSubmissionEnabledForApplication() Returns whether or not a given application has been enabled for phase submission.
Map<String,List<Member>>	validateCustomMembers(Map<String,List<String>> customMembersToBeValidatedByAccount) Returns the valid custom members corresponding to custom dimension against the given account.
List<String>	validateDefFrequencyPeriods(String scenario, List<String> periodsTobValidated) Validates that each period dimemsion member's frequency matches with.
Map<String,List<Member>>	validateMembers(Map<String,List<String>> membersToBeValidatedByDimension, boolean securityAsPartner) validates Members for Dimensions.
Map<String,List<Member>>	validateMembers(Map<String,List<String>> membersToBeValidatedByDimension, boolean securityAsPartner, boolean doNotAddParentIfNotPresent) validates Members for Dimensions.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataOM

public MetadataOM(SessionInfo sessionInfo)
           throws HFMException

Creates an instance of the MetadataOM object.

Parameters:

sessionInfo - session related information

Throws:

HFMException - HFMException ErrorCodeConsts.FAILED_OM_INIT

Method Detail

getDimensions

public List<Dimension> getDimensions(List<DIMENSIONTYPE> types)
                              throws HFMException

Get the list of Dimension based on DIMENSIONTYPE.

Parameters:

types - DIMENSIONTYPE

Returns:

list of Dimension

Throws:

HFMException

getMemberLists

public List<MemberList> getMemberLists(String dimensionName)
                                throws HFMException

return all the member list based on dimension name.

Parameters:

dimensionName - dimension name

Returns:

list of MemberList

Throws:

HFMException

getMemberProperties

public List<Member> getMemberProperties(String dimensionName,
                                        List<String> members,
                                        List<String> properties)
                                 throws HFMException

get Members properties of dimension.

Parameters:

dimensionName - dimension name

members - list of members for which want to get property

properties - //If properties is null or empty, member object will have all properties.

Returns:

list of Members

Throws:

HFMException

getMemberProperties

public List<Member> getMemberProperties(String dimensionName,
                                        List<String> members,
                                        List<String> properties,
                                        boolean securityAsPartner)
                                 throws HFMException

get Members properties of dimension.

Parameters:

dimensionName - dimension name

members - list of members for which want to get property

properties - //If properties is null or empty, member object will have all properties.

securityAsPartner - - true if want to validate members against partner account

Returns:

list of Members

Throws:

HFMException

getMembers

public List<Member> getMembers(MetadataFilter filter,
                               MetadataViewOption options)
                        throws HFMException

For ENUMMEMBERACTIONTYPE.ENUM_MEMBER for ENUMMEMBERACTIONTYPE.ENUM_MEMBER_IN_LIST.
get Members based on MetadataFilter and MetadataViewFilter option.

Parameters:

filter - MetadataFilter option

options - MetadataViewFilter option

Returns:

list of Members

Throws:

HFMException

getMembersEx

public List<MemberEx> getMembersEx(MetadataFilterEx filter,
                                   MetadataViewOptionEx options)
                            throws HFMException

get Members based on MetadataFilterEx and MetadataViewFilterEx option.
ORACLE INTERNAL USE ONLY

Parameters:

filter - MetadataFilter option

options - MetadataViewFilter option

Returns:

list of Members

Throws:

HFMException

getMembersExSv

public List<MemberExSv> getMembersExSv(MetadataFilter filter,
                                       MetadataViewOption options)
                                throws HFMException

For ENUMMEMBERACTIONTYPE.ENUM_MEMBER for ENUMMEMBERACTIONTYPE.ENUM_MEMBER_IN_LIST.
get Members based on MetadataFilter and MetadataViewFilter option.
ORACLE INTERNAL USE ONLY This version of getMembers returns additional information about a member (see MemberExSv). It also returns the correct generation information for members that have multiple parents.

Parameters:

filter - MetadataFilter option

options - MetadataViewFilter option

Returns:

list of Members and information about each.

Throws:

HFMException

validateMembers

public Map<String,List<Member>> validateMembers(Map<String,List<String>> membersToBeValidatedByDimension,
                                                boolean securityAsPartner)
                                         throws HFMException

validates Members for Dimensions.

Parameters:

membersToBeValidatedByDimension - - map contains Dimension as key and list of members as value

securityAsPartner - - true if want to validate members against partner account

Returns:

map contains Dimension as key and list of members as value

Throws:

HFMException

validateMembers

public Map<String,List<Member>> validateMembers(Map<String,List<String>> membersToBeValidatedByDimension,
                                                boolean securityAsPartner,
                                                boolean doNotAddParentIfNotPresent)
                                         throws HFMException

validates Members for Dimensions.

Parameters:

membersToBeValidatedByDimension - - map contains Dimension as key and list of members as value

securityAsPartner - - true if want to validate members against partner account

doNotAddParentIfNotPresent - flag if true will not put default parent for entity if parent is not present

Returns:

map contains Dimension as key and list of members as value

Throws:

HFMException

getDefaultPOV

public String getDefaultPOV()
                     throws HFMException

Get default parent of the member.

Returns:

the default parent of the member if any

Throws:

HFMException

getPeriodsInScenarioFrequency

public List<String> getPeriodsInScenarioFrequency(String scenario)
                                           throws HFMException

This method retrieve a list of periods in the input scenario default frequency.

Parameters:

scenario - scenario in which default frequency we want to get the list of periods

Returns:

list of period

Throws:

HFMException

validateDefFrequencyPeriods

public List<String> validateDefFrequencyPeriods(String scenario,
                                                List<String> periodsTobValidated)
                                         throws HFMException

Validates that each period dimemsion member's frequency matches with. the default frequency of the scenario dimension member and returns the invalid ones if any.

Parameters:

scenario - The Scenario member to look up.

periodsTobValidated - The list of periods which you want to validate.

Returns:

An array of invalid periods for the default frequency of the scenario passed in.

Throws:

HFMException

getCellTextLabels

public List<CellTextLabelInfo> getCellTextLabels()
                                          throws HFMException

Retrieve the list of cell text label for a given application session.

Returns:

list of cell text label for a given application session

Throws:

HFMException

isOrgByPeriodApplication

public boolean isOrgByPeriodApplication()
                                 throws HFMException

Determine if app is org by period or not.

Returns:

true if it's an org by period application, false otherwise

Throws:

HFMException

isPhaseSubmissionEnabledForApplication

public boolean isPhaseSubmissionEnabledForApplication()
                                               throws HFMException

Returns whether or not a given application has been enabled for phase submission.

Returns:

Whether phase submission is enabled for the application

Throws:

HFMException

getValidationAccounts

public List<String> getValidationAccounts()
                                   throws HFMException

Get the list of validated accounts.

Returns:

list of validated accounts

Throws:

HFMException

getTopCustomMembersForAccount

public Map<String,CustomTopMember> getTopCustomMembersForAccount(String accountMember)
                                                          throws HFMException

This method returns custom top member for an account for al the customs.

Parameters:

accountMember - account for which custom top member to be retrieved

Returns:

a map of Custom aliases and its top memebr for the acocunt

Throws:

HFMException

getNumDecimalPlacesForAccounts

public List<Integer> getNumDecimalPlacesForAccounts(List<String> accountMembers)
                                             throws HFMException

Return the number of decimal places for input Account members. This is especially needed by Manage Ownership page as well as data grid from the web ui for data formatting.

Parameters:

accountMembers - list of account members to retrieve the number of decimal places for

Returns:

Return the number of decimal places for input Account members

Throws:

HFMException

getDefaultParent

public String getDefaultParent(String dimensionName,
                               String memberName)
                        throws HFMException

Returns the default parent of the member if any.

Parameters:

dimensionName - - A valid dimension Name

memberName - - A valid member Name for which the default parent has to be retrieved

Returns:

- Returns the default parent of the member if any.

Throws:

HFMException

getMemberIDs

public List<String> getMemberIDs(String sessionID,
                                 String dimensionName,
                                 List<String> memberNames)
                          throws HFMException

Internal Use Only retuns the member ids for the member names specified.

Parameters:

sessionID - - A valid application session i

dimensionName - - A valid dimension Name

memberNames - - A valid list member Names

Returns:

list of member ids for the member names specified.

Throws:

HFMException

findMembersByProperty

public List<Member> findMembersByProperty(String dimensionName,
                                          Map<String,List<String>> propertyValue)
                                   throws HFMException

find and retuns the list of members has property value specified for specific property in the property value object.

Parameters:

dimensionName - dimension name

propertyValue - - key is propertyName and value is list of property values

Returns:

list of members has property value

Throws:

HFMException

enumSharedMembers

public List<SharedMember> enumSharedMembers(String sessionID,
                                            Dimension dimension)
                                     throws HFMException

Internal Use Only returns the list of shared members with the dimension along with their parent details.

Parameters:

sessionID - session ID

dimension - dimension

Returns:

list of shared members with the dimension along with their parent details

Throws:

HFMException

compareBaseMembers

public List<Member> compareBaseMembers(String sessionID,
                                       Dimension dimension,
                                       Member fromParent,
                                       Member toParent)
                                throws HFMException

Internal Use Only returns the list of members from all the base members of top member fromParent. which are not the base members of toParent

Parameters:

sessionID - session id

dimension - dimension

fromParent - fromParent member

toParent - toParent member

Returns:

list of members from all the base members of top member fromParent

Throws:

HFMException

enumDuplicateMembers

public List<Member> enumDuplicateMembers(String sessionID,
                                         Dimension dimension,
                                         Member parent)
                                  throws HFMException

Internal Use Only Returns the list of duplicate members under the specified parent member.

Parameters:

sessionID - session id

dimension - dimension

parent - parent Member

Returns:

list of duplicate members under the specified parent member

Throws:

HFMException

getMemberUsage

public List<FMDocument> getMemberUsage(String sessionID,
                                       Dimension dimension,
                                       Member member)
                                throws HFMException

Internal Use Only returns all the Documents and Artifacts where the specified member is used.

Parameters:

sessionID - sessionID

dimension - dimension

member - member

Returns:

list of Documents and Artifacts where the specified member is used

Throws:

HFMException

getMemberSelectorDef

public String getMemberSelectorDef(String taskId)
                            throws HFMException

Get the memberselector definition for external tasks.

Parameters:

taskId - taskId

Returns:

memberselector definition for external tasks

Throws:

HFMException

getApplicationCurrency

public Currency getApplicationCurrency()
                                throws HFMException

Gets application level currency and scale.

Returns:

Currency

Throws:

HFMException

getCurrencies

public List<Currency> getCurrencies(boolean ictOnly)
                             throws HFMException

Get the list of transaction currency.

Parameters:

ictOnly - : Send true for ICT module

Returns:

list of Currency

Throws:

HFMException

validateCustomMembers

public Map<String,List<Member>> validateCustomMembers(Map<String,List<String>> customMembersToBeValidatedByAccount)
                                               throws HFMException

Returns the valid custom members corresponding to custom dimension against the given account. Note: Invalid member names are simply ignored.

Parameters:

customMembersToBeValidatedByAccount - - map should contain only one Account(dimension) and can have one or more custom dimensions and their corresponding list of members. key= Account dimension, Value= list of account member (only one account member in the list) Key=Custom dimension, value=list of custom members

Returns:

A map containing a list of custom member objects for the valid members in each dimension(Custom).returned map will not have account. Key=custom dimension, Value=list of valid members. if all the custom members for the custom dimension is not valid then return list will empty.

Throws:

HFMException

getDefaultValueOfActiveStatusAccount

public int getDefaultValueOfActiveStatusAccount()
                                         throws HFMException

Get default active status for account.

Returns:

default active status for account

Throws:

HFMException

findMembers

public List<Member> findMembers(String searchName,
                                MetadataFilter filter,
                                MetadataViewOption viewOptions)
                         throws HFMException

For ENUMMEMBERACTIONTYPE.VALIDATE_MEMBER and ENUMMEMBERACTIONTYPE.FIND_MEMBER. Find the list of members based on search string and filter options.

Parameters:

searchName - - search String

filter - - MetadataFilter filterOption

viewOptions - - MetadataViewFilter viewFilter options

Returns:

- list of members based on search value and view option

Throws:

HFMException

getMemberInformation

public List<MemberDetail> getMemberInformation(List<String> memberNames,
                                               PREFERENCES preference)
                                        throws HFMException

Get member information.

Parameters:

memberNames - list of member names

preference - preference enum (name ,description and both)

Returns:

list of Member details

Throws:

HFMException

getCurrenciesForEntities

public List<Currency> getCurrenciesForEntities(List<String> entities,
                                               List<String> parents,
                                               List<String> values)
                                        throws HFMException

get Currencies for entities.

Parameters:

entities - - list of child entities

parents - - list of parents of entities ,it optional and applicable for refresh Currencies for SVP

values - - list of values ,it optional and applicable for refresh Currencies for SVP

Returns:

list of currencies ,returned list of default currecies for entities if values object is null.

Throws:

HFMException

getInvalidMembersInList

public List<String> getInvalidMembersInList(String dimensionName,
                                            String listName,
                                            List<String> membersToValidate)
                                     throws HFMException

This function will validate that members are in a specified memberlist.

Parameters:

dimensionName - The dimension that the member list is valid for

listName - The member list we are checking in

membersToValidate - A list of member names that we are validating

Returns:

the list of members that are invalid, if no members were invalid this should be null

Throws:

HFMException

getGenerations

public Map<String,Map<String,Integer>> getGenerations(Map<String,List<String>> membersByDimension)
                                               throws HFMException

get generations for members.

Parameters:

membersByDimension - - list of members for each dimension

Returns:

generations of the members for each dimension.

Throws:

HFMException

getGenerationsEx

public Map<String,List<MemberGenerationInfo>> getGenerationsEx(Map<String,List<String>> membersByDimension)
                                                        throws HFMException

Get generations for members. This version of getGenerations returns extended generation info for each member (see MemberGenerationInfo class) Note that the same member might be returned twice in List<MemberGenerationInfo> if it appears multiple (non-consecutive times in the smartview grid. This allows for members with multiple parents where their generation may be different in the hierarchy dependending upon context.

Parameters:

membersByDimension - - list of members for each dimension

Returns:

generations of the members for each dimension.

Throws:

HFMException

getFrequencies

public List<String> getFrequencies()
                            throws HFMException

getFrequencies Get the list of frequencies for the application.

Returns:

list of frequencies supported for the application.

Throws:

HFMException

getNumberOfChildren

public List<Member> getNumberOfChildren(String dimensionName,
                                        List<Member> members)
                                 throws HFMException

sets the number of children field in the members passed in.

Parameters:

dimensionName - dimension name

members - list of members for which want to get the number of children

Returns:

list of members with the member property, numChildren, populated

Throws:

HFMException

getMemberPropertiesUsingMembers

public List<Member> getMemberPropertiesUsingMembers(String dimensionName,
                                                    List<Member> members,
                                                    List<String> properties)
                                             throws HFMException

get Members properties of dimension.

Parameters:

dimensionName - dimension name

members - list of members for which want to get property

properties - //If properties is null or empty, member object will have all properties.

Returns:

list of Members

Throws:

HFMException

getDimensionProperties

public List<DimensionProperty> getDimensionProperties(String dimensionName)
                                               throws HFMException

get the properties of the dimension given as a parameter.

Parameters:

dimensionName - dimension name

Returns:

list of Dimension Property

Throws:

HFMException

getApplicationAttributes

public Map<String,String> getApplicationAttributes(List<String> applicationAttributes)
                                            throws HFMException

Gets the Application attributes .

Parameters:

applicationAttributes - the application attributes list as defined in the metadata xml

Returns:

the map containing the application attributes and corresponding attribute value

Throws:

HFMException

getPeriodMembersWithInternalIds

public List<MemberWithInternalId> getPeriodMembersWithInternalIds()
                                                           throws HFMException

Internal Use Only Retreives period members and its internal ids.

Returns:

list of MemberWithInternalId object which contains period members info along with internal ids

Throws:

HFMException

getBaseFrequency

public String getBaseFrequency()
                        throws HFMException

Get the base frequency of Period Dimension.

Returns:

frequency as MTD, YTD..

Throws:

HFMException

getFrequency

public String getFrequency(String periodMember)
                    throws HFMException

Get the frequency for the given Period.

Parameters:

periodMember - member of period dimension

Returns:

frequency as MTD, YTD..

Throws:

HFMException

getNumPeriodsInFrequency

public int getNumPeriodsInFrequency(String frequency)
                             throws HFMException

Get the number of periods for the given frequency.

Parameters:

frequency - as MTD, YTD..

Returns:

List of Period

Throws:

HFMException

isMemberADescendantOf

public boolean isMemberADescendantOf(String dimension,
                                     String member,
                                     String parent)
                              throws HFMException

Determines if a member is a descendant of another member.

Parameters:

dimension - name of the dimension.

member - name of the member.

parent - name of the parent.

Returns:

true if the member is a descendant of the given parent, false otherwise.

Throws:

HFMException

getPeriodFromFrequency

public String getPeriodFromFrequency(String frequency,
                                     int periodNumInFrequency)
                              throws HFMException

returns the memberlabel of the period that is at a given ordinal position within a frequency

Parameters:

frequency - as MTD, YTD..

periodNumInFrequency - starts from 0

Returns:

period member name

Throws:

HFMException