AuditHistoryRow (Appian API)

java.lang.Object
- com.appiancorp.suiteapi.process.history.AuditHistoryRow

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AuditHistoryRow>
```
public abstract class AuditHistoryRow
extends java.lang.Object
implements java.lang.Comparable<AuditHistoryRow>, java.io.Serializable
```
AuditHistoryRow AuditHistoryRow represents one row of audit log process history. There are no setters on this bean.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.Object`	`completeOrPartialValue`
`protected java.lang.String`	`dom`
`static java.lang.String`	`DOMAIN_PROCESS_PROPERTY`
`static java.lang.String`	`DOMAIN_PROCESS_VARIABLE`
`static java.lang.String`	`DOMAIN_TASK_PROPERTY`
`protected java.lang.String`	`key`
`protected LocaleString`	`name`
`protected java.lang.Integer`	`order`
`protected java.lang.Long`	`processId`
`protected java.lang.Long`	`processModelId`
`protected java.lang.String`	`processModelUuid`
`protected java.lang.Long`	`taskId`
`protected java.sql.Timestamp`	`timestamp`
`protected java.lang.String`	`username`
`protected java.lang.String`	`userUuid`

Constructor Summary

Constructors
Constructor and Description

AuditHistoryRow()

Constructors
Constructor and Description
`AuditHistoryRow()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected int`	`compareTimestamp(AuditHistoryRow compareAgainst)` Comparison is based on timestamp, which is the secondary sort.
`int`	`compareTo(AuditHistoryRow compareAgainst)` Comparison is based on order, with secondary sort of timestamp.
`protected java.lang.Object`	`determineCompleteOrPartialValue()`
`abstract void`	`gatherUserUuids(java.util.Set<java.lang.String> setOfUuids)` Gather the user UUIDs in this AuditHistoryRow, from both the user performing the action and the values, adding them to the provided Set.
`java.util.Optional<CompleteValue>`	`getCompleteValue()` The value for a row may be either 'complete' or 'partial'.
`java.lang.String`	`getDom()` dom!
`java.lang.String`	`getDomKey()`
`protected java.lang.String`	`getDomKeyCaseSensitive()`
`java.lang.String`	`getKey()` dom!
`LocaleString`	`getName()`
`java.lang.String`	`getName(java.util.Locale locale)`
`java.util.Set<java.util.Locale>`	`getNameLocales()`
`java.util.Optional<java.lang.String>`	`getOptionalProcessModelUuid()`
`java.util.Optional<java.lang.Long>`	`getOptionalTaskId()`
`java.lang.Integer`	`getOrder()`
`java.util.Optional<PartialValue>`	`getPartialValue()` The value for a row may be either 'complete' or 'partial'.
`java.lang.Long`	`getProcessId()`
`java.lang.Long`	`getProcessModelId()`
`java.sql.Timestamp`	`getTimestamp()`
`java.lang.String`	`getUser()`
`java.lang.String`	`getUsername()`
`abstract void`	`setUsername(java.lang.String username)`

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

- Field Detail
  - DOMAIN_PROCESS_VARIABLE
```
public static final java.lang.String DOMAIN_PROCESS_VARIABLE
```
    See Also:
    
    Constant Field Values
  - DOMAIN_PROCESS_PROPERTY
```
public static final java.lang.String DOMAIN_PROCESS_PROPERTY
```
    See Also:
    
    Constant Field Values
  - DOMAIN_TASK_PROPERTY
```
public static final java.lang.String DOMAIN_TASK_PROPERTY
```
    See Also:
    
    Constant Field Values
  - userUuid
```
protected java.lang.String userUuid
```
  - username
```
protected java.lang.String username
```
  - timestamp
```
protected java.sql.Timestamp timestamp
```
  - order
```
protected java.lang.Integer order
```
  - dom
```
protected java.lang.String dom
```
  - key
```
protected java.lang.String key
```
  - name
```
protected LocaleString name
```
  - processModelUuid
```
protected java.lang.String processModelUuid
```
  - processModelId
```
protected java.lang.Long processModelId
```
  - processId
```
protected java.lang.Long processId
```
  - taskId
```
protected java.lang.Long taskId
```
  - completeOrPartialValue
```
protected java.lang.Object completeOrPartialValue
```
- Constructor Detail
  - AuditHistoryRow
```
public AuditHistoryRow()
```
- Method Detail
  - getUser
```
public java.lang.String getUser()
```
    Returns:
    
    user UUID that performed this row's action; an empty "" indicates it was performed by the system.
  - getUsername
```
public java.lang.String getUsername()
```
    Returns:
    
    username that performed this row's action
  - setUsername
```
public abstract void setUsername(java.lang.String username)
```
    Parameters:
    
    username - for updating by UserUuidMapper
  - getTimestamp
```
public java.sql.Timestamp getTimestamp()
```
    Returns:
    
    timestamp at which this row's action was recorded
  - getOrder
```
public java.lang.Integer getOrder()
```
    Returns:
    
    order of this row within its process, allows disambiguation at same timestamp
  - getDom
```
public java.lang.String getDom()
```
    dom!key is the row identifier within the process context.
    
    Returns:
    
    domain of the identifier modified in this row (e.g., DOMAIN_*); domains are case insensitive, may be returned in any mix of upper- and lower-case, i.e., use equalsIgnoreCase() when comparing.
  - getKey
```
public java.lang.String getKey()
```
    dom!key is the row identifier within the process context.
    
    Returns:
    
    key of the identifier modified in this row, unique within combination of domain and process context; keys are case insensitive, may be returned in any mix of upper- and lower-case, i.e., use equalsIgnoreCase() when comparing.
  - getDomKeyCaseSensitive
```
protected java.lang.String getDomKeyCaseSensitive()
```
    Returns:
    
    dom!key, or key if dom is null or "" (the default domain), using dom!key as given by dom and key
  - getDomKey
```
public java.lang.String getDomKey()
```
    Returns:
    
    dom!key in lowercase, or key if dom is null or "" (the default domain); this is an appropriate key within process id context for a Set to build a PartialValue to CompleteValue.
  - getName
```
public LocaleString getName()
```
    Returns:
    
    name of this row's object, as a LocaleString; can use it to determine the Locales available, and get just that locale. Can use getName(Locale) directly if only one Locale is required.
  - getName
```
public java.lang.String getName(java.util.Locale locale)
```
    Parameters:
    
    locale -
    
    Returns:
    
    name of this row's object, in the given Locale or the first available
  - getNameLocales
```
public java.util.Set<java.util.Locale> getNameLocales()
```
    Returns:
    
    Locales in which this row's name is defined (may be empty for names insensitive to Locale)
  - getProcessId
```
public java.lang.Long getProcessId()
```
    Returns:
    
    row's process id
  - getProcessModelId
```
public java.lang.Long getProcessModelId()
```
    Returns:
    
    row's process model id
  - getOptionalProcessModelUuid
```
public java.util.Optional<java.lang.String> getOptionalProcessModelUuid()
```
    Returns:
    
    row's process model UUID, if set
  - getOptionalTaskId
```
public java.util.Optional<java.lang.Long> getOptionalTaskId()
```
    Returns:
    
    row's task id, if available (not available in process level row actions, but typically set for "tp" domain rows)
  - determineCompleteOrPartialValue
```
protected java.lang.Object determineCompleteOrPartialValue()
```
  - getCompleteValue
```
public java.util.Optional<CompleteValue> getCompleteValue()
```
    The value for a row may be either 'complete' or 'partial'. The first row of a given domain!key for a given process context will be complete. After that, rows may be either complete or partial. If partial, then the partial must be applied to the previous complete in order to yield another complete value. To do so, track the existing CompleteValue for that domain!key in the process context. This tracking is not necessary if not wanting to obtain the completed values.
    
    Returns:
    
    CompleteValue if available
  - getPartialValue
```
public java.util.Optional<PartialValue> getPartialValue()
```
    The value for a row may be either 'complete' or 'partial'. The first row of a given domain!key for a given process context will be complete. After that, rows may be either complete or partial. If partial, then the partial must be applied to the previous complete in order to yield another complete value. To do so, track the existing CompleteValue for that domain!key in the process context. This tracking is not necessary if not wanting to obtain the completed values.
    
    Returns:
    
    PartialValue, if possible, which may be applied to a previous CompleteValue for the same dom!key in the same process id context
  - compareTo
```
public int compareTo(AuditHistoryRow compareAgainst)
```
    Comparison is based on order, with secondary sort of timestamp. Notably, the only time that order is identical is in the case of divergent processes, where we reset a kdb back to an earlier version, causing the history to be inconsistent without the resiliency provided in ProcessHistoryKafkaReader.
    
    Specified by:
    
    compareTo in interface java.lang.Comparable<AuditHistoryRow>
    
    Parameters:
    
    compareAgainst -
    
    Returns:
    
    0 if equal, less than 0 if this is before compareAgainst, greater than 0 if this is after compareAgainst
  - compareTimestamp
```
protected int compareTimestamp(AuditHistoryRow compareAgainst)
```
    Comparison is based on timestamp, which is the secondary sort.
    
    Parameters:
    
    compareAgainst -
    
    Returns:
    
    0 if equal, less than 0 if this is before compareAgainst, greater than 0 if this is after compareAgainst
  - gatherUserUuids
```
public abstract void gatherUserUuids(java.util.Set<java.lang.String> setOfUuids)
```
    Gather the user UUIDs in this AuditHistoryRow, from both the user performing the action and the values, adding them to the provided Set.
    
    Parameters:
    
    setOfUuids -

Class AuditHistoryRow

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DOMAIN_PROCESS_VARIABLE

DOMAIN_PROCESS_PROPERTY

DOMAIN_TASK_PROPERTY

userUuid

username

timestamp

order

dom

key

name

processModelUuid

processModelId

processId

taskId

completeOrPartialValue

Constructor Detail

AuditHistoryRow

Method Detail

getUser

getUsername

setUsername

getTimestamp

getOrder

getDom

getKey

getDomKeyCaseSensitive

getDomKey

getName

getName

getNameLocales

getProcessId

getProcessModelId

getOptionalProcessModelUuid

getOptionalTaskId

determineCompleteOrPartialValue

getCompleteValue

getPartialValue

compareTo

compareTimestamp

gatherUserUuids