com.ibm.openpages.api.trigger.oob

Class SetEnumFieldHandler

java.lang.Object

com.ibm.openpages.api.trigger.AbstractEventHandler

com.ibm.openpages.api.trigger.ext.DefaultEventHandler

com.ibm.openpages.api.trigger.oob.SetEnumFieldHandler

public class SetEnumFieldHandler
extends DefaultEventHandler

This GRC trigger event handler sets the value of an enumerate field to a specific value defined in the attributes.

Usage: This event handler can be used for following events:
create.object
create.object.with.relations
update.object
This event handler must be executed only in the PRE position.

Attributes:

Attribute	Values	Description	Required	Default
enum.field		The field name of an enumerate field. E.g. <attribute name="enum.field" value="OPSS-Iss:Issue Type"/>.	Yes
set.value		The system name for the enumerate value. E.g. <attribute name="set.value" value="Scoping"/>.	Yes

The format of a field name should be [FieldGroup]:[FieldName], for example: 'OPSS-Iss:Issue Type'.

Constructor Summary

Constructors

Constructor and Description
SetEnumFieldHandler()

Method Summary

Modifier and Type	Method and Description
boolean	handleEvent(CreateResourceEvent event) Handles create resource event.
boolean	handleEvent(CreateResourceWithRelationsEvent event) Handles create resource with relations event.
boolean	handleEvent(UpdateResourceEvent event) Handles update resource event.

Methods inherited from class com.ibm.openpages.api.trigger.ext.DefaultEventHandler

handleEvent, handleEvent, handleEvent, handleEvent, handleEvent, handleEvent, handleEvent, handleEvent, handleEvent, handleEvent

Methods inherited from class com.ibm.openpages.api.trigger.AbstractEventHandler

getAttributes, getRuleAttributes, setAttributes, setRuleAttributes, throwException

Methods inherited from class java.lang.Object

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

Constructor Detail

SetEnumFieldHandler

public SetEnumFieldHandler()

Method Detail

handleEvent

public boolean handleEvent(CreateResourceEvent event)

Handles create resource event.

Overrides:

handleEvent in class DefaultEventHandler

Parameters:

event - a create resource event to be handled

Returns:

true.

handleEvent

public boolean handleEvent(CreateResourceWithRelationsEvent event)

Handles create resource with relations event.

Overrides:

handleEvent in class DefaultEventHandler

Parameters:

event - a create resource with relations event to be handled

Returns:

true.

handleEvent

public boolean handleEvent(UpdateResourceEvent event)

Handles update resource event.

Overrides:

handleEvent in class DefaultEventHandler

Parameters:

event - an update resource event to be handled

Returns:

true.