HistoryRecord (Appian API)

java.lang.Object
- com.appiancorp.suiteapi.process.HistoryRecord

All Implemented Interfaces:

java.io.Serializable
```
public class HistoryRecord
extends java.lang.Object
implements java.io.Serializable
```
An individual history record, representing an element of an audit trail in a process.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HistoryRecord.ProcessModelInfo
Information about a process model, including id, version, name and uuid.

Nested Classes
Modifier and Type	Class and Description
`static class`	`HistoryRecord.ProcessModelInfo` Information about a process model, including id, version, name and uuid.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`OBJECT_TYPE_PROCESS`
`static int`	`OBJECT_TYPE_TASK`
`static int`	`OBJECT_TYPE_VARIABLE`
`static java.lang.Integer`	`SORT_BY_DATA_IDS`
`static java.lang.Integer`	`SORT_BY_DIRECTION`
`static java.lang.Integer`	`SORT_BY_GROUPS`
`static java.lang.Integer`	`SORT_BY_NEW_NAME`
`static java.lang.Integer`	`SORT_BY_NEW_PRIORITY`
`static java.lang.Integer`	`SORT_BY_NEW_TIMESTAMP`
`static java.lang.Integer`	`SORT_BY_NEW_VALUE`
`static java.lang.Integer`	`SORT_BY_OBJECT_ID`
`static java.lang.Integer`	`SORT_BY_OBJECT_NAME`
`static java.lang.Integer`	`SORT_BY_OBJECT_TYPE`
`static java.lang.Integer`	`SORT_BY_SAVED_AS_VERSION`
`static java.lang.Integer`	`SORT_BY_SOURCE_MODEL_INFO`
`static java.lang.Integer`	`SORT_BY_TARGET_MODEL_INFO`
`static java.lang.Integer`	`SORT_BY_TIMESTAMP`
`static java.lang.Integer`	`SORT_BY_TYPE`
`static java.lang.Integer`	`SORT_BY_USER`
`static java.lang.Integer`	`SORT_BY_USERS`
`static int`	`TYPE_ADD_ATTACHMENT`
`static int`	`TYPE_ADD_NOTE`
`static int`	`TYPE_ADD_VARIABLE`
`static int`	`TYPE_ASSIGNED`
`static int`	`TYPE_CANCEL`
`static int`	`TYPE_CHANGE_PRIORITY`
`static int`	`TYPE_COMPLETE`
`static int`	`TYPE_EDIT_PROCESS` Represents an edit of a process from Edit Mode.
`static int`	`TYPE_ESCALATED`
`static int`	`TYPE_ESCALATION_NOTIFICATION`
`static int`	`TYPE_EVENT_ABORT`
`static int`	`TYPE_EVENT_ACTIVATE`
`static int`	`TYPE_EVENT_CANCEL`
`static int`	`TYPE_EVENT_FIRE`
`static int`	`TYPE_MODIFY_EXTERNAL_VARIABLE`
`static int`	`TYPE_MODIFY_NAME`
`static int`	`TYPE_MODIFY_VARIABLE`
`static int`	`TYPE_PAUSE`
`static int`	`TYPE_REASSIGNED`
`static int`	`TYPE_REMOVE_ATTACHMENT`
`static int`	`TYPE_REMOVE_NOTE`
`static int`	`TYPE_RESUME`
`static int`	`TYPE_SCHEDULE`
`static int`	`TYPE_START`
`static int`	`TYPE_UPGRADE_PROCESS` Represents an upgrade of a process to a new process model.

Constructor Summary

Constructors
Constructor and Description

HistoryRecord()

