com.adobe.aem.transaction.core.model

Class TransactionRecord

java.lang.Object

com.adobe.aem.transaction.core.model.TransactionRecord

public class TransactionRecord
extends java.lang.Object

Represents a Transaction Record to be provided by billable services to record their transaction.

Constructor Summary

Constructors

Constructor and Description
TransactionRecord() Empty constructor for creating a transaction recorder.
TransactionRecord(java.lang.Integer transactionCount, java.lang.String resType, java.lang.String transactionType, java.lang.String transactionSubType, java.lang.String serviceId, java.lang.String operationId) A constructor specifying parameters relevant for Document Services
TransactionRecord(java.lang.Integer transactionCount, java.lang.String resType, java.lang.String resSubType, java.lang.String transactionType, java.lang.String transactionSubType, java.lang.String resId, java.lang.String resName) A constructor specifying parameters relevant for Forms and IC
TransactionRecord(java.lang.Integer transactionCount, java.lang.String resType, java.lang.String resSubType, java.lang.String transactionType, java.lang.String transactionSubType, java.lang.String resId, java.lang.String resName, java.lang.String serviceId, java.lang.String operationId, java.lang.Integer resSize, java.util.Map<java.lang.String,java.io.Serializable> additionalMetaData) A generic constructor for creating a transaction record.
TransactionRecord(TransactionRecord record) Copy constructor for Transaction Record

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.io.Serializable>	getAdditionalMetaData() Getter for additional metadata
java.lang.String	getOperationId() Getter for operation id
java.lang.String	getResId() Getter for resource id.
java.lang.String	getResName()
java.lang.Integer	getResSize()
java.lang.String	getResSubType() Getter for resource sub-type
java.lang.String	getResType() Getter for resource type.
java.lang.String	getServiceId() Getter for service id
java.lang.Integer	getTransactionCount() Getter for transaction count
java.lang.String	getTransactionSubType() Getter for transaction sub-type
java.lang.String	getTransactionType() Getter for transaction type
void	setAdditionalMetaData(java.util.Map<java.lang.String,java.io.Serializable> additionalMetaData) Setter for additional metadata
void	setOperationId(java.lang.String operationId) Setter for operation id
void	setResId(java.lang.String resId) Setter for resource id.
void	setResName(java.lang.String resName) Setter for transaction type
void	setResSize(java.lang.Integer resSize) Setter for resource size
void	setResSubType(java.lang.String resSubType) Setter for resource sub-type
void	setResType(java.lang.String resType) Setter for resource type
void	setServiceId(java.lang.String serviceId) Setter for service id
void	setTransactionCount(java.lang.Integer transactionCount) Setter for transaction count
void	setTransactionSubType(java.lang.String transactionSubType) Setter for transaction sub-type
void	setTransactionType(java.lang.String transactionType) Setter for transaction type

Methods inherited from class java.lang.Object

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

Constructor Detail

TransactionRecord

public TransactionRecord()

Empty constructor for creating a transaction recorder.

TransactionRecord

public TransactionRecord(java.lang.Integer transactionCount,
                         java.lang.String resType,
                         java.lang.String resSubType,
                         java.lang.String transactionType,
                         java.lang.String transactionSubType,
                         java.lang.String resId,
                         java.lang.String resName,
                         java.lang.String serviceId,
                         java.lang.String operationId,
                         java.lang.Integer resSize,
                         java.util.Map<java.lang.String,java.io.Serializable> additionalMetaData)

A generic constructor for creating a transaction record.

Parameters:

transactionCount - Count of the transactions

resType - The type of the resource which is undergoing transaction. It can be FormsTransactionConstants.ASSET_TYPE_FORM, FormsTransactionConstants.ASSET_TYPE_IC or FormsTransactionConstants.ASSET_TYPE_DOCUMENT. It's a mandatory attribute.

