public class Application
extends java.lang.Object
By default, parameters are case insensitive and may not be null or empty unless otherwise specified.
If a method's last parameter is a varargs of cubes, then the method can apply to the entire application or the subset of the cubes. If one or more cubes are specified, then the result will only contain the objects that are valid for at least one of the specified cubes. If no cubes are specified, then the method will consider all objects regardless of the cube.
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object arg0) |
Job |
executeJob(JobDefinition jobDef)
Executes the job with the specified job definition and returns the
job once it has completed or failed.
|
java.util.List<java.lang.String> |
getAliasTableNames()
Returns a list of alias tables belonging to this application.
|
FiscalCalendar |
getCalendar()
Returns the fiscal calendar for this application.
|
Connection |
getConnection(java.lang.String name)
Returns the connection with the specified name.
|
Cube |
getCube(java.lang.String cubeName)
Returns the cube with the specified name.
|
java.util.List<Cube> |
getCubes()
Returns a list of cubes belonging to this application.
|
CurrencyMode |
getCurrencyMode()
Returns the currency model for this application.
|
DataMap |
getDataMap(java.lang.String dataMapName)
Returns the data map with the specified name.
|
java.util.List<DataMap> |
getDataMaps()
Returns all the data maps defined for this application.
|
Member |
getDefaultCurrency()
Returns the default currency member for this application.
|
Dimension |
getDimension(oracle.epm.api.model.DimensionType dimType,
Cube... cubes)
Returns a dimension with the specified dimension type.
|
Dimension |
getDimension(java.lang.String dimName,
Cube... cubes)
Returns the dimension with the specified name.
|
java.util.List<Dimension> |
getDimensions(Cube... cubes)
Returns a list of dimensions.
|
JobFactory |
getJobFactory()
Returns a job factory.
|
MlModel |
getMlModel(java.lang.String fullyQualifiedModelName)
Returns the ML model with the specified name from the folder specified
by the path in the fully qualified model name.
|
MlModel |
getMlModel(java.lang.String path,
java.lang.String modelName)
Returns the ML model with the specified name from the folder
specified by the path.
|
java.util.List<MlModel> |
getMlModels()
Returns a list of ML models deployed to this application.
|
java.lang.String |
getName()
Returns the name for this application.
|
ScenarioRollup |
getScenarioRollup(java.lang.String scenarioRollupName)
Returns the scenario rollup with the specified name and selected model
as the root level node.
|
ScenarioRollup |
getScenarioRollup(java.lang.String scenarioRollupName,
java.lang.String modelName)
Returns the scenario rollup with the specified name and selected model
as the specified model name.
|
SmartList |
getSmartList(java.lang.String name)
Returns a smart list with the specified name.
|
StrategicModel |
getStrategicModel(java.lang.String modelName)
Returns the strategic model with the specified name.
|
SubstitutionVariable |
getSubstitutionVariable(java.lang.String name)
Returns a substitution variable with the specified name defined at the
application level.
|
java.lang.String |
getSubstitutionVariableValue(java.lang.String name)
Returns the effective value of the specified substitution variable
for this application or null if there is no effective value.
|
ApplicationType |
getType()
Return the type of this application.
|
User |
getUser(java.lang.String userName)
Returns the user with the specified user name.
|
UserVariable |
getUserVariable(java.lang.String name)
Returns a user variable with the specified name.
|
java.util.List<UserVariable> |
getUserVariables()
Returns the list of user variables for this application.
|
boolean |
hasConnection(java.lang.String name)
Returns true if a connection with the specified name exists.
|
boolean |
hasCube(java.lang.String cubeName)
Returns true if a cube with the specified name exists.
|
boolean |
hasDataMap(java.lang.String dataMapName)
Returns true if a data map with the specified name exists.
|
boolean |
hasDimension(oracle.epm.api.model.DimensionType dimType,
Cube... cubes)
Returns true if a dimension with the specified dimension type exists.
|
boolean |
hasDimension(java.lang.String dimName,
Cube... cubes)
Returns true if a dimension with the specified name exists.
|
int |
hashCode() |
boolean |
hasMlModel(java.lang.String fullyQualifiedModelName)
Returns true if a ML model with the specified name exists in the folder
specified by the path in the fully qualified model name.
|
boolean |
hasMlModel(java.lang.String path,
java.lang.String modelName)
Returns true if a ML model with the specified name exists in the folder
specified by the path.
|
boolean |
hasScenarioRollup(java.lang.String scenarioRollupName)
Returns true if a scenario rollup with the specified name exists
with a root node.
|
boolean |
hasScenarioRollup(java.lang.String scenarioRollupName,
java.lang.String modelName)
Returns true if a scenario rollup with the specified name exists
with the specified model.
|
boolean |
hasSmartList(java.lang.String name)
Returns true if the specified smart list exists.
|
boolean |
hasStrategicModel(java.lang.String modelName)
Returns true if a strategic model with the specified name exists.
|
boolean |
hasSubstitutionVariable(java.lang.String name)
Returns true if a substitution variable with the specified name exists
at the application level.
|
boolean |
hasUserVariable(java.lang.String name)
Returns true if the specified user variable exists.
|
void |
setSubstitutionVariableValue(java.lang.String name,
java.lang.String value,
Cube... cubes)
Sets the value for the substitution variable with the specified name.
|
void |
setUserVariableValue(UserVariable userVar,
Member value)
Sets the user variable value for the current user.
|
java.lang.String |
toString()
Returns a string representation of the object.
|
public Job executeJob(JobDefinition jobDef) throws java.lang.Exception
This will execute the job synchronously and will return only when the job execution either completes successfully or fails.
This job instance will get created as a child job of the application.
Supported job types are Rules, Ruleset, Template and Clear Cube. Parameter values for Member, Members, Member Range and Cross Dimension type of rtps being passed to this job should be valid in the cube the current Groovy rule is being executed against.
Note: At this time, rtp evaluations are indetermined if a rule executing against one cube executes a rule directly or indirectly in a different cube. In most cases this should be avoided as behavior in this area is subject to change.
jobDef
- job definitionjava.lang.Exception
- if an unexpected fault occurspublic java.util.List<java.lang.String> getAliasTableNames()
public FiscalCalendar getCalendar()
public Connection getConnection(java.lang.String name)
name
- name of the connectionpublic Cube getCube(java.lang.String cubeName)
cubeName
- name of the cubepublic java.util.List<Cube> getCubes()
public CurrencyMode getCurrencyMode()
public DataMap getDataMap(java.lang.String dataMapName)
dataMapName
- name of the cubepublic java.util.List<DataMap> getDataMaps()
public Member getDefaultCurrency()
public Dimension getDimension(oracle.epm.api.model.DimensionType dimType, Cube... cubes)
If one or more cubes are specified, then the result only contains the objects that are valid for at least one of the specified cubes.
dimType
- type of dimensioncubes
- an optional array of cubespublic Dimension getDimension(java.lang.String dimName, Cube... cubes)
If one or more cubes are specified, then the result only contains the objects that are valid for at least one of the specified cubes.
dimName
- name for the dimensioncubes
- an optional array of cubespublic java.util.List<Dimension> getDimensions(Cube... cubes)
If one or more cubes are specified, then the result only contains the objects that are valid for at least one of the specified cubes.
cubes
- an optional array of cubespublic JobFactory getJobFactory()
public MlModel getMlModel(java.lang.String fullyQualifiedModelName)
fullyQualifiedModelName
- fully qualified model name including its
path. For e.g. "/Library/folder1/folder1_2/Model 1" or "/Library/Model 1"public MlModel getMlModel(java.lang.String path, java.lang.String modelName)
path
- to the ML model from the root. For e.g.
"/Library/folder1/folder1_2" or "/Library" for root foldermodelName
- name of the ML modelpublic java.util.List<MlModel> getMlModels()
public java.lang.String getName()
public ScenarioRollup getScenarioRollup(java.lang.String scenarioRollupName)
scenarioRollupName
- name of the scenario rolluppublic ScenarioRollup getScenarioRollup(java.lang.String scenarioRollupName, java.lang.String modelName)
scenarioRollupName
- name of the scenario rollupmodelName
- name of the selected modelpublic SmartList getSmartList(java.lang.String name)
name
- the name of the user variablepublic StrategicModel getStrategicModel(java.lang.String modelName)
modelName
- name of the modelpublic SubstitutionVariable getSubstitutionVariable(java.lang.String name)
name
- name of the substitution variablecom.hyperion.planning.HspRuntimeException
- if the substitution variable was not foundpublic java.lang.String getSubstitutionVariableValue(java.lang.String name)
name
- name of the substitution variablepublic ApplicationType getType()
public User getUser(java.lang.String userName)
userName
- name of the userpublic UserVariable getUserVariable(java.lang.String name)
name
- the name of the user variablepublic java.util.List<UserVariable> getUserVariables()
public boolean hasConnection(java.lang.String name)
name
- name of the connectionpublic boolean hasCube(java.lang.String cubeName)
cubeName
- name of the cubepublic boolean hasDataMap(java.lang.String dataMapName)
dataMapName
- name of the data mappublic boolean hasDimension(oracle.epm.api.model.DimensionType dimType, Cube... cubes)
If one or more cubes are specified, then the result only contains the objects that are valid for at least one of the specified cubes.
dimType
- type of dimensioncubes
- an optional array of cubespublic boolean hasDimension(java.lang.String dimName, Cube... cubes)
If one or more cubes are specified, then the result is true only if the dimension is valid for at least one of the specified cubes.
dimName
- name for the dimensioncubes
- an optional array of cubespublic boolean hasMlModel(java.lang.String fullyQualifiedModelName)
fullyQualifiedModelName
- fully qualified model name including its
path. For e.g. "/Library/folder1/folder1_2/Model 1" or "/Library/Model 1"public boolean hasMlModel(java.lang.String path, java.lang.String modelName)
path
- to the ML model from the root. For e.g.
"/Library/folder1/folder1_2" or "/Library" for root foldermodelName
- name of the ML modelpublic boolean hasScenarioRollup(java.lang.String scenarioRollupName)
For a scenario rollup to be valid, the root model within the scenario rollup should contain at least one child node.
scenarioRollupName
- name of scenario rolluppublic boolean hasScenarioRollup(java.lang.String scenarioRollupName, java.lang.String modelName)
For a scenario rollup to be valid, the specified model within the scenario rollup should contain at least one child node.
scenarioRollupName
- scenario rollup namemodelName
- name of selected model. On null, the root model of
the scenario rollup will be taken as the selected model.public boolean hasSmartList(java.lang.String name)
name
- the name of the smart listpublic boolean hasStrategicModel(java.lang.String modelName)
modelName
- name of the modelpublic boolean hasSubstitutionVariable(java.lang.String name)
name
- name of the substitution variablepublic boolean hasUserVariable(java.lang.String name)
name
- the name of the user variablepublic void setSubstitutionVariableValue(java.lang.String name, java.lang.String value, Cube... cubes)
If one or more cubes are specified, the substitution variable value is set for each of the specified cubes else the value is set at the application level. The variable will be created if it does not exist already.
This is a privileged method, see section Privileged Method
name
- name of the substitution variablevalue
- value to setcubes
- an optional array of cubespublic void setUserVariableValue(UserVariable userVar, Member value) throws java.lang.Exception
userVar
- user variablevalue
- value to setjava.lang.Exception
- if an unexpected fault occurspublic java.lang.String toString()
toString
in class java.lang.Object
public boolean equals(java.lang.Object arg0)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
Copyright © 2017, 2024, Oracle and/or its affiliates. All rights reserved.