Constructors
Constructor and Description
`HistoryRecord()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)`
`static java.util.Comparator`	`getComparator(int sortKey)` Comparator for HistoryRecord
`java.lang.Object`	`getData()` Get the associated data for the history record; note, those history records that return multiple objects will return them as an Object[].
`java.lang.Long[]`	`getDataIds()` Set only by history types ADD_ATTACHMENT, REMOVE_ATTACHMENT, ADD_NOTE, REMOVE_NOTE
`java.lang.Long`	`getDirection()` Set only by history type CHANGE_PRIORITY
`int`	`getEngineId()` This is 0 for EXEC00, 1 for EXEC01, etc.
`java.lang.Long[]`	`getGroups()` Set only by history types ESCALATION_NOTIFICATION, REASSIGNED, ASSIGNED
`java.lang.String`	`getNewName()`
`java.lang.Long`	`getNewPriority()` Set only by history type CHANGE_PRIORITY
`java.sql.Timestamp`	`getNewTimestamp()` Set only by history type SCHEDULE
`TypedValue`	`getNewValue()` Set only by history type MODIFY_VARIABLE.
`java.lang.Long`	`getObjectId()` Id of the object in the history record.
`java.lang.String`	`getObjectName()` Name of the object in the history record.
`int`	`getObjectType()` Type of the object in the history record.
`java.lang.String`	`getSavedAsVersion()` Gets the resulting process model version that the edited process was saved as.
`HistoryRecord.ProcessModelInfo`	`getSourceModel()` Gets a ProcessModelInfo object representing the source process model that was in use before the process upgrade.
`HistoryRecord.ProcessModelInfo`	`getTargetModel()` Gets a ProcessModelInfo object representing the target process model to which the process was upgraded.
`java.sql.Timestamp`	`getTimestamp()` Timestamp at which this modification occurred.
`int`	`getType()` Type of this history record (e.g., START is 6, MODIFY_VARIABLE is 17, etc.)
`java.lang.String`	`getUser()` The user responsible for the history record.
`java.lang.String[]`	`getUsers()` Set only by history types ESCALATION_NOTIFICATION, REASSIGNED, ASSIGNED
`int`	`getWriteCounter()` This advances by one every time a write to external (set, modify, or delete) occurs within an engine.
`int`	`getWriteEpoch()` Whenever the writeCounter advances beyond Integer.MAX_VALUE, it resets to 0, and the writeEpoch increases by one.
`long`	`getWriteIndex()` The writeIndex encapsulates both writeCounter and writeEpoch into a single value.
`int`	`hashCode()`
`void`	`setDataIds(java.lang.Long[] dataIds_)`
`void`	`setDirection(java.lang.Long direction_)`
`void`	`setEngineId(int engineId_)` This is 0 for EXEC00, 1 for EXEC01, etc.
`void`	`setGroups(java.lang.Long[] groups_)`
`void`	`setIndex(int[] indices)`
`void`	`setIndex(java.lang.Integer[] indices)`
`void`	`setNewName(java.lang.String newName_)` Set only by history types ADD_VARIABLE, MODIFY_NAME
`void`	`setNewPriority(java.lang.Long newPriority_)`
`void`	`setNewTimestamp(java.sql.Timestamp newTimestamp_)`
`void`	`setNewValue(TypedValue newValue_)`
`void`	`setObjectId(java.lang.Long objectId_)`
`void`	`setObjectName(java.lang.String objectName_)`
`void`	`setObjectType(int objectType_)`
`void`	`setSavedAsVersion(java.lang.String savedAsVersion)` Sets the process model version that the edited process was saved as.
`void`	`setSourceModel(HistoryRecord.ProcessModelInfo sourceModel)` Sets the ProcessModelInfo object representing the source process model that was in use before the process upgrade.
`void`	`setTargetModel(HistoryRecord.ProcessModelInfo targetModel)` Sets the ProcessModelInfo object representing the target process model to which the process was upgraded.
`void`	`setTimestamp(java.sql.Timestamp timestamp_)`
`void`	`setType(int historyType_)`
`void`	`setUser(java.lang.String user_)`
`void`	`setUsers(java.lang.String[] users_)`
`void`	`setWriteCounter(int writeCounter_)`
`void`	`setWriteEpoch(int writeEpoch_)`
`void`	`setWriteIndex(long value)` The writeIndex encapsulates both writeCounter and writeEpoch into a single value.
`java.lang.String`	`toString()` Only intended to help debugging.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - TYPE_CHANGE_PRIORITY
```
public static final int TYPE_CHANGE_PRIORITY
```
    See Also:
    
    Constant Field Values
  - TYPE_SCHEDULE
