docs/javadocs/net/authorize/Transaction.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_55) on Wed Dec 17 13:21:15 PST 2014 -->
<title>Transaction (Authorize.Net Java SDK)</title>
<meta name="date" content="2014-12-17">
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Transaction (Authorize.Net Java SDK)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Transaction.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../net/authorize/Result.html" title="class in net.authorize"><span class="strong">Prev Class</span></a></li>
<li><a href="../../net/authorize/TransactionType.html" title="enum in net.authorize"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?net/authorize/Transaction.html" target="_top">Frames</a></li>
<li><a href="Transaction.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">net.authorize</div>
<h2 title="Class Transaction" class="title">Class Transaction</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>net.authorize.Transaction</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Serializable</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../net/authorize/aim/Transaction.html" title="class in net.authorize.aim">Transaction</a>, <a href="../../net/authorize/arb/Transaction.html" title="class in net.authorize.arb">Transaction</a>, <a href="../../net/authorize/cim/Transaction.html" title="class in net.authorize.cim">Transaction</a>, <a href="../../net/authorize/reporting/Transaction.html" title="class in net.authorize.reporting">Transaction</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">Transaction</span>
extends java.lang.Object
implements java.io.Serializable</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../serialized-form.html#net.authorize.Transaction">Serialized Form</a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#BRACKET_PIPE_DELIMITER">BRACKET_PIPE_DELIMITER</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#CURRENCY_DECIMAL_PLACES">CURRENCY_DECIMAL_PLACES</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#EMPTY_STRING">EMPTY_STRING</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#ENCAP_CHAR_DELIMITER">ENCAP_CHAR_DELIMITER</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#FALSE">FALSE</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#MAX_AUTH_CODE_LENGTH">MAX_AUTH_CODE_LENGTH</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#QUANTITY_DECIMAL_PLACES">QUANTITY_DECIMAL_PLACES</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#TRANSACTION_FIELD_DELIMITER">TRANSACTION_FIELD_DELIMITER</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#TRUE">TRUE</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#VERSION">VERSION</a></strong></code> </td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.math.BigDecimal</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#ZERO_AMOUNT">ZERO_AMOUNT</a></strong></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#ZERO_STRING">ZERO_STRING</a></strong></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../net/authorize/Transaction.html#Transaction()">Transaction</a></strong>()</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#getDecodedString(org.w3c.dom.Node)">getDecodedString</a></strong>(org.w3c.dom.Node node)</code>
<div class="block">Try to decode string value from xml node as per proper xml requirements</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static org.w3c.dom.Node</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#getEncodedString(net.authorize.util.BasicXmlDocument, java.lang.String)">getEncodedString</a></strong>(<a href="../../net/authorize/util/BasicXmlDocument.html" title="class in net.authorize.util">BasicXmlDocument</a> document,
java.lang.String value)</code>
<div class="block">Try to encode string value as per proper xml requirements
Will default to original value (without encoding) if there are any exceptions</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#setEncapCharDelimiter(java.lang.String)">setEncapCharDelimiter</a></strong>(java.lang.String encapCharDelimiter)</code>
<div class="block">Convenience method for overriding the encap char delimiter.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#setTransactionFieldDelimiter(java.lang.String)">setTransactionFieldDelimiter</a></strong>(java.lang.String transactionFieldDelimiter)</code>
<div class="block">Convenience method for overriding the transaction field delimited.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#toNVPString()">toNVPString</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../net/authorize/Transaction.html#toXMLString()">toXMLString</a></strong>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="MAX_AUTH_CODE_LENGTH">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>MAX_AUTH_CODE_LENGTH</h4>
<pre>public static final int MAX_AUTH_CODE_LENGTH</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#net.authorize.Transaction.MAX_AUTH_CODE_LENGTH">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="VERSION">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>VERSION</h4>
<pre>public static final java.lang.String VERSION</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#net.authorize.Transaction.VERSION">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TRANSACTION_FIELD_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TRANSACTION_FIELD_DELIMITER</h4>
<pre>public static java.lang.String TRANSACTION_FIELD_DELIMITER</pre>
</li>
</ul>
<a name="ENCAP_CHAR_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ENCAP_CHAR_DELIMITER</h4>
<pre>public static java.lang.String ENCAP_CHAR_DELIMITER</pre>
</li>
</ul>
<a name="BRACKET_PIPE_DELIMITER">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>BRACKET_PIPE_DELIMITER</h4>
<pre>public static final java.lang.String BRACKET_PIPE_DELIMITER</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#net.authorize.Transaction.BRACKET_PIPE_DELIMITER">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="TRUE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TRUE</h4>
<pre>public static final java.lang.String TRUE</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#net.authorize.Transaction.TRUE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="FALSE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FALSE</h4>
<pre>public static final java.lang.String FALSE</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#net.authorize.Transaction.FALSE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ZERO_STRING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ZERO_STRING</h4>
<pre>public static final java.lang.String ZERO_STRING</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#net.authorize.Transaction.ZERO_STRING">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="ZERO_AMOUNT">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ZERO_AMOUNT</h4>
<pre>public static final java.math.BigDecimal ZERO_AMOUNT</pre>
</li>
</ul>
<a name="EMPTY_STRING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EMPTY_STRING</h4>
<pre>public static final java.lang.String EMPTY_STRING</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#net.authorize.Transaction.EMPTY_STRING">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="CURRENCY_DECIMAL_PLACES">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CURRENCY_DECIMAL_PLACES</h4>
<pre>public static final int CURRENCY_DECIMAL_PLACES</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#net.authorize.Transaction.CURRENCY_DECIMAL_PLACES">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="QUANTITY_DECIMAL_PLACES">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>QUANTITY_DECIMAL_PLACES</h4>
<pre>public static final int QUANTITY_DECIMAL_PLACES</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../constant-values.html#net.authorize.Transaction.QUANTITY_DECIMAL_PLACES">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Transaction()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Transaction</h4>
<pre>public Transaction()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setTransactionFieldDelimiter(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTransactionFieldDelimiter</h4>
<pre>public static void setTransactionFieldDelimiter(java.lang.String transactionFieldDelimiter)</pre>
<div class="block">Convenience method for overriding the transaction field delimited.
Character that will be used to separate fields in the transaction response.
The system will use the character passed in this field or the value stored
in the Merchant Interface if no value is passed.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>transactionFieldDelimiter</code> - </dd></dl>
</li>
</ul>
<a name="toNVPString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toNVPString</h4>
<pre>public java.lang.String toNVPString()</pre>
</li>
</ul>
<a name="toXMLString()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>toXMLString</h4>
<pre>public java.lang.String toXMLString()</pre>
</li>
</ul>
<a name="setEncapCharDelimiter(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEncapCharDelimiter</h4>
<pre>public static void setEncapCharDelimiter(java.lang.String encapCharDelimiter)</pre>
<div class="block">Convenience method for overriding the encap char delimiter.
Character that will be used to encapsulate the fields in the transaction response.
The system will use the character passed in this field or the value stored in
the Merchant Interface if no value is passed.</div>
</li>
</ul>
<a name="getEncodedString(net.authorize.util.BasicXmlDocument, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEncodedString</h4>
<pre>public static org.w3c.dom.Node getEncodedString(<a href="../../net/authorize/util/BasicXmlDocument.html" title="class in net.authorize.util">BasicXmlDocument</a> document,
java.lang.String value)</pre>
<div class="block">Try to encode string value as per proper xml requirements
Will default to original value (without encoding) if there are any exceptions</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>document</code> - the document to create text node to</dd><dd><code>value</code> - string value to encode</dd>
<dt><span class="strong">Returns:</span></dt><dd>Node with encoded text value appropriate for XML</dd></dl>
</li>
</ul>
<a name="getDecodedString(org.w3c.dom.Node)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getDecodedString</h4>
<pre>public static java.lang.String getDecodedString(org.w3c.dom.Node node)</pre>
<div class="block">Try to decode string value from xml node as per proper xml requirements</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>node</code> - which is a text element</dd>
<dt><span class="strong">Returns:</span></dt><dd>decoded String value</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Transaction.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../index-all.html">Index</a></li>
<li><a href="../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../net/authorize/Result.html" title="class in net.authorize"><span class="strong">Prev Class</span></a></li>
<li><a href="../../net/authorize/TransactionType.html" title="enum in net.authorize"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../index.html?net/authorize/Transaction.html" target="_top">Frames</a></li>
<li><a href="Transaction.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>