Package com.aquima.interactions.trace.impl

Class DocumentTraceMessage

java.lang.Object

com.aquima.interactions.trace.impl.TraceMessageBase

com.aquima.interactions.trace.impl.DocumentTraceMessage

All Implemented Interfaces:

ITraceMessage, Serializable

public final class DocumentTraceMessage
extends TraceMessageBase

This message is created to trace a creation and update of a file, a move of a file, a delete of a file and an update of a metadata file.

Since:

9.3

Author:

N. van Noorloos, J. Hermus, T. Middeldorp

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROPERTY_DOCUMENT_CASE_ID
static final String	PROPERTY_DOCUMENT_CONNECTION
static final String	PROPERTY_DOCUMENT_FROM_CONNECTION
static final String	PROPERTY_DOCUMENT_FROM_ID
static final String	PROPERTY_DOCUMENT_FROM_NAME
static final String	PROPERTY_DOCUMENT_ID
static final String	PROPERTY_DOCUMENT_NAME
static final String	PROPERTY_DOCUMENT_PROCESS_ID
static final String	PROPERTY_DOCUMENT_TO_CONNECTION
static final String	PROPERTY_DOCUMENT_TO_ID
static final String	PROPERTY_DOCUMENT_TO_NAME
static final String	PROPERTY_USER_ID
static final String	PROPERTY_USER_NAME
static final String	TYPE_DOCUMENT_CREATED
static final String	TYPE_DOCUMENT_DELETED
static final String	TYPE_DOCUMENT_GENERATED
static final String	TYPE_DOCUMENT_METADATA_UPDATED
static final String	TYPE_DOCUMENT_MOVED
static final String	TYPE_DOCUMENT_RECEIVED
static final String	TYPE_DOCUMENT_UPDATED

Method Summary

Modifier and Type	Method	Description
static ITraceMessage	forDocumentCreated(String applicationId, String userId, String userName, String documentId, String documentName, String documentConnection, String caseId, Long processId)	Constructs a trace message to trace a creation of a file.
static ITraceMessage	forDocumentDeleted(String applicationId, String userId, String userName, String documentId, String documentName, String documentConnection, String caseId, Long processId)	Constructs a trace message to trace a delete of a file.
static ITraceMessage	forDocumentGenerated(String applicationId, String userId, String userName, String documentId, String documentName, String documentConnection, String caseId, Long processId)	Constructs a trace message to trace a generation of a file.
static ITraceMessage	forDocumentMetadataUpdated(String applicationId, String userId, String userName, String documentId, String documentName, String documentConnection, String caseId, Long processId)	Constructs a trace message to trace a delete of a file.
static ITraceMessage	forDocumentMoved(String applicationId, String userId, String userName, String documentId, String documentName, String documentConnection, String toDocumentId, String toDocumentConnection, String caseId, Long processId)	Constructs a trace message to trace a move of a file.
static ITraceMessage	forDocumentReceived(String applicationId, String userId, String userName, String documentId, String documentName, String documentConnection, String fromDocumentId, String fromDocumentConnection, String caseId, Long processId)	Constructs a trace message to trace a move of a file.
static ITraceMessage	forDocumentUpdated(String applicationId, String userId, String userName, String documentId, String documentName, String documentConnection, String caseId, Long processId, String previousDocumentName)	Constructs a trace message to trace a update of a file.

Methods inherited from class com.aquima.interactions.trace.impl.TraceMessageBase

addProperty, getApplicationId, getMessageType, getProperties, getPropertyNames, getPropertyValue

Methods inherited from class java.lang.Object

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

Field Details

TYPE_DOCUMENT_CREATED

public static final String TYPE_DOCUMENT_CREATED

See Also:

• Constant Field Values

TYPE_DOCUMENT_UPDATED

public static final String TYPE_DOCUMENT_UPDATED

See Also:

• Constant Field Values

TYPE_DOCUMENT_MOVED

public static final String TYPE_DOCUMENT_MOVED

See Also:

• Constant Field Values

TYPE_DOCUMENT_RECEIVED

public static final String TYPE_DOCUMENT_RECEIVED

See Also:

• Constant Field Values

TYPE_DOCUMENT_DELETED

public static final String TYPE_DOCUMENT_DELETED

See Also:

• Constant Field Values

TYPE_DOCUMENT_METADATA_UPDATED

public static final String TYPE_DOCUMENT_METADATA_UPDATED

See Also:

• Constant Field Values

TYPE_DOCUMENT_GENERATED

public static final String TYPE_DOCUMENT_GENERATED

See Also:

• Constant Field Values

PROPERTY_USER_ID

public static final String PROPERTY_USER_ID

See Also:

• Constant Field Values

PROPERTY_USER_NAME

public static final String PROPERTY_USER_NAME

See Also:

• Constant Field Values

PROPERTY_DOCUMENT_FROM_ID

public static final String PROPERTY_DOCUMENT_FROM_ID

See Also:

• Constant Field Values

PROPERTY_DOCUMENT_FROM_CONNECTION

public static final String PROPERTY_DOCUMENT_FROM_CONNECTION

See Also:

• Constant Field Values

PROPERTY_DOCUMENT_FROM_NAME

public static final String PROPERTY_DOCUMENT_FROM_NAME

See Also:

• Constant Field Values

PROPERTY_DOCUMENT_TO_ID

public static final String PROPERTY_DOCUMENT_TO_ID

See Also:

• Constant Field Values

PROPERTY_DOCUMENT_TO_CONNECTION

public static final String PROPERTY_DOCUMENT_TO_CONNECTION

See Also:

• Constant Field Values

PROPERTY_DOCUMENT_TO_NAME