```
public static final int TYPE_SCHEDULE
```
    See Also:
    
    Constant Field Values
  - TYPE_ASSIGNED
```
public static final int TYPE_ASSIGNED
```
    See Also:
    
    Constant Field Values
  - TYPE_REASSIGNED
```
public static final int TYPE_REASSIGNED
```
    See Also:
    
    Constant Field Values
  - TYPE_ESCALATED
```
public static final int TYPE_ESCALATED
```
    See Also:
    
    Constant Field Values
  - TYPE_ESCALATION_NOTIFICATION
```
public static final int TYPE_ESCALATION_NOTIFICATION
```
    See Also:
    
    Constant Field Values
  - TYPE_START
```
public static final int TYPE_START
```
    See Also:
    
    Constant Field Values
  - TYPE_CANCEL
```
public static final int TYPE_CANCEL
```
    See Also:
    
    Constant Field Values
  - TYPE_PAUSE
```
public static final int TYPE_PAUSE
```
    See Also:
    
    Constant Field Values
  - TYPE_RESUME
```
public static final int TYPE_RESUME
```
    See Also:
    
    Constant Field Values
  - TYPE_COMPLETE
```
public static final int TYPE_COMPLETE
```
    See Also:
    
    Constant Field Values
  - TYPE_ADD_ATTACHMENT
```
public static final int TYPE_ADD_ATTACHMENT
```
    See Also:
    
    Constant Field Values
  - TYPE_REMOVE_ATTACHMENT
```
public static final int TYPE_REMOVE_ATTACHMENT
```
    See Also:
    
    Constant Field Values
  - TYPE_ADD_NOTE
```
public static final int TYPE_ADD_NOTE
```
    See Also:
    
    Constant Field Values
  - TYPE_REMOVE_NOTE
```
public static final int TYPE_REMOVE_NOTE
```
    See Also:
    
    Constant Field Values
  - TYPE_MODIFY_NAME
```
public static final int TYPE_MODIFY_NAME
```
    See Also:
    
    Constant Field Values
  - TYPE_MODIFY_VARIABLE
```
public static final int TYPE_MODIFY_VARIABLE
```
    See Also:
    
    Constant Field Values
  - TYPE_ADD_VARIABLE
```
public static final int TYPE_ADD_VARIABLE
```
    See Also:
    
    Constant Field Values
  - TYPE_EVENT_ACTIVATE
```
public static final int TYPE_EVENT_ACTIVATE
```
    See Also:
    
    Constant Field Values
  - TYPE_EVENT_FIRE
```
public static final int TYPE_EVENT_FIRE
```
    See Also:
    
    Constant Field Values
  - TYPE_EVENT_CANCEL
```
public static final int TYPE_EVENT_CANCEL
```
    See Also:
    
    Constant Field Values
  - TYPE_EVENT_ABORT
```
public static final int TYPE_EVENT_ABORT
```
    See Also:
    
    Constant Field Values
  - TYPE_MODIFY_EXTERNAL_VARIABLE
```
public static final int TYPE_MODIFY_EXTERNAL_VARIABLE
```
    See Also:
    
    Constant Field Values
  - TYPE_EDIT_PROCESS
```
public static final int TYPE_EDIT_PROCESS
```
    Represents an edit of a process from Edit Mode.
    
    See Also:
    
    Constant Field Values
  - TYPE_UPGRADE_PROCESS
