com.canto.cumulus.server.esp.modules.trigger.fieldvaluechanged

Class FieldValueChangedConditionRuntimeData

java.lang.Object

com.canto.cumulus.utils.RecordPackWrapper

com.canto.cumulus.server.esp.modules.trigger.fieldvaluechanged.FieldValueChangedConditionRuntimeData

public class FieldValueChangedConditionRuntimeData
extends RecordPackWrapper

This class provides access to the conditions runtime data for field value changed conditions fired.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FieldValueChangedConditionRuntimeData.LanguageWrapper Helper class to access field names for different languages.

Constructor Summary

Constructors

Constructor and Description
FieldValueChangedConditionRuntimeData(JPack pIRuntimeData) Creates the runtime data for the given runtime data pack.

Method Summary

Methods

Modifier and Type	Method and Description
int	getCatalogID() Returns the catalog ID where the condition fired for.
java.lang.String	getCatalogName() Returns the catalog name where the condition fired for.
int	getCategoryID() Returns the category ID if fired for a record.
java.lang.String	getCategoryName() Returns the category name if fired for a record.
FieldValueChangedConditionRuntimeData.LanguageWrapper	getFieldNames() Returns the multi-language field names.
int	getFieldType() Returns the field type for the field that changed.
java.util.Set<java.lang.Integer>	getModifiedFieldShortIDs() Returns the field short IDs of the fields with changed content.
java.util.Set<GUID>	getModifiedFieldUIDs() Returns the field UIDs of the fields with changed content.
JPack	getNewRecordData() Returns the record data after the change.
JPack	getOldRecordData() Returns the record data before the change.
FieldValueChangedConditionRuntimeData	getOriginalTriggerConditionFieldValueChangedConditionRuntimeData() Returns the original condition runtime data if this trigger fired for an item changed in a sub table.
RecordCategoryAddedConditionRuntimeData	getOriginalTriggerConditionRecordCategoryAddedConditionRuntimeData() Returns the original condition runtime data if this trigger fired for an item created in a sub table.
RecordCategoryDeletedConditionRuntimeData	getOriginalTriggerConditionRecordCategoryDeletedConditionRuntimeData() Returns the original condition runtime data if this trigger fired for an item deleted in a sub table.
int	getOriginalTriggerConditionType() Returns the original condition type if this trigger fired for a sub table item trigger condition.
int	getRecordID() Returns the record ID if fired for a record.
java.lang.String	getRecordName() Returns the record name if fired for a record.
java.lang.String	getTableName() Returns the table name where the condition fired for.
boolean	isCategoryRelated() Returns whether this condition has fired for a record or a category.
boolean	isRecordRelated() Returns whether this condition has fired for a record or a category.

Methods inherited from class com.canto.cumulus.utils.RecordPackWrapper

toXMLString

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldValueChangedConditionRuntimeData

public FieldValueChangedConditionRuntimeData(JPack pIRuntimeData)

Creates the runtime data for the given runtime data pack.

Parameters:

pIRuntimeData - runtime data

Method Detail

getCatalogName

public java.lang.String getCatalogName()

Returns the catalog name where the condition fired for.

Returns:

catalog name

getCatalogID

public int getCatalogID()

Returns the catalog ID where the condition fired for.

Returns:

catalog id

Since:

8.5

getTableName

public java.lang.String getTableName()

Returns the table name where the condition fired for.

Returns:

table name

Since:

10.0.1

getOldRecordData

public JPack getOldRecordData()

Returns the record data before the change.

Returns:

old record data

getNewRecordData

public JPack getNewRecordData()

Returns the record data after the change.

Returns:

new record data

isRecordRelated

public boolean isRecordRelated()

Returns whether this condition has fired for a record or a category.

Returns:

true if this condition fired for a record, false if fired for a category

isCategoryRelated

public boolean isCategoryRelated()

Returns whether this condition has fired for a record or a category.

Returns:

true if fired for a category, false if this condition fired for a record

getRecordID

public int getRecordID()

Returns the record ID if fired for a record.

Returns:

record ID or -1 if not available

getRecordName

public java.lang.String getRecordName()

Returns the record name if fired for a record.

Returns:

record name or null if not available

getCategoryID

public int getCategoryID()

Returns the category ID if fired for a record.

Returns:

category ID or -1 if not available

getCategoryName

public java.lang.String getCategoryName()

Returns the category name if fired for a record.

Returns:

category name or null if not available

getFieldType

public int getFieldType()

Returns the field type for the field that changed.

Returns:

field type

getModifiedFieldUIDs

public java.util.Set<GUID> getModifiedFieldUIDs()

Returns the field UIDs of the fields with changed content.

Returns:

field UIDs of the fields with changed content

Since:

8.6.1

getModifiedFieldShortIDs

public java.util.Set<java.lang.Integer> getModifiedFieldShortIDs()

Returns the field short IDs of the fields with changed content.

Returns:

field short IDs of the fields with changed content

Since:

8.6.1

getOriginalTriggerConditionType

public int getOriginalTriggerConditionType()

Returns the original condition type if this trigger fired for a sub table item trigger condition.

Returns:

original condition type if this trigger fired for a sub table item trigger condition or 0

Since:

9.0

getOriginalTriggerConditionRecordCategoryAddedConditionRuntimeData

public RecordCategoryAddedConditionRuntimeData getOriginalTriggerConditionRecordCategoryAddedConditionRuntimeData()

Returns the original condition runtime data if this trigger fired for an item created in a sub table.

Returns:

original condition runtime data if this trigger fired for an item created in a sub table

Since:

9.0

getOriginalTriggerConditionRecordCategoryDeletedConditionRuntimeData

public RecordCategoryDeletedConditionRuntimeData getOriginalTriggerConditionRecordCategoryDeletedConditionRuntimeData()

Returns the original condition runtime data if this trigger fired for an item deleted in a sub table.

Returns:

original condition runtime data if this trigger fired for an item deleted in a sub table

Since:

9.0

getOriginalTriggerConditionFieldValueChangedConditionRuntimeData

public FieldValueChangedConditionRuntimeData getOriginalTriggerConditionFieldValueChangedConditionRuntimeData()

Returns the original condition runtime data if this trigger fired for an item changed in a sub table.

Returns:

original condition runtime data if this trigger fired for an item changed in a sub table

Since:

9.0

getFieldNames

public FieldValueChangedConditionRuntimeData.LanguageWrapper getFieldNames()

Returns the multi-language field names.

Returns:

field names