public class Rule
extends java.lang.Object
Currently this can only be used to retrieve information about the rule such as the name or the cube. For example, currentRule.cube returns the cube that the current rule is being executed against which may be different than other objects in the current rule such as operation.cube.
To execute a rule please see JobFactory
.
By default, parameters are case insensitive and may not be null or empty unless otherwise specified.
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object arg0) |
Cube |
getCube()
Returns the cube this rule will execute against.
|
java.lang.String |
getDescription()
Returns the description for this rule.
|
java.lang.String |
getName()
Returns the name of this rule.
|
java.util.Map<java.lang.String,java.lang.String> |
getProperties()
Returns the properties for this rule.
|
java.lang.String |
getScript()
Returns the script of this rule.
|
oracle.epm.api.model.ScriptType |
getScriptType()
Returns the script type of this rule.
|
int |
hashCode() |
boolean |
isProtected()
Returns true if the rule script is protected and false if the script is
accessible.
|
public Cube getCube()
public java.lang.String getDescription()
public java.lang.String getName()
public java.util.Map<java.lang.String,java.lang.String> getProperties()
public java.lang.String getScript()
com.hyperion.planning.ProtectedIpException
- if the contents of this rule are
protectedpublic oracle.epm.api.model.ScriptType getScriptType()
public boolean isProtected()
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.