```
public static final int TYPE_UPGRADE_PROCESS
```
    Represents an upgrade of a process to a new process model.
    
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_PROCESS
```
public static final int OBJECT_TYPE_PROCESS
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_TASK
```
public static final int OBJECT_TYPE_TASK
```
    See Also:
    
    Constant Field Values
  - OBJECT_TYPE_VARIABLE
```
public static final int OBJECT_TYPE_VARIABLE
```
    See Also:
    
    Constant Field Values
  - SORT_BY_USER
```
public static final java.lang.Integer SORT_BY_USER
```
  - SORT_BY_TIMESTAMP
```
public static final java.lang.Integer SORT_BY_TIMESTAMP
```
  - SORT_BY_TYPE
```
public static final java.lang.Integer SORT_BY_TYPE
```
  - SORT_BY_OBJECT_TYPE
```
public static final java.lang.Integer SORT_BY_OBJECT_TYPE
```
  - SORT_BY_OBJECT_ID
```
public static final java.lang.Integer SORT_BY_OBJECT_ID
```
  - SORT_BY_OBJECT_NAME
```
public static final java.lang.Integer SORT_BY_OBJECT_NAME
```
  - SORT_BY_NEW_VALUE
```
public static final java.lang.Integer SORT_BY_NEW_VALUE
```
  - SORT_BY_NEW_NAME
```
public static final java.lang.Integer SORT_BY_NEW_NAME
```
  - SORT_BY_DATA_IDS
```
public static final java.lang.Integer SORT_BY_DATA_IDS
```
  - SORT_BY_USERS
```
public static final java.lang.Integer SORT_BY_USERS
```
  - SORT_BY_GROUPS
```
public static final java.lang.Integer SORT_BY_GROUPS
```
  - SORT_BY_NEW_TIMESTAMP
```
public static final java.lang.Integer SORT_BY_NEW_TIMESTAMP
```
  - SORT_BY_DIRECTION
```
public static final java.lang.Integer SORT_BY_DIRECTION
```
  - SORT_BY_NEW_PRIORITY
```
public static final java.lang.Integer SORT_BY_NEW_PRIORITY
```
  - SORT_BY_SAVED_AS_VERSION
```
public static final java.lang.Integer SORT_BY_SAVED_AS_VERSION
```
  - SORT_BY_SOURCE_MODEL_INFO
```
public static final java.lang.Integer SORT_BY_SOURCE_MODEL_INFO
```
  - SORT_BY_TARGET_MODEL_INFO
```
public static final java.lang.Integer SORT_BY_TARGET_MODEL_INFO
```
- Constructor Detail
  - HistoryRecord
```
public HistoryRecord()
```
- Method Detail
  - getData
```
public java.lang.Object getData()
```
    Get the associated data for the history record; note, those history records that return multiple objects will return them as an Object[]. Null will be returned for those history types without associated data.
    
    Returns:
  - getType
```
public int getType()
```
    Type of this history record (e.g., START is 6, MODIFY_VARIABLE is 17, etc.) See HistoryRecordConstants.
    
    Returns:
  - setType
```
public void setType(int historyType_)
```
  - getTimestamp
```
public java.sql.Timestamp getTimestamp()
```
    Timestamp at which this modification occurred.
    
    Returns:
  - setTimestamp
```
public void setTimestamp(java.sql.Timestamp timestamp_)
```
  - getObjectId
```
public java.lang.Long getObjectId()
```
    Id of the object in the history record.
    
    Returns:
  - setObjectId
```
public void setObjectId(java.lang.Long objectId_)
```
  - getObjectName
```
public java.lang.String getObjectName()
```
    Name of the object in the history record.
    
    Returns:
  - setObjectName
```
public void setObjectName(java.lang.String objectName_)
```
  - getObjectType
```
public int getObjectType()
```
    Type of the object in the history record.
    
    Returns:
  - setObjectType
```
public void setObjectType(int objectType_)
```
  - getUser
```
public java.lang.String getUser()
```
    The user responsible for the history record.
    
    Returns:
  - setUser
```
public void setUser(java.lang.String user_)
```
  - getNewValue
```
public TypedValue getNewValue()
```
    Set only by history type MODIFY_VARIABLE.
    
    Returns:
  - setNewValue
```
public void setNewValue(TypedValue newValue_)
```
  - getDataIds
```
public java.lang.Long[] getDataIds()
```
    Set only by history types ADD_ATTACHMENT, REMOVE_ATTACHMENT, ADD_NOTE, REMOVE_NOTE
    
    Returns:
  - setDataIds
```
public void setDataIds(java.lang.Long[] dataIds_)
```
  - getDirection
```
public java.lang.Long getDirection()
```
    Set only by history type CHANGE_PRIORITY
    
    Returns:
  - setDirection
```
public void setDirection(java.lang.Long direction_)
```
  - getGroups
```
public java.lang.Long[] getGroups()
```
    Set only by history types ESCALATION_NOTIFICATION, REASSIGNED, ASSIGNED
    
    Returns:
  - setGroups
```
public void setGroups(java.lang.Long[] groups_)
```
  - getNewName
```
public java.lang.String getNewName()
```
  - setNewName
```
public void setNewName(java.lang.String newName_)
```
    Set only by history types ADD_VARIABLE, MODIFY_NAME
    
    Parameters:
    
    newName_ -
  - getNewPriority
```
public java.lang.Long getNewPriority()
```
    Set only by history type CHANGE_PRIORITY
    
    Returns:
  - setNewPriority
```
public void setNewPriority(java.lang.Long newPriority_)
```
  - getNewTimestamp
```
public java.sql.Timestamp getNewTimestamp()
```
    Set only by history type SCHEDULE
    
    Returns:
  - setNewTimestamp
```
public void setNewTimestamp(java.sql.Timestamp newTimestamp_)
```
  - getUsers
```
public java.lang.String[] getUsers()
```
    Set only by history types ESCALATION_NOTIFICATION, REASSIGNED, ASSIGNED
    
    Returns:
  - setUsers
```
public void setUsers(java.lang.String[] users_)
```
  - getSavedAsVersion
```
public java.lang.String getSavedAsVersion()
```
    Gets the resulting process model version that the edited process was saved as. Set only by EDIT_PROCESS, if the edited process was saved as a new version.
    
    Returns:
    
    the version that the edited process was saved as
  - setSavedAsVersion
```
public void setSavedAsVersion(java.lang.String savedAsVersion)
```
    Sets the process model version that the edited process was saved as. Only relevant for the EDIT_PROCESS history type.
    
    Parameters:
    
    savedAsVersion - the process model version that the edited process was saved as
  - getSourceModel
```
public HistoryRecord.ProcessModelInfo getSourceModel()
```
    Gets a ProcessModelInfo object representing the source process model that was in use before the process upgrade. Only set by the UPGRADE_PROCESS history type.
    
    Returns:
    
    a ProcessModelInfo object representing the source process model
  - setSourceModel
```
public void setSourceModel(HistoryRecord.ProcessModelInfo sourceModel)
```
    Sets the ProcessModelInfo object representing the source process model that was in use before the process upgrade. Only relevant for the UPGRADE_PROCESS history type.
    
    Parameters:
    
    sourceModel - a ProcessModelInfo object representing the source process model
  - getTargetModel
```
public HistoryRecord.ProcessModelInfo getTargetModel()
```
    Gets a ProcessModelInfo object representing the target process model to which the process was upgraded. Only set by the UPGRADE_PROCESS history type.
    
    Returns:
    
    a ProcessModelInfo object representing the target process model
  - setTargetModel
```
public void setTargetModel(HistoryRecord.ProcessModelInfo targetModel)
```
    Sets the ProcessModelInfo object representing the target process model to which the process was upgraded. Only relevant for the UPGRADE_PROCESS history type.
    
    Parameters:
    
    targetModel - a ProcessModelInfo object representing the target process model
  - getWriteIndex
```
public long getWriteIndex()
```
    The writeIndex encapsulates both writeCounter and writeEpoch into a single value. Aside from rolling back to previous revisions, the writeIndex always increases once per write within a given execution engine. No writeIndexes are shared (at least until the writeEpoch wraps). This should be combined with the engineId to form the basis of external storage process history keys.
    
    Returns:
  - setWriteIndex
```
public void setWriteIndex(long value)
```
    The writeIndex encapsulates both writeCounter and writeEpoch into a single value.
  - getWriteCounter
```
public int getWriteCounter()
```
    This advances by one every time a write to external (set, modify, or delete) occurs within an engine.
    
    Returns:
    
    the writeCounter
  - setWriteCounter
```
public void setWriteCounter(int writeCounter_)
```
    Parameters:
    
    writeCounter_ - the writeCounter to set
  - getWriteEpoch
```
public int getWriteEpoch()
```
    Whenever the writeCounter advances beyond Integer.MAX_VALUE, it resets to 0, and the writeEpoch increases by one.
    
    Returns:
    
    the writeEpoch
  - setWriteEpoch
```
public void setWriteEpoch(int writeEpoch_)
```
    Parameters:
    
    writeEpoch_ - the writeEpoch to set
  - getEngineId
```
public int getEngineId()
```
    This is 0 for EXEC00, 1 for EXEC01, etc.
    
    Returns:
    
    the engineId
  - setEngineId
```
public void setEngineId(int engineId_)
```
    This is 0 for EXEC00, 1 for EXEC01, etc.
    
    Parameters:
    
    engineId_ - the engineId to set
  - setIndex
```
public void setIndex(java.lang.Integer[] indices)
```
  - setIndex
```
public void setIndex(int[] indices)
```
  - toString
```
public java.lang.String toString()
```
    Only intended to help debugging. The format of this String is not guaranteed and may change.
    
    Overrides:
    
    toString in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - getComparator
```
public static java.util.Comparator getComparator(int sortKey)
```
    Comparator for HistoryRecord
    
    Parameters:
    
    sortKey -
    
    Returns:
    
    Comparator based on given sortKey

Class HistoryRecord

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPE_CHANGE_PRIORITY

TYPE_SCHEDULE

TYPE_ASSIGNED

TYPE_REASSIGNED

TYPE_ESCALATED

TYPE_ESCALATION_NOTIFICATION

TYPE_START

TYPE_CANCEL

TYPE_PAUSE

TYPE_RESUME

TYPE_COMPLETE

TYPE_ADD_ATTACHMENT

TYPE_REMOVE_ATTACHMENT

TYPE_ADD_NOTE

TYPE_REMOVE_NOTE

TYPE_MODIFY_NAME

TYPE_MODIFY_VARIABLE

TYPE_ADD_VARIABLE

TYPE_EVENT_ACTIVATE

TYPE_EVENT_FIRE

TYPE_EVENT_CANCEL

TYPE_EVENT_ABORT

TYPE_MODIFY_EXTERNAL_VARIABLE

TYPE_EDIT_PROCESS

TYPE_UPGRADE_PROCESS

OBJECT_TYPE_PROCESS

OBJECT_TYPE_TASK

OBJECT_TYPE_VARIABLE

SORT_BY_USER

SORT_BY_TIMESTAMP

SORT_BY_TYPE

SORT_BY_OBJECT_TYPE

SORT_BY_OBJECT_ID

SORT_BY_OBJECT_NAME

SORT_BY_NEW_VALUE

SORT_BY_NEW_NAME

SORT_BY_DATA_IDS

SORT_BY_USERS

SORT_BY_GROUPS

SORT_BY_NEW_TIMESTAMP

SORT_BY_DIRECTION

SORT_BY_NEW_PRIORITY

SORT_BY_SAVED_AS_VERSION

SORT_BY_SOURCE_MODEL_INFO

SORT_BY_TARGET_MODEL_INFO

Constructor Detail

HistoryRecord

Method Detail

getData

getType

setType

getTimestamp

setTimestamp

getObjectId

setObjectId

getObjectName

setObjectName

getObjectType

setObjectType

getUser

setUser

getNewValue

setNewValue

getDataIds

setDataIds

getDirection

setDirection

getGroups

setGroups

getNewName

setNewName

getNewPriority

setNewPriority