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 Description TransactionRecord()
Empty constructor for creating a transaction recorder.TransactionRecord(TransactionRecord record)
Copy constructor for Transaction RecordTransactionRecord(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 ServicesTransactionRecord(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 ICTransactionRecord(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.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map<java.lang.String,java.io.Serializable>
getAdditionalMetaData()
Getter for additional metadatajava.lang.String
getOperationId()
Getter for operation idjava.lang.String
getResId()
Getter for resource id.java.lang.String
getResName()
java.lang.Integer
getResSize()
java.lang.String
getResSubType()
Getter for resource sub-typejava.lang.String
getResType()
Getter for resource type.java.lang.String
getServiceId()
Getter for service idjava.lang.Integer
getTransactionCount()
Getter for transaction countjava.lang.String
getTransactionSubType()
Getter for transaction sub-typejava.lang.String
getTransactionType()
Getter for transaction typevoid
setAdditionalMetaData(java.util.Map<java.lang.String,java.io.Serializable> additionalMetaData)
Setter for additional metadatavoid
setOperationId(java.lang.String operationId)
Setter for operation idvoid
setResId(java.lang.String resId)
Setter for resource id.void
setResName(java.lang.String resName)
Setter for transaction typevoid
setResSize(java.lang.Integer resSize)
Setter for resource sizevoid
setResSubType(java.lang.String resSubType)
Setter for resource sub-typevoid
setResType(java.lang.String resType)
Setter for resource typevoid
setServiceId(java.lang.String serviceId)
Setter for service idvoid
setTransactionCount(java.lang.Integer transactionCount)
Setter for transaction countvoid
setTransactionSubType(java.lang.String transactionSubType)
Setter for transaction sub-typevoid
setTransactionType(java.lang.String transactionType)
Setter for transaction type
-
-
-
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 transactionsresType
- The type of the resource which is undergoing transaction. It can beFormsTransactionConstants.ASSET_TYPE_FORM
,FormsTransactionConstants.ASSET_TYPE_IC
orFormsTransactionConstants.ASSET_TYPE_DOCUMENT
. It's a mandatory attribute.resSubType
- The sub type fo the resource. It denotes whether form is aFormsTransactionConstants.ASSET_SUB_TYPE_AF
,FormsTransactionConstants.ASSET_SUB_TYPE_MF
or aFormsTransactionConstants.ASSET_SUB_TYPE_FORMSET
It also denotes whether an IC is aFormsTransactionConstants.ASSET_SUB_TYPE_IC_PRINT
orFormsTransactionConstants.ASSET_SUB_TYPE_IC_WEB
. It is optional.transactionType
- It denotes the type of the transaction being recorded. It can beFormsTransactionConstants.TRANSACTION_TYPE_SUBMIT
,FormsTransactionConstants.TRANSACTION_TYPE_RENDER
orFormsTransactionConstants.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 convertedresName
- Name of resource undergoing a transaction.serviceId
- Name of the billable API which is invoking the transactionoperationId
- Name of the billable API which is invoking the transactionresSize
- 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
-
-