Hook (EBX® Rules Portfolio Add-on Version 1.7.11 Java API)

java.lang.Object
- com.orchestranetworks.addon.rpfl.Hook

```
public final class Hook
extends Object
```
Defines the event that executes a rule such as 'Before update', 'After insert', etc.
For Manual Validation rules and Table set rules, no hook is used.

Field Summary

Fields
Modifier and Type	Field and Description
`static Hook`	`AfterCreate` Defines the 'After create' hook.
`static Hook`	`AfterDelete` Defines the 'After delete' hook.
`static Hook`	`AfterUpdate` Defines the 'After update' hook.
`static Hook`	`BeforeCreate` Defines the 'Before create' hook.
`static Hook`	`BeforeDelete` Defines the 'Before delete' hook.
`static Hook`	`BeforeUpdate` Defines the 'Before update' hook.
`static Hook`	`OnConstraint` Defines the 'On constraint' hook.
`static Hook`	`OnDemand` Defines the 'On demand' hook.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.onwbp.base.text.UserMessage`	`getLabel()` Returns the `UserMessage` label of this hook.
`String`	`getName()` Returns the `String` name of this hook.
`boolean`	`isAfterCreate()` Returns `true` if this is 'After create'.
`boolean`	`isAfterDelete()` Returns `true` if this is 'After delete'.
`boolean`	`isAfterUpdate()` Returns `true` if this is 'After update'.
`boolean`	`isBeforeCreate()` Returns `true` if this is 'Before create'.
`boolean`	`isBeforeDelete()` Returns `true` if this is 'Before delete'.
`boolean`	`isBeforeUpdate()` Returns `true` if this is 'Before update'.
`boolean`	`isOnConstraint()` Returns `true` if this is 'On constraint'.
`boolean`	`isOnDemand()` Returns `true` if this is 'On demand'.
`static Hook`	`parse(String name)` Returns the instance that corresponds to the value specified.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BeforeCreate
```
public static final Hook BeforeCreate
```
    Defines the 'Before create' hook.
  - AfterCreate
```
public static final Hook AfterCreate
```
    Defines the 'After create' hook.
  - BeforeUpdate
```
public static final Hook BeforeUpdate
```
    Defines the 'Before update' hook.
  - AfterUpdate
```
public static final Hook AfterUpdate
```
    Defines the 'After update' hook.
  - BeforeDelete
```
public static final Hook BeforeDelete
```
    Defines the 'Before delete' hook.
  - AfterDelete
```
public static final Hook AfterDelete
```
    Defines the 'After delete' hook.
  - OnDemand
```
public static final Hook OnDemand
```
    Defines the 'On demand' hook.
  - OnConstraint
```
public static final Hook OnConstraint
```
    Defines the 'On constraint' hook.
    
    Since:
    
    1.2.0
- Method Detail
  - parse
```
public static Hook parse(String name)
```
    Returns the instance that corresponds to the value specified.
  - getName
```
public String getName()
```
    Returns the String name of this hook.
  - isAfterCreate
```
public boolean isAfterCreate()
```
    Returns true if this is 'After create'.
  - isAfterDelete
```
public boolean isAfterDelete()
```
    Returns true if this is 'After delete'.
  - isAfterUpdate
```
public boolean isAfterUpdate()
```
    Returns true if this is 'After update'.
  - isBeforeCreate
```
public boolean isBeforeCreate()
```
    Returns true if this is 'Before create'.
  - isBeforeDelete
```
public boolean isBeforeDelete()
```
    Returns true if this is 'Before delete'.
  - isBeforeUpdate
```
public boolean isBeforeUpdate()
```
    Returns true if this is 'Before update'.
  - isOnDemand
```
public boolean isOnDemand()
```
    Returns true if this is 'On demand'.
  - isOnConstraint
```
public boolean isOnConstraint()
```
    Returns true if this is 'On constraint'.
    
    Since:
    
    1.2.0
  - getLabel
```
public com.onwbp.base.text.UserMessage getLabel()
```
    Returns the UserMessage label of this hook.
    
    Since:
    
    1.6.0

EBX® Rules Portfolio Add-on Version 1.7.11 [0025].

Copyright Cloud Software Group, Inc. 2001-2023. All rights reserved.
All third party product and company names and third party marks mentioned in this document are the property of their respective owners and are mentioned for identification.

Class Hook

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BeforeCreate

AfterCreate

BeforeUpdate

AfterUpdate

BeforeDelete

AfterDelete

OnDemand

OnConstraint

Method Detail

parse

getName

isAfterCreate

isAfterDelete

isAfterUpdate

isBeforeCreate

isBeforeDelete

isBeforeUpdate

isOnDemand

isOnConstraint

getLabel