|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Rule
The Rule
interface represents an enterprise rule definition for
a palo Cube
. It is characterized by its id and a raw
rule definition. Furthermore a rule corresponds to only one cube.
Method Summary | |
---|---|
java.lang.String |
getComment()
Returns an optional comment for this rule or null if none
was set. |
Cube |
getCube()
Returns the Cube which is affected by this rule |
java.lang.String |
getDefinition()
Returns the rule definition, i.e. its textual representation |
java.lang.String |
getExternalIdentifier()
Returns the optional external identifier or null if none
was set |
java.lang.String |
getId()
Returns the unique identifier for this rule instance |
long |
getTimestamp()
Returns the creation time of this rule in milliseconds since 1970-01-01 |
boolean |
isActive()
Returns true if this rule is currently active, otherwise
false |
void |
setActive(boolean activate)
Activates or deactivates this rule. |
void |
setComment(java.lang.String comment)
Sets an optional comment for this rule. |
void |
setDefinition(java.lang.String definition)
Sets a definition for this rule. |
void |
setExternalIdentifier(java.lang.String externalId)
Sets a new external identifier string to use inside rule definition instead of definition name. |
void |
setExternalIdentifier(java.lang.String externalId,
boolean useIt)
Sets a new external identifier string and use it inside rule definition NOTE: this will update current rule and therefore performs a server request! |
void |
update(java.lang.String definition,
java.lang.String externalIdentifier,
boolean useIt,
java.lang.String comment)
Updates this rule with the given parameters. |
void |
update(java.lang.String definition,
java.lang.String externalIdentifier,
boolean useIt,
java.lang.String comment,
boolean activate)
Updates this rule with the given parameters. |
void |
useExternalIdentifier(boolean useIt)
En- or disables the usage of a specified external identifier. |
Method Detail |
---|
java.lang.String getId()
Cube getCube()
Cube
which is affected by this rule
void setDefinition(java.lang.String definition)
definition
- new rule definitionjava.lang.String getDefinition()
long getTimestamp()
void setComment(java.lang.String comment)
comment
- a rule commentjava.lang.String getComment()
null
if none
was set.
null
if none was setvoid setExternalIdentifier(java.lang.String externalId)
externalId
- the identifier to usevoid setExternalIdentifier(java.lang.String externalId, boolean useIt)
externalId
- the identifier to useuseIt
- set to true
if new identifier should be used
in rule defintion, to false
otherwisejava.lang.String getExternalIdentifier()
null
if none
was set
null
void useExternalIdentifier(boolean useIt)
void update(java.lang.String definition, java.lang.String externalIdentifier, boolean useIt, java.lang.String comment)
definition
- the new rule definitionexternalIdentifier
- the new rule external identifieruseIt
- specify if external identifier should be usedcomment
- a commentvoid update(java.lang.String definition, java.lang.String externalIdentifier, boolean useIt, java.lang.String comment, boolean activate)
definition
- the new rule definitionexternalIdentifier
- the new rule external identifieruseIt
- specify if external identifier should be usedcomment
- a commentactivate
- specify if this rule should be activated or deactivatedboolean isActive()
true
if this rule is currently active, otherwise
false
true
if this rule is active, false
otherwisevoid setActive(boolean activate)
activate
- specify true
to activate this rule or
false
to deactivate it.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |