Package com.codebarrel.automation.api.audit.builder

Class AuditComponentChangeBuilder

java.lang.Object

com.codebarrel.automation.api.audit.builder.AuditComponentChangeBuilder

public class AuditComponentChangeBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
AuditComponentChangeBuilder	addAssociatedItem(AssociatedItem item)
AuditComponentChangeBuilder	addError(String errorKey, String param)
void	addItemToNotify(NotificationEntityType type, String id)
AuditComponentChangeBuilder	addMessage(String messageKey, String param)
AuditComponentChangeBuilder	addSuccess(String successKey, String param)
void	excludeFromAuditlog()	Components can use this during execution to elect to be excluded from the audit log completely.
void	finish()
AuditItemBuilder	getAuditItemBuilder()
TenantExecution	getExecution()
Optional<Long>	getItemId()	Deprecated.
boolean	isAggressiveRequestTimeoutThresholdReached()
void	setChildComponent(ComponentIdentity childIdentity)	Some components (for example if blocks) can execute child components inline.
AuditComponentChangeBuilder	setNameKey(String nameKey)
AuditComponentChangeBuilder	setState(State state)
AuditComponentChangeBuilder	stopClock()

Methods inherited from class java.lang.Object

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

Method Details

addAssociatedItem

public AuditComponentChangeBuilder addAssociatedItem(AssociatedItem item)

addError

public AuditComponentChangeBuilder addError(String errorKey,
 String param)

addSuccess

public AuditComponentChangeBuilder addSuccess(String successKey,
 String param)

addMessage

public AuditComponentChangeBuilder addMessage(String messageKey,
 String param)

setNameKey

public AuditComponentChangeBuilder setNameKey(String nameKey)

stopClock

public AuditComponentChangeBuilder stopClock()

addItemToNotify

public void addItemToNotify(NotificationEntityType type,
 String id)

setState

public AuditComponentChangeBuilder setState(State state)

getItemId

@Deprecated
public Optional<Long> getItemId()

Deprecated.

getExecution

public TenantExecution getExecution()

isAggressiveRequestTimeoutThresholdReached

public boolean isAggressiveRequestTimeoutThresholdReached()

setChildComponent

public void setChildComponent(ComponentIdentity childIdentity)

Some components (for example if blocks) can execute child components inline. They may want to add extra context to the auditlog about which child component is being executed.

Parameters:

childIdentity - the identity of the child component

excludeFromAuditlog

public void excludeFromAuditlog()

Components can use this during execution to elect to be excluded from the audit log completely.

finish

public void finish()

getAuditItemBuilder

public AuditItemBuilder getAuditItemBuilder()