public static final String PROPERTY_DOCUMENT_TO_NAME

See Also:

• Constant Field Values

PROPERTY_DOCUMENT_ID

public static final String PROPERTY_DOCUMENT_ID

See Also:

• Constant Field Values

PROPERTY_DOCUMENT_NAME

public static final String PROPERTY_DOCUMENT_NAME

See Also:

• Constant Field Values

PROPERTY_DOCUMENT_CONNECTION

public static final String PROPERTY_DOCUMENT_CONNECTION

See Also:

• Constant Field Values

PROPERTY_DOCUMENT_CASE_ID

public static final String PROPERTY_DOCUMENT_CASE_ID

See Also:

• Constant Field Values

PROPERTY_DOCUMENT_PROCESS_ID

public static final String PROPERTY_DOCUMENT_PROCESS_ID

See Also:

• Constant Field Values

Method Details

forDocumentCreated

public static ITraceMessage forDocumentCreated(String applicationId,
 String userId,
 String userName,
 String documentId,
 String documentName,
 String documentConnection,
 String caseId,
 Long processId)

Constructs a trace message to trace a creation of a file.

Parameters:

applicationId - The id of the application, can not be null.

userId - the user id

userName - the user name

documentId - The id of the document, can not be null.

documentName - The name of the document, can not be null.

documentConnection - The connection used to create the document, can be null.

caseId - The optional case id, can be null.

processId - The optional process id, can be null.

Returns:

DocumentTraceMessage for tracing the creation of a file.

forDocumentUpdated

public static ITraceMessage forDocumentUpdated(String applicationId,
 String userId,
 String userName,
 String documentId,
 String documentName,
 String documentConnection,
 String caseId,
 Long processId,
 String previousDocumentName)

Constructs a trace message to trace a update of a file.

Parameters:

applicationId - The id of the application, can't be null.

userId - the user id

userName - the user name

documentId - The id of the document, can not be null.

documentName - The name of the document, can not be null.

documentConnection - The connection used to create the document, can be null.

caseId - The optional case id, can be null.

processId - The optional process id, can be null.

previousDocumentName - The name of the document before update.

Returns:

DocumentTraceMessage for tracing the update of a file.

forDocumentMoved

public static ITraceMessage forDocumentMoved(String applicationId,
 String userId,
 String userName,
 String documentId,
 String documentName,
 String documentConnection,
 String toDocumentId,
 String toDocumentConnection,
 String caseId,
 Long processId)

Constructs a trace message to trace a move of a file.

Parameters:

applicationId - The id of the application, can't be null.

userId - the user id

userName - the user name

documentId - The id of the document, can not be null.

documentName - The name of the document, can not be null.

documentConnection - The connection used to create the document, can be null.

toDocumentId - The to-id of the document, can be null.

toDocumentConnection - The to-connection used to create the document, can be null.

caseId - The optional case id, can be null.

processId - The optional process id, can be null.

Returns:

DocumentTraceMessage for tracing the move of a file.

forDocumentReceived

public static ITraceMessage forDocumentReceived(String applicationId,
 String userId,
 String userName,
 String documentId,
 String documentName,
 String documentConnection,
 String fromDocumentId,
 String fromDocumentConnection,
 String caseId,
 Long processId)

Constructs a trace message to trace a move of a file.

Parameters:

applicationId - The id of the application, can't be null.

userId - the user id

userName - the user name

documentId - The id of the document, can not be null.

documentName - The name of the document, can be null.

documentConnection - The connection used to create the document, can be null.

fromDocumentId - The from-id of the document before update.

fromDocumentConnection - The from-connection used to create the document, can be null.

caseId - The optional case id, can be null.

processId - The optional process id, can be null.

Returns:

DocumentTraceMessage for tracing the move of a file.

forDocumentDeleted

public static ITraceMessage forDocumentDeleted(String applicationId,
 String userId,
 String userName,
 String documentId,
 String documentName,
 String documentConnection,
 String caseId,
 Long processId)

Constructs a trace message to trace a delete of a file.

Parameters:

applicationId - The id of the application, can't be null.

userId - the user id

userName - the user name

documentId - The id of the document, can not be null.

documentName - The name of the document, can not be null.

documentConnection - The connection used to create the document, can be null.

caseId - The optional case id, can be null.

processId - The optional process id, can be null.

Returns:

DocumentTraceMessage for tracing the delete of a file.

forDocumentMetadataUpdated

public static ITraceMessage forDocumentMetadataUpdated(String applicationId,
 String userId,
 String userName,
 String documentId,
 String documentName,
 String documentConnection,
 String caseId,
 Long processId)

Constructs a trace message to trace a delete of a file.

Parameters:

applicationId - The id of the application, can't be null.

userId - the user id

userName - the user name

documentId - The id of the document, can not be null.

documentName - The name of the document, can not be null.

documentConnection - The connection used to create the document, can be null.

caseId - The optional case id, can be null.

processId - The optional process id, can be null.

Returns:

DocumentTraceMessage for tracing the update of a metadata file.

forDocumentGenerated

public static ITraceMessage forDocumentGenerated(String applicationId,
 String userId,
 String userName,
 String documentId,
 String documentName,
 String documentConnection,
 String caseId,
 Long processId)

Constructs a trace message to trace a generation of a file.

Parameters:

applicationId - The id of the application, can't be null.

userId - the user id

userName - the username

documentId - The id of the document, can not be null.

documentName - The name of the document, can not be null.

documentConnection - The connection used to generate the document, can be null.

caseId - The optional case id, can be null.

processId - Process id

Returns:

DocumentTraceMessage for tracing the generation of a file.