resSubType - The sub type fo the resource. It denotes whether form is a FormsTransactionConstants.ASSET_SUB_TYPE_AF, FormsTransactionConstants.ASSET_SUB_TYPE_MF or a FormsTransactionConstants.ASSET_SUB_TYPE_FORMSET It also denotes whether an IC is a FormsTransactionConstants.ASSET_SUB_TYPE_IC_PRINT or FormsTransactionConstants.ASSET_SUB_TYPE_IC_WEB. It is optional.

transactionType - It denotes the type of the transaction being recorded. It can be FormsTransactionConstants.TRANSACTION_TYPE_SUBMIT, FormsTransactionConstants.TRANSACTION_TYPE_RENDER or FormsTransactionConstants.TRANSACTION_TYPE_CONVERT. It's a mandatory attribute.

transactionSubType - Sub-type of the transaction. It can specify the forms submission end point or the input to output conversion format in case of document services.

resId - The unique identifier of the resource. It may be rendition url of form/IC or file system path of the document converted

resName - Name of resource undergoing a transaction.

serviceId - Name of the billable API which is invoking the transaction

operationId - Name of the billable API which is invoking the transaction

resSize - Size of the resource undergoing a transaction.

additionalMetaData - Any additional meta-data that service may provide to the framework.

TransactionRecord

public TransactionRecord(java.lang.Integer transactionCount,
                         java.lang.String resType,
                         java.lang.String resSubType,
                         java.lang.String transactionType,
                         java.lang.String transactionSubType,
                         java.lang.String resId,
                         java.lang.String resName)

A constructor specifying parameters relevant for Forms and IC

Parameters:

transactionCount -

resType -

resSubType -

transactionType -

transactionSubType -

resId -

resName -

TransactionRecord

public TransactionRecord(java.lang.Integer transactionCount,
                         java.lang.String resType,
                         java.lang.String transactionType,
                         java.lang.String transactionSubType,
                         java.lang.String serviceId,
                         java.lang.String operationId)

A constructor specifying parameters relevant for Document Services

Parameters:

transactionCount -

resType -

transactionType -

transactionSubType -

serviceId -

operationId -

TransactionRecord

public TransactionRecord(TransactionRecord record)

Copy constructor for Transaction Record

Parameters:

record - transaction record object

Method Detail

getResId

public java.lang.String getResId()

Getter for resource id.

setResId

public void setResId(java.lang.String resId)

Setter for resource id.

getResType

public java.lang.String getResType()

Getter for resource type.

setResType

public void setResType(java.lang.String resType)

Setter for resource type

getResSubType

public java.lang.String getResSubType()

Getter for resource sub-type

setResSubType

public void setResSubType(java.lang.String resSubType)

Setter for resource sub-type

getTransactionType

public java.lang.String getTransactionType()

Getter for transaction type

setTransactionType

public void setTransactionType(java.lang.String transactionType)

Setter for transaction type

getTransactionSubType

public java.lang.String getTransactionSubType()

Getter for transaction sub-type

setTransactionSubType

public void setTransactionSubType(java.lang.String transactionSubType)

Setter for transaction sub-type

getResName

public java.lang.String getResName()

setResName

public void setResName(java.lang.String resName)

Setter for transaction type

getServiceId

public java.lang.String getServiceId()

Getter for service id

setServiceId

public void setServiceId(java.lang.String serviceId)

Setter for service id

getOperationId

public java.lang.String getOperationId()

Getter for operation id

setOperationId

public void setOperationId(java.lang.String operationId)

Setter for operation id

getTransactionCount

public java.lang.Integer getTransactionCount()

Getter for transaction count

setTransactionCount

public void setTransactionCount(java.lang.Integer transactionCount)

Setter for transaction count

getAdditionalMetaData

public java.util.Map<java.lang.String,java.io.Serializable> getAdditionalMetaData()

Getter for additional metadata

setAdditionalMetaData

public void setAdditionalMetaData(java.util.Map<java.lang.String,java.io.Serializable> additionalMetaData)

Setter for additional metadata

getResSize

public java.lang.Integer getResSize()

setResSize

public void setResSize(java.lang.Integer resSize)

Setter for resource size