ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-04-11 21:31:44 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Docs: (Re)push auto generated API docs

Browse Source
This commit is contained in:
Mike Hearn 2016-04-29 18:45:41 +02:00
parent 5a3c6e7fed
commit 5eaf86a4b1
1862 changed files with 65125 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1501
docs/build/html/api/alltypes/index.html vendored Normal file
View File

File diff suppressed because it is too large Load Diff

14
docs/build/html/api/api/-a-p-i-server-impl/-init-.html vendored Normal file
View File

@ -0,0 +1,14 @@
<HTML>
<HEAD>
<title>APIServerImpl.<init> - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServerImpl</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<code><span class="identifier">APIServerImpl</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$<init>(core.node.AbstractNode)/node">node</span><span class="symbol">:</span>&nbsp;<a href="../../core.node/-abstract-node/index.html"><span class="identifier">AbstractNode</span></a><span class="symbol">)</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

19
docs/build/html/api/api/-a-p-i-server-impl/build-transaction.html vendored Normal file
View File

@ -0,0 +1,19 @@
<HTML>
<HEAD>
<title>APIServerImpl.buildTransaction - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServerImpl</a>&nbsp;/&nbsp;<a href=".">buildTransaction</a><br/>
<br/>
<h1>buildTransaction</h1>
<a name="api.APIServerImpl$buildTransaction(api.ContractDefRef, kotlin.collections.List((api.TransactionBuildStep)))"></a>
<code><span class="keyword">fun </span><span class="identifier">buildTransaction</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$buildTransaction(api.ContractDefRef, kotlin.collections.List((api.TransactionBuildStep)))/type">type</span><span class="symbol">:</span>&nbsp;<a href="../-contract-def-ref.html"><span class="identifier">ContractDefRef</span></a><span class="symbol">, </span><span class="identifier" id="api.APIServerImpl$buildTransaction(api.ContractDefRef, kotlin.collections.List((api.TransactionBuildStep)))/steps">steps</span><span class="symbol">:</span>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../-transaction-build-step/index.html"><span class="identifier">TransactionBuildStep</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol">&lt;</span><a href="../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">&gt;</span></code><br/>
Overrides <a href="../-a-p-i-server/build-transaction.html">APIServer.buildTransaction</a><br/>
<p>TransactionBuildSteps would be invocations of contract.generateXXX() methods that all share a common TransactionBuilder
and a common contract type (e.g. Cash or CommercialPaper)
which would automatically be passed as the first argument (wed need that to be a criteria/pattern of the generateXXX methods).</p>
<br/>
<br/>
</BODY>
</HTML>

18
docs/build/html/api/api/-a-p-i-server-impl/commit-transaction.html vendored Normal file
View File

@ -0,0 +1,18 @@
<HTML>
<HEAD>
<title>APIServerImpl.commitTransaction - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServerImpl</a>&nbsp;/&nbsp;<a href=".">commitTransaction</a><br/>
<br/>
<h1>commitTransaction</h1>
<a name="api.APIServerImpl$commitTransaction(core.serialization.SerializedBytes((core.WireTransaction)), kotlin.collections.List((core.crypto.DigitalSignature.WithKey)))"></a>
<code><span class="keyword">fun </span><span class="identifier">commitTransaction</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$commitTransaction(core.serialization.SerializedBytes((core.WireTransaction)), kotlin.collections.List((core.crypto.DigitalSignature.WithKey)))/tx">tx</span><span class="symbol">:</span>&nbsp;<a href="../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol">&lt;</span><a href="../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier" id="api.APIServerImpl$commitTransaction(core.serialization.SerializedBytes((core.WireTransaction)), kotlin.collections.List((core.crypto.DigitalSignature.WithKey)))/signatures">signatures</span><span class="symbol">:</span>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../core.crypto/-digital-signature/-with-key/index.html"><span class="identifier">WithKey</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><br/>
Overrides <a href="../-a-p-i-server/commit-transaction.html">APIServer.commitTransaction</a><br/>
<p>Attempt to commit transaction (returned from build transaction) with the necessary signatures for that to be
successful, otherwise exception is thrown.</p>
<br/>
<br/>
</BODY>
</HTML>

17
docs/build/html/api/api/-a-p-i-server-impl/fetch-protocols-requiring-attention.html vendored Normal file
View File

@ -0,0 +1,17 @@
<HTML>
<HEAD>
<title>APIServerImpl.fetchProtocolsRequiringAttention - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServerImpl</a>&nbsp;/&nbsp;<a href=".">fetchProtocolsRequiringAttention</a><br/>
<br/>
<h1>fetchProtocolsRequiringAttention</h1>
<a name="api.APIServerImpl$fetchProtocolsRequiringAttention(api.StatesQuery)"></a>
<code><span class="keyword">fun </span><span class="identifier">fetchProtocolsRequiringAttention</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$fetchProtocolsRequiringAttention(api.StatesQuery)/query">query</span><span class="symbol">:</span>&nbsp;<a href="../-states-query/index.html"><span class="identifier">StatesQuery</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol">&lt;</span><a href="../../core/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">,</span>&nbsp;<a href="../-protocol-requiring-attention/index.html"><span class="identifier">ProtocolRequiringAttention</span></a><span class="symbol">&gt;</span></code><br/>
Overrides <a href="../-a-p-i-server/fetch-protocols-requiring-attention.html">APIServer.fetchProtocolsRequiringAttention</a><br/>
<p>Fetch protocols that require a response to some prompt/question by a human (on the "bank" side).</p>
<br/>
<br/>
</BODY>
</HTML>

16
docs/build/html/api/api/-a-p-i-server-impl/fetch-states.html vendored Normal file
View File

@ -0,0 +1,16 @@
<HTML>
<HEAD>
<title>APIServerImpl.fetchStates - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServerImpl</a>&nbsp;/&nbsp;<a href=".">fetchStates</a><br/>
<br/>
<h1>fetchStates</h1>
<a name="api.APIServerImpl$fetchStates(kotlin.collections.List((core.StateRef)))"></a>
<code><span class="keyword">fun </span><span class="identifier">fetchStates</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$fetchStates(kotlin.collections.List((core.StateRef)))/states">states</span><span class="symbol">:</span>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../core/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol">&lt;</span><a href="../../core/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">,</span>&nbsp;<a href="../../core/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">?</span><span class="symbol">&gt;</span></code><br/>
Overrides <a href="../-a-p-i-server/fetch-states.html">APIServer.fetchStates</a><br/>
<br/>
<br/>
</BODY>
</HTML>

22
docs/build/html/api/api/-a-p-i-server-impl/fetch-transactions.html vendored Normal file
View File

@ -0,0 +1,22 @@
<HTML>
<HEAD>
<title>APIServerImpl.fetchTransactions - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServerImpl</a>&nbsp;/&nbsp;<a href=".">fetchTransactions</a><br/>
<br/>
<h1>fetchTransactions</h1>
<a name="api.APIServerImpl$fetchTransactions(kotlin.collections.List((core.crypto.SecureHash)))"></a>
<code><span class="keyword">fun </span><span class="identifier">fetchTransactions</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$fetchTransactions(kotlin.collections.List((core.crypto.SecureHash)))/txs">txs</span><span class="symbol">:</span>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol">&lt;</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">,</span>&nbsp;<a href="../../core/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a><span class="symbol">?</span><span class="symbol">&gt;</span></code><br/>
Overrides <a href="../-a-p-i-server/fetch-transactions.html">APIServer.fetchTransactions</a><br/>
<p>Query for immutable transactions (results can be cached indefinitely by their id/hash).</p>
<h3>Parameters</h3>
<a name="txs"></a>
<code>txs</code> - The hashes (from <a href="../../core/-state-ref/txhash.html">StateRef.txhash</a> returned from <a href="query-states.html">queryStates</a>) you would like full transactions for.<br/>
<strong>Return</strong><br/>
null values indicate missing transactions from the requested list.<br/>
<br/>
<br/>
</BODY>
</HTML>

17
docs/build/html/api/api/-a-p-i-server-impl/generate-transaction-signature.html vendored Normal file
View File

@ -0,0 +1,17 @@
<HTML>
<HEAD>
<title>APIServerImpl.generateTransactionSignature - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServerImpl</a>&nbsp;/&nbsp;<a href=".">generateTransactionSignature</a><br/>
<br/>
<h1>generateTransactionSignature</h1>
<a name="api.APIServerImpl$generateTransactionSignature(core.serialization.SerializedBytes((core.WireTransaction)))"></a>
<code><span class="keyword">fun </span><span class="identifier">generateTransactionSignature</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$generateTransactionSignature(core.serialization.SerializedBytes((core.WireTransaction)))/tx">tx</span><span class="symbol">:</span>&nbsp;<a href="../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol">&lt;</span><a href="../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.crypto/-digital-signature/-with-key/index.html"><span class="identifier">WithKey</span></a></code><br/>
Overrides <a href="../-a-p-i-server/generate-transaction-signature.html">APIServer.generateTransactionSignature</a><br/>
<p>Generate a signature for this transaction signed by us.</p>
<br/>
<br/>
</BODY>
</HTML>

115
docs/build/html/api/api/-a-p-i-server-impl/index.html vendored Normal file
View File

@ -0,0 +1,115 @@
<HTML>
<HEAD>
<title>APIServerImpl - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href=".">APIServerImpl</a><br/>
<br/>
<h1>APIServerImpl</h1>
<code><span class="keyword">class </span><span class="identifier">APIServerImpl</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../-a-p-i-server/index.html"><span class="identifier">APIServer</span></a></code><br/>
<br/>
<br/>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-init-.html">&lt;init&gt;</a></td>
<td>
<code><span class="identifier">APIServerImpl</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$<init>(core.node.AbstractNode)/node">node</span><span class="symbol">:</span>&nbsp;<a href="../../core.node/-abstract-node/index.html"><span class="identifier">AbstractNode</span></a><span class="symbol">)</span></code></td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<a href="node.html">node</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">node</span><span class="symbol">: </span><a href="../../core.node/-abstract-node/index.html"><span class="identifier">AbstractNode</span></a></code></td>
</tr>
</tbody>
</table>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
<a href="build-transaction.html">buildTransaction</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">buildTransaction</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$buildTransaction(api.ContractDefRef, kotlin.collections.List((api.TransactionBuildStep)))/type">type</span><span class="symbol">:</span>&nbsp;<a href="../-contract-def-ref.html"><span class="identifier">ContractDefRef</span></a><span class="symbol">, </span><span class="identifier" id="api.APIServerImpl$buildTransaction(api.ContractDefRef, kotlin.collections.List((api.TransactionBuildStep)))/steps">steps</span><span class="symbol">:</span>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../-transaction-build-step/index.html"><span class="identifier">TransactionBuildStep</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol">&lt;</span><a href="../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">&gt;</span></code><p>TransactionBuildSteps would be invocations of contract.generateXXX() methods that all share a common TransactionBuilder
and a common contract type (e.g. Cash or CommercialPaper)
which would automatically be passed as the first argument (wed need that to be a criteria/pattern of the generateXXX methods).</p>
</td>
</tr>
<tr>
<td>
<a href="commit-transaction.html">commitTransaction</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">commitTransaction</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$commitTransaction(core.serialization.SerializedBytes((core.WireTransaction)), kotlin.collections.List((core.crypto.DigitalSignature.WithKey)))/tx">tx</span><span class="symbol">:</span>&nbsp;<a href="../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol">&lt;</span><a href="../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier" id="api.APIServerImpl$commitTransaction(core.serialization.SerializedBytes((core.WireTransaction)), kotlin.collections.List((core.crypto.DigitalSignature.WithKey)))/signatures">signatures</span><span class="symbol">:</span>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../core.crypto/-digital-signature/-with-key/index.html"><span class="identifier">WithKey</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><p>Attempt to commit transaction (returned from build transaction) with the necessary signatures for that to be
successful, otherwise exception is thrown.</p>
</td>
</tr>
<tr>
<td>
<a href="fetch-protocols-requiring-attention.html">fetchProtocolsRequiringAttention</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">fetchProtocolsRequiringAttention</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$fetchProtocolsRequiringAttention(api.StatesQuery)/query">query</span><span class="symbol">:</span>&nbsp;<a href="../-states-query/index.html"><span class="identifier">StatesQuery</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol">&lt;</span><a href="../../core/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">,</span>&nbsp;<a href="../-protocol-requiring-attention/index.html"><span class="identifier">ProtocolRequiringAttention</span></a><span class="symbol">&gt;</span></code><p>Fetch protocols that require a response to some prompt/question by a human (on the "bank" side).</p>
</td>
</tr>
<tr>
<td>
<a href="fetch-states.html">fetchStates</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">fetchStates</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$fetchStates(kotlin.collections.List((core.StateRef)))/states">states</span><span class="symbol">:</span>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../core/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol">&lt;</span><a href="../../core/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">,</span>&nbsp;<a href="../../core/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">?</span><span class="symbol">&gt;</span></code></td>
</tr>
<tr>
<td>
<a href="fetch-transactions.html">fetchTransactions</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">fetchTransactions</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$fetchTransactions(kotlin.collections.List((core.crypto.SecureHash)))/txs">txs</span><span class="symbol">:</span>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol">&lt;</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">,</span>&nbsp;<a href="../../core/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a><span class="symbol">?</span><span class="symbol">&gt;</span></code><p>Query for immutable transactions (results can be cached indefinitely by their id/hash).</p>
</td>
</tr>
<tr>
<td>
<a href="generate-transaction-signature.html">generateTransactionSignature</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">generateTransactionSignature</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$generateTransactionSignature(core.serialization.SerializedBytes((core.WireTransaction)))/tx">tx</span><span class="symbol">:</span>&nbsp;<a href="../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol">&lt;</span><a href="../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.crypto/-digital-signature/-with-key/index.html"><span class="identifier">WithKey</span></a></code><p>Generate a signature for this transaction signed by us.</p>
</td>
</tr>
<tr>
<td>
<a href="invoke-protocol-sync.html">invokeProtocolSync</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">invokeProtocolSync</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$invokeProtocolSync(api.ProtocolRef, kotlin.collections.Map((kotlin.String, kotlin.Any)))/type">type</span><span class="symbol">:</span>&nbsp;<a href="../-protocol-ref.html"><span class="identifier">ProtocolRef</span></a><span class="symbol">, </span><span class="identifier" id="api.APIServerImpl$invokeProtocolSync(api.ProtocolRef, kotlin.collections.Map((kotlin.String, kotlin.Any)))/args">args</span><span class="symbol">:</span>&nbsp;<span class="identifier">Map</span><span class="symbol">&lt;</span><span class="identifier">String</span><span class="symbol">,</span>&nbsp;<span class="identifier">Any</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Any</span><span class="symbol">?</span></code><p>This method would not return until the protocol is finished (hence the "Sync").</p>
</td>
</tr>
<tr>
<td>
<a href="provide-protocol-response.html">provideProtocolResponse</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">provideProtocolResponse</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$provideProtocolResponse(api.ProtocolInstanceRef, core.crypto.SecureHash, kotlin.collections.Map((kotlin.String, kotlin.Any)))/protocol">protocol</span><span class="symbol">:</span>&nbsp;<a href="../-protocol-instance-ref/index.html"><span class="identifier">ProtocolInstanceRef</span></a><span class="symbol">, </span><span class="identifier" id="api.APIServerImpl$provideProtocolResponse(api.ProtocolInstanceRef, core.crypto.SecureHash, kotlin.collections.Map((kotlin.String, kotlin.Any)))/choice">choice</span><span class="symbol">:</span>&nbsp;<a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">, </span><span class="identifier" id="api.APIServerImpl$provideProtocolResponse(api.ProtocolInstanceRef, core.crypto.SecureHash, kotlin.collections.Map((kotlin.String, kotlin.Any)))/args">args</span><span class="symbol">:</span>&nbsp;<span class="identifier">Map</span><span class="symbol">&lt;</span><span class="identifier">String</span><span class="symbol">,</span>&nbsp;<span class="identifier">Any</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>Provide the response that a protocol is waiting for.</p>
</td>
</tr>
<tr>
<td>
<a href="query-states.html">queryStates</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">queryStates</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$queryStates(api.StatesQuery)/query">query</span><span class="symbol">:</span>&nbsp;<a href="../-states-query/index.html"><span class="identifier">StatesQuery</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../core/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">&gt;</span></code><p>Query your "local" states (containing only outputs involving you) and return the hashes &amp; indexes associated with them
to probably be later inflated by fetchLedgerTransactions() or fetchStates() although because immutable you can cache them
to avoid calling fetchLedgerTransactions() many times.</p>
</td>
</tr>
<tr>
<td>
<a href="server-time.html">serverTime</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">serverTime</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/time/LocalDateTime.html"><span class="identifier">LocalDateTime</span></a></code><p>Report current UTC time as understood by the platform.</p>
</td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

22
docs/build/html/api/api/-a-p-i-server-impl/invoke-protocol-sync.html vendored Normal file
View File

@ -0,0 +1,22 @@
<HTML>
<HEAD>
<title>APIServerImpl.invokeProtocolSync - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServerImpl</a>&nbsp;/&nbsp;<a href=".">invokeProtocolSync</a><br/>
<br/>
<h1>invokeProtocolSync</h1>
<a name="api.APIServerImpl$invokeProtocolSync(api.ProtocolRef, kotlin.collections.Map((kotlin.String, kotlin.Any)))"></a>
<code><span class="keyword">fun </span><span class="identifier">invokeProtocolSync</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$invokeProtocolSync(api.ProtocolRef, kotlin.collections.Map((kotlin.String, kotlin.Any)))/type">type</span><span class="symbol">:</span>&nbsp;<a href="../-protocol-ref.html"><span class="identifier">ProtocolRef</span></a><span class="symbol">, </span><span class="identifier" id="api.APIServerImpl$invokeProtocolSync(api.ProtocolRef, kotlin.collections.Map((kotlin.String, kotlin.Any)))/args">args</span><span class="symbol">:</span>&nbsp;<span class="identifier">Map</span><span class="symbol">&lt;</span><span class="identifier">String</span><span class="symbol">,</span>&nbsp;<span class="identifier">Any</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Any</span><span class="symbol">?</span></code><br/>
Overrides <a href="../-a-p-i-server/invoke-protocol-sync.html">APIServer.invokeProtocolSync</a><br/>
<p>This method would not return until the protocol is finished (hence the "Sync").</p>
<p>Longer term wed add an Async version that returns some kind of ProtocolInvocationRef that could be queried and
would appear on some kind of event message that is broadcast informing of progress.</p>
<p>Will throw exception if protocol fails.</p>
<br/>
<br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-a-p-i-server-impl/node.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>APIServerImpl.node - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServerImpl</a>&nbsp;/&nbsp;<a href=".">node</a><br/>
<br/>
<h1>node</h1>
<a name="api.APIServerImpl$node"></a>
<code><span class="keyword">val </span><span class="identifier">node</span><span class="symbol">: </span><a href="../../core.node/-abstract-node/index.html"><span class="identifier">AbstractNode</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

29
docs/build/html/api/api/-a-p-i-server-impl/provide-protocol-response.html vendored Normal file
View File

@ -0,0 +1,29 @@
<HTML>
<HEAD>
<title>APIServerImpl.provideProtocolResponse - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServerImpl</a>&nbsp;/&nbsp;<a href=".">provideProtocolResponse</a><br/>
<br/>
<h1>provideProtocolResponse</h1>
<a name="api.APIServerImpl$provideProtocolResponse(api.ProtocolInstanceRef, core.crypto.SecureHash, kotlin.collections.Map((kotlin.String, kotlin.Any)))"></a>
<code><span class="keyword">fun </span><span class="identifier">provideProtocolResponse</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$provideProtocolResponse(api.ProtocolInstanceRef, core.crypto.SecureHash, kotlin.collections.Map((kotlin.String, kotlin.Any)))/protocol">protocol</span><span class="symbol">:</span>&nbsp;<a href="../-protocol-instance-ref/index.html"><span class="identifier">ProtocolInstanceRef</span></a><span class="symbol">, </span><span class="identifier" id="api.APIServerImpl$provideProtocolResponse(api.ProtocolInstanceRef, core.crypto.SecureHash, kotlin.collections.Map((kotlin.String, kotlin.Any)))/choice">choice</span><span class="symbol">:</span>&nbsp;<a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">, </span><span class="identifier" id="api.APIServerImpl$provideProtocolResponse(api.ProtocolInstanceRef, core.crypto.SecureHash, kotlin.collections.Map((kotlin.String, kotlin.Any)))/args">args</span><span class="symbol">:</span>&nbsp;<span class="identifier">Map</span><span class="symbol">&lt;</span><span class="identifier">String</span><span class="symbol">,</span>&nbsp;<span class="identifier">Any</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
Overrides <a href="../-a-p-i-server/provide-protocol-response.html">APIServer.provideProtocolResponse</a><br/>
<p>Provide the response that a protocol is waiting for.</p>
<h3>Parameters</h3>
<a name="protocol"></a>
<code>protocol</code> - Should refer to a previously supplied ProtocolRequiringAttention.<br/>
<br/>
<a name="stepId"></a>
<code>stepId</code> - Which step of the protocol are we referring too.<br/>
<br/>
<a name="choice"></a>
<code>choice</code> - Should be one of the choices presented in the ProtocolRequiringAttention.<br/>
<br/>
<a name="args"></a>
<code>args</code> - Any arguments required.<br/>
<br/>
<br/>
</BODY>
</HTML>

24
docs/build/html/api/api/-a-p-i-server-impl/query-states.html vendored Normal file
View File

@ -0,0 +1,24 @@
<HTML>
<HEAD>
<title>APIServerImpl.queryStates - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServerImpl</a>&nbsp;/&nbsp;<a href=".">queryStates</a><br/>
<br/>
<h1>queryStates</h1>
<a name="api.APIServerImpl$queryStates(api.StatesQuery)"></a>
<code><span class="keyword">fun </span><span class="identifier">queryStates</span><span class="symbol">(</span><span class="identifier" id="api.APIServerImpl$queryStates(api.StatesQuery)/query">query</span><span class="symbol">:</span>&nbsp;<a href="../-states-query/index.html"><span class="identifier">StatesQuery</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../core/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">&gt;</span></code><br/>
Overrides <a href="../-a-p-i-server/query-states.html">APIServer.queryStates</a><br/>
<p>Query your "local" states (containing only outputs involving you) and return the hashes &amp; indexes associated with them
to probably be later inflated by fetchLedgerTransactions() or fetchStates() although because immutable you can cache them
to avoid calling fetchLedgerTransactions() many times.</p>
<h3>Parameters</h3>
<a name="query"></a>
<code>query</code> - Some "where clause" like expression.<br/>
<strong>Return</strong><br/>
Zero or more matching States.<br/>
<br/>
<br/>
</BODY>
</HTML>

17
docs/build/html/api/api/-a-p-i-server-impl/server-time.html vendored Normal file
View File

@ -0,0 +1,17 @@
<HTML>
<HEAD>
<title>APIServerImpl.serverTime - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServerImpl</a>&nbsp;/&nbsp;<a href=".">serverTime</a><br/>
<br/>
<h1>serverTime</h1>
<a name="api.APIServerImpl$serverTime()"></a>
<code><span class="keyword">fun </span><span class="identifier">serverTime</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/time/LocalDateTime.html"><span class="identifier">LocalDateTime</span></a></code><br/>
Overrides <a href="../-a-p-i-server/server-time.html">APIServer.serverTime</a><br/>
<p>Report current UTC time as understood by the platform.</p>
<br/>
<br/>
</BODY>
</HTML>

18
docs/build/html/api/api/-a-p-i-server/build-transaction.html vendored Normal file
View File

@ -0,0 +1,18 @@
<HTML>
<HEAD>
<title>APIServer.buildTransaction - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServer</a>&nbsp;/&nbsp;<a href=".">buildTransaction</a><br/>
<br/>
<h1>buildTransaction</h1>
<a name="api.APIServer$buildTransaction(api.ContractDefRef, kotlin.collections.List((api.TransactionBuildStep)))"></a>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">buildTransaction</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$buildTransaction(api.ContractDefRef, kotlin.collections.List((api.TransactionBuildStep)))/type">type</span><span class="symbol">:</span>&nbsp;<a href="../-contract-def-ref.html"><span class="identifier">ContractDefRef</span></a><span class="symbol">, </span><span class="identifier" id="api.APIServer$buildTransaction(api.ContractDefRef, kotlin.collections.List((api.TransactionBuildStep)))/steps">steps</span><span class="symbol">:</span>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../-transaction-build-step/index.html"><span class="identifier">TransactionBuildStep</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol">&lt;</span><a href="../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">&gt;</span></code><br/>
<p>TransactionBuildSteps would be invocations of contract.generateXXX() methods that all share a common TransactionBuilder
and a common contract type (e.g. Cash or CommercialPaper)
which would automatically be passed as the first argument (wed need that to be a criteria/pattern of the generateXXX methods).</p>
<br/>
<br/>
</BODY>
</HTML>

17
docs/build/html/api/api/-a-p-i-server/commit-transaction.html vendored Normal file
View File

@ -0,0 +1,17 @@
<HTML>
<HEAD>
<title>APIServer.commitTransaction - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServer</a>&nbsp;/&nbsp;<a href=".">commitTransaction</a><br/>
<br/>
<h1>commitTransaction</h1>
<a name="api.APIServer$commitTransaction(core.serialization.SerializedBytes((core.WireTransaction)), kotlin.collections.List((core.crypto.DigitalSignature.WithKey)))"></a>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">commitTransaction</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$commitTransaction(core.serialization.SerializedBytes((core.WireTransaction)), kotlin.collections.List((core.crypto.DigitalSignature.WithKey)))/tx">tx</span><span class="symbol">:</span>&nbsp;<a href="../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol">&lt;</span><a href="../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier" id="api.APIServer$commitTransaction(core.serialization.SerializedBytes((core.WireTransaction)), kotlin.collections.List((core.crypto.DigitalSignature.WithKey)))/signatures">signatures</span><span class="symbol">:</span>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../core.crypto/-digital-signature/-with-key/index.html"><span class="identifier">WithKey</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><br/>
<p>Attempt to commit transaction (returned from build transaction) with the necessary signatures for that to be
successful, otherwise exception is thrown.</p>
<br/>
<br/>
</BODY>
</HTML>

16
docs/build/html/api/api/-a-p-i-server/fetch-protocols-requiring-attention.html vendored Normal file
View File

@ -0,0 +1,16 @@
<HTML>
<HEAD>
<title>APIServer.fetchProtocolsRequiringAttention - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServer</a>&nbsp;/&nbsp;<a href=".">fetchProtocolsRequiringAttention</a><br/>
<br/>
<h1>fetchProtocolsRequiringAttention</h1>
<a name="api.APIServer$fetchProtocolsRequiringAttention(api.StatesQuery)"></a>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">fetchProtocolsRequiringAttention</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$fetchProtocolsRequiringAttention(api.StatesQuery)/query">query</span><span class="symbol">:</span>&nbsp;<a href="../-states-query/index.html"><span class="identifier">StatesQuery</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol">&lt;</span><a href="../../core/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">,</span>&nbsp;<a href="../-protocol-requiring-attention/index.html"><span class="identifier">ProtocolRequiringAttention</span></a><span class="symbol">&gt;</span></code><br/>
<p>Fetch protocols that require a response to some prompt/question by a human (on the "bank" side).</p>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-a-p-i-server/fetch-states.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>APIServer.fetchStates - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServer</a>&nbsp;/&nbsp;<a href=".">fetchStates</a><br/>
<br/>
<h1>fetchStates</h1>
<a name="api.APIServer$fetchStates(kotlin.collections.List((core.StateRef)))"></a>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">fetchStates</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$fetchStates(kotlin.collections.List((core.StateRef)))/states">states</span><span class="symbol">:</span>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../core/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol">&lt;</span><a href="../../core/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">,</span>&nbsp;<a href="../../core/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">?</span><span class="symbol">&gt;</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

21
docs/build/html/api/api/-a-p-i-server/fetch-transactions.html vendored Normal file
View File

@ -0,0 +1,21 @@
<HTML>
<HEAD>
<title>APIServer.fetchTransactions - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServer</a>&nbsp;/&nbsp;<a href=".">fetchTransactions</a><br/>
<br/>
<h1>fetchTransactions</h1>
<a name="api.APIServer$fetchTransactions(kotlin.collections.List((core.crypto.SecureHash)))"></a>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">fetchTransactions</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$fetchTransactions(kotlin.collections.List((core.crypto.SecureHash)))/txs">txs</span><span class="symbol">:</span>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol">&lt;</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">,</span>&nbsp;<a href="../../core/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a><span class="symbol">?</span><span class="symbol">&gt;</span></code><br/>
<p>Query for immutable transactions (results can be cached indefinitely by their id/hash).</p>
<h3>Parameters</h3>
<a name="txs"></a>
<code>txs</code> - The hashes (from <a href="../../core/-state-ref/txhash.html">StateRef.txhash</a> returned from <a href="query-states.html">queryStates</a>) you would like full transactions for.<br/>
<strong>Return</strong><br/>
null values indicate missing transactions from the requested list.<br/>
<br/>
<br/>
</BODY>
</HTML>

16
docs/build/html/api/api/-a-p-i-server/generate-transaction-signature.html vendored Normal file
View File

@ -0,0 +1,16 @@
<HTML>
<HEAD>
<title>APIServer.generateTransactionSignature - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServer</a>&nbsp;/&nbsp;<a href=".">generateTransactionSignature</a><br/>
<br/>
<h1>generateTransactionSignature</h1>
<a name="api.APIServer$generateTransactionSignature(core.serialization.SerializedBytes((core.WireTransaction)))"></a>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">generateTransactionSignature</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$generateTransactionSignature(core.serialization.SerializedBytes((core.WireTransaction)))/tx">tx</span><span class="symbol">:</span>&nbsp;<a href="../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol">&lt;</span><a href="../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.crypto/-digital-signature/-with-key/index.html"><span class="identifier">WithKey</span></a></code><br/>
<p>Generate a signature for this transaction signed by us.</p>
<br/>
<br/>
</BODY>
</HTML>

109
docs/build/html/api/api/-a-p-i-server/index.html vendored Normal file
View File

@ -0,0 +1,109 @@
<HTML>
<HEAD>
<title>APIServer - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href=".">APIServer</a><br/>
<br/>
<h1>APIServer</h1>
<code><span class="keyword">interface </span><span class="identifier">APIServer</span></code><br/>
<p>Top level interface to external interaction with the distributed ledger.</p>
<p>Wherever a list is returned by a fetchXXX method that corresponds with an input list, that output list will have optional elements
where a null indicates "missing" and the elements returned will be in the order corresponding with the input list.</p>
<br/>
<br/>
<br/>
<br/>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
<a href="build-transaction.html">buildTransaction</a></td>
<td>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">buildTransaction</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$buildTransaction(api.ContractDefRef, kotlin.collections.List((api.TransactionBuildStep)))/type">type</span><span class="symbol">:</span>&nbsp;<a href="../-contract-def-ref.html"><span class="identifier">ContractDefRef</span></a><span class="symbol">, </span><span class="identifier" id="api.APIServer$buildTransaction(api.ContractDefRef, kotlin.collections.List((api.TransactionBuildStep)))/steps">steps</span><span class="symbol">:</span>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../-transaction-build-step/index.html"><span class="identifier">TransactionBuildStep</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol">&lt;</span><a href="../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">&gt;</span></code><p>TransactionBuildSteps would be invocations of contract.generateXXX() methods that all share a common TransactionBuilder
and a common contract type (e.g. Cash or CommercialPaper)
which would automatically be passed as the first argument (wed need that to be a criteria/pattern of the generateXXX methods).</p>
</td>
</tr>
<tr>
<td>
<a href="commit-transaction.html">commitTransaction</a></td>
<td>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">commitTransaction</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$commitTransaction(core.serialization.SerializedBytes((core.WireTransaction)), kotlin.collections.List((core.crypto.DigitalSignature.WithKey)))/tx">tx</span><span class="symbol">:</span>&nbsp;<a href="../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol">&lt;</span><a href="../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier" id="api.APIServer$commitTransaction(core.serialization.SerializedBytes((core.WireTransaction)), kotlin.collections.List((core.crypto.DigitalSignature.WithKey)))/signatures">signatures</span><span class="symbol">:</span>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../core.crypto/-digital-signature/-with-key/index.html"><span class="identifier">WithKey</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><p>Attempt to commit transaction (returned from build transaction) with the necessary signatures for that to be
successful, otherwise exception is thrown.</p>
</td>
</tr>
<tr>
<td>
<a href="fetch-protocols-requiring-attention.html">fetchProtocolsRequiringAttention</a></td>
<td>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">fetchProtocolsRequiringAttention</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$fetchProtocolsRequiringAttention(api.StatesQuery)/query">query</span><span class="symbol">:</span>&nbsp;<a href="../-states-query/index.html"><span class="identifier">StatesQuery</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol">&lt;</span><a href="../../core/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">,</span>&nbsp;<a href="../-protocol-requiring-attention/index.html"><span class="identifier">ProtocolRequiringAttention</span></a><span class="symbol">&gt;</span></code><p>Fetch protocols that require a response to some prompt/question by a human (on the "bank" side).</p>
</td>
</tr>
<tr>
<td>
<a href="fetch-states.html">fetchStates</a></td>
<td>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">fetchStates</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$fetchStates(kotlin.collections.List((core.StateRef)))/states">states</span><span class="symbol">:</span>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../core/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol">&lt;</span><a href="../../core/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">,</span>&nbsp;<a href="../../core/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">?</span><span class="symbol">&gt;</span></code></td>
</tr>
<tr>
<td>
<a href="fetch-transactions.html">fetchTransactions</a></td>
<td>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">fetchTransactions</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$fetchTransactions(kotlin.collections.List((core.crypto.SecureHash)))/txs">txs</span><span class="symbol">:</span>&nbsp;<span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol">&lt;</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">,</span>&nbsp;<a href="../../core/-signed-transaction/index.html"><span class="identifier">SignedTransaction</span></a><span class="symbol">?</span><span class="symbol">&gt;</span></code><p>Query for immutable transactions (results can be cached indefinitely by their id/hash).</p>
</td>
</tr>
<tr>
<td>
<a href="generate-transaction-signature.html">generateTransactionSignature</a></td>
<td>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">generateTransactionSignature</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$generateTransactionSignature(core.serialization.SerializedBytes((core.WireTransaction)))/tx">tx</span><span class="symbol">:</span>&nbsp;<a href="../../core.serialization/-serialized-bytes/index.html"><span class="identifier">SerializedBytes</span></a><span class="symbol">&lt;</span><a href="../../core/-wire-transaction/index.html"><span class="identifier">WireTransaction</span></a><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../core.crypto/-digital-signature/-with-key/index.html"><span class="identifier">WithKey</span></a></code><p>Generate a signature for this transaction signed by us.</p>
</td>
</tr>
<tr>
<td>
<a href="invoke-protocol-sync.html">invokeProtocolSync</a></td>
<td>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">invokeProtocolSync</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$invokeProtocolSync(api.ProtocolRef, kotlin.collections.Map((kotlin.String, kotlin.Any)))/type">type</span><span class="symbol">:</span>&nbsp;<a href="../-protocol-ref.html"><span class="identifier">ProtocolRef</span></a><span class="symbol">, </span><span class="identifier" id="api.APIServer$invokeProtocolSync(api.ProtocolRef, kotlin.collections.Map((kotlin.String, kotlin.Any)))/args">args</span><span class="symbol">:</span>&nbsp;<span class="identifier">Map</span><span class="symbol">&lt;</span><span class="identifier">String</span><span class="symbol">,</span>&nbsp;<span class="identifier">Any</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Any</span><span class="symbol">?</span></code><p>This method would not return until the protocol is finished (hence the "Sync").</p>
</td>
</tr>
<tr>
<td>
<a href="provide-protocol-response.html">provideProtocolResponse</a></td>
<td>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">provideProtocolResponse</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$provideProtocolResponse(api.ProtocolInstanceRef, core.crypto.SecureHash, kotlin.collections.Map((kotlin.String, kotlin.Any)))/protocol">protocol</span><span class="symbol">:</span>&nbsp;<a href="../-protocol-instance-ref/index.html"><span class="identifier">ProtocolInstanceRef</span></a><span class="symbol">, </span><span class="identifier" id="api.APIServer$provideProtocolResponse(api.ProtocolInstanceRef, core.crypto.SecureHash, kotlin.collections.Map((kotlin.String, kotlin.Any)))/choice">choice</span><span class="symbol">:</span>&nbsp;<a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">, </span><span class="identifier" id="api.APIServer$provideProtocolResponse(api.ProtocolInstanceRef, core.crypto.SecureHash, kotlin.collections.Map((kotlin.String, kotlin.Any)))/args">args</span><span class="symbol">:</span>&nbsp;<span class="identifier">Map</span><span class="symbol">&lt;</span><span class="identifier">String</span><span class="symbol">,</span>&nbsp;<span class="identifier">Any</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>Provide the response that a protocol is waiting for.</p>
</td>
</tr>
<tr>
<td>
<a href="query-states.html">queryStates</a></td>
<td>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">queryStates</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$queryStates(api.StatesQuery)/query">query</span><span class="symbol">:</span>&nbsp;<a href="../-states-query/index.html"><span class="identifier">StatesQuery</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../core/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">&gt;</span></code><p>Query your "local" states (containing only outputs involving you) and return the hashes &amp; indexes associated with them
to probably be later inflated by fetchLedgerTransactions() or fetchStates() although because immutable you can cache them
to avoid calling fetchLedgerTransactions() many times.</p>
</td>
</tr>
<tr>
<td>
<a href="server-time.html">serverTime</a></td>
<td>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">serverTime</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/time/LocalDateTime.html"><span class="identifier">LocalDateTime</span></a></code><p>Report current UTC time as understood by the platform.</p>
</td>
</tr>
</tbody>
</table>
<h3>Inheritors</h3>
<table>
<tbody>
<tr>
<td>
<a href="../-a-p-i-server-impl/index.html">APIServerImpl</a></td>
<td>
<code><span class="keyword">class </span><span class="identifier">APIServerImpl</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">APIServer</span></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

21
docs/build/html/api/api/-a-p-i-server/invoke-protocol-sync.html vendored Normal file
View File

@ -0,0 +1,21 @@
<HTML>
<HEAD>
<title>APIServer.invokeProtocolSync - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServer</a>&nbsp;/&nbsp;<a href=".">invokeProtocolSync</a><br/>
<br/>
<h1>invokeProtocolSync</h1>
<a name="api.APIServer$invokeProtocolSync(api.ProtocolRef, kotlin.collections.Map((kotlin.String, kotlin.Any)))"></a>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">invokeProtocolSync</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$invokeProtocolSync(api.ProtocolRef, kotlin.collections.Map((kotlin.String, kotlin.Any)))/type">type</span><span class="symbol">:</span>&nbsp;<a href="../-protocol-ref.html"><span class="identifier">ProtocolRef</span></a><span class="symbol">, </span><span class="identifier" id="api.APIServer$invokeProtocolSync(api.ProtocolRef, kotlin.collections.Map((kotlin.String, kotlin.Any)))/args">args</span><span class="symbol">:</span>&nbsp;<span class="identifier">Map</span><span class="symbol">&lt;</span><span class="identifier">String</span><span class="symbol">,</span>&nbsp;<span class="identifier">Any</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Any</span><span class="symbol">?</span></code><br/>
<p>This method would not return until the protocol is finished (hence the "Sync").</p>
<p>Longer term wed add an Async version that returns some kind of ProtocolInvocationRef that could be queried and
would appear on some kind of event message that is broadcast informing of progress.</p>
<p>Will throw exception if protocol fails.</p>
<br/>
<br/>
<br/>
<br/>
</BODY>
</HTML>

28
docs/build/html/api/api/-a-p-i-server/provide-protocol-response.html vendored Normal file
View File

@ -0,0 +1,28 @@
<HTML>
<HEAD>
<title>APIServer.provideProtocolResponse - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServer</a>&nbsp;/&nbsp;<a href=".">provideProtocolResponse</a><br/>
<br/>
<h1>provideProtocolResponse</h1>
<a name="api.APIServer$provideProtocolResponse(api.ProtocolInstanceRef, core.crypto.SecureHash, kotlin.collections.Map((kotlin.String, kotlin.Any)))"></a>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">provideProtocolResponse</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$provideProtocolResponse(api.ProtocolInstanceRef, core.crypto.SecureHash, kotlin.collections.Map((kotlin.String, kotlin.Any)))/protocol">protocol</span><span class="symbol">:</span>&nbsp;<a href="../-protocol-instance-ref/index.html"><span class="identifier">ProtocolInstanceRef</span></a><span class="symbol">, </span><span class="identifier" id="api.APIServer$provideProtocolResponse(api.ProtocolInstanceRef, core.crypto.SecureHash, kotlin.collections.Map((kotlin.String, kotlin.Any)))/choice">choice</span><span class="symbol">:</span>&nbsp;<a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">, </span><span class="identifier" id="api.APIServer$provideProtocolResponse(api.ProtocolInstanceRef, core.crypto.SecureHash, kotlin.collections.Map((kotlin.String, kotlin.Any)))/args">args</span><span class="symbol">:</span>&nbsp;<span class="identifier">Map</span><span class="symbol">&lt;</span><span class="identifier">String</span><span class="symbol">,</span>&nbsp;<span class="identifier">Any</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
<p>Provide the response that a protocol is waiting for.</p>
<h3>Parameters</h3>
<a name="protocol"></a>
<code>protocol</code> - Should refer to a previously supplied ProtocolRequiringAttention.<br/>
<br/>
<a name="stepId"></a>
<code>stepId</code> - Which step of the protocol are we referring too.<br/>
<br/>
<a name="choice"></a>
<code>choice</code> - Should be one of the choices presented in the ProtocolRequiringAttention.<br/>
<br/>
<a name="args"></a>
<code>args</code> - Any arguments required.<br/>
<br/>
<br/>
</BODY>
</HTML>

23
docs/build/html/api/api/-a-p-i-server/query-states.html vendored Normal file
View File

@ -0,0 +1,23 @@
<HTML>
<HEAD>
<title>APIServer.queryStates - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServer</a>&nbsp;/&nbsp;<a href=".">queryStates</a><br/>
<br/>
<h1>queryStates</h1>
<a name="api.APIServer$queryStates(api.StatesQuery)"></a>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">queryStates</span><span class="symbol">(</span><span class="identifier" id="api.APIServer$queryStates(api.StatesQuery)/query">query</span><span class="symbol">:</span>&nbsp;<a href="../-states-query/index.html"><span class="identifier">StatesQuery</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol">&lt;</span><a href="../../core/-state-ref/index.html"><span class="identifier">StateRef</span></a><span class="symbol">&gt;</span></code><br/>
<p>Query your "local" states (containing only outputs involving you) and return the hashes &amp; indexes associated with them
to probably be later inflated by fetchLedgerTransactions() or fetchStates() although because immutable you can cache them
to avoid calling fetchLedgerTransactions() many times.</p>
<h3>Parameters</h3>
<a name="query"></a>
<code>query</code> - Some "where clause" like expression.<br/>
<strong>Return</strong><br/>
Zero or more matching States.<br/>
<br/>
<br/>
</BODY>
</HTML>

16
docs/build/html/api/api/-a-p-i-server/server-time.html vendored Normal file
View File

@ -0,0 +1,16 @@
<HTML>
<HEAD>
<title>APIServer.serverTime - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">APIServer</a>&nbsp;/&nbsp;<a href=".">serverTime</a><br/>
<br/>
<h1>serverTime</h1>
<a name="api.APIServer$serverTime()"></a>
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">serverTime</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/time/LocalDateTime.html"><span class="identifier">LocalDateTime</span></a></code><br/>
<p>Report current UTC time as understood by the platform.</p>
<br/>
<br/>
</BODY>
</HTML>

16
docs/build/html/api/api/-config/-init-.html vendored Normal file
View File

@ -0,0 +1,16 @@
<HTML>
<HEAD>
<title>Config.<init> - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">Config</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<code><span class="identifier">Config</span><span class="symbol">(</span><span class="identifier" id="api.Config$<init>(core.node.ServiceHub)/services">services</span><span class="symbol">:</span>&nbsp;<a href="../../core.node/-service-hub/index.html"><span class="identifier">ServiceHub</span></a><span class="symbol">)</span></code><br/>
<p>Primary purpose is to install Kotlin extensions for Jackson ObjectMapper so data classes work
and to organise serializers / deserializers for java.time.* classes as necessary</p>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-config/default-object-mapper.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>Config.defaultObjectMapper - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">Config</a>&nbsp;/&nbsp;<a href=".">defaultObjectMapper</a><br/>
<br/>
<h1>defaultObjectMapper</h1>
<a name="api.Config$defaultObjectMapper"></a>
<code><span class="keyword">val </span><span class="identifier">defaultObjectMapper</span><span class="symbol">: </span><span class="identifier">&lt;ERROR CLASS&gt;</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-config/get-context.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>Config.getContext - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">Config</a>&nbsp;/&nbsp;<a href=".">getContext</a><br/>
<br/>
<h1>getContext</h1>
<a name="api.Config$getContext(java.lang.Class((kotlin.Any)))"></a>
<code><span class="keyword">fun </span><span class="identifier">getContext</span><span class="symbol">(</span><span class="identifier" id="api.Config$getContext(java.lang.Class((kotlin.Any)))/type">type</span><span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html"><span class="identifier">Class</span></a><span class="symbol">&lt;</span><span class="identifier">*</span><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">&lt;ERROR CLASS&gt;</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

57
docs/build/html/api/api/-config/index.html vendored Normal file
View File

@ -0,0 +1,57 @@
<HTML>
<HEAD>
<title>Config - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href=".">Config</a><br/>
<br/>
<h1>Config</h1>
<code><span class="keyword">class </span><span class="identifier">Config</span></code><br/>
<p>Primary purpose is to install Kotlin extensions for Jackson ObjectMapper so data classes work
and to organise serializers / deserializers for java.time.* classes as necessary</p>
<br/>
<br/>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-init-.html">&lt;init&gt;</a></td>
<td>
<code><span class="identifier">Config</span><span class="symbol">(</span><span class="identifier" id="api.Config$<init>(core.node.ServiceHub)/services">services</span><span class="symbol">:</span>&nbsp;<a href="../../core.node/-service-hub/index.html"><span class="identifier">ServiceHub</span></a><span class="symbol">)</span></code><p>Primary purpose is to install Kotlin extensions for Jackson ObjectMapper so data classes work
and to organise serializers / deserializers for java.time.* classes as necessary</p>
</td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<a href="default-object-mapper.html">defaultObjectMapper</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">defaultObjectMapper</span><span class="symbol">: </span><span class="identifier">&lt;ERROR CLASS&gt;</span></code></td>
</tr>
<tr>
<td>
<a href="services.html">services</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">services</span><span class="symbol">: </span><a href="../../core.node/-service-hub/index.html"><span class="identifier">ServiceHub</span></a></code></td>
</tr>
</tbody>
</table>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
<a href="get-context.html">getContext</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">getContext</span><span class="symbol">(</span><span class="identifier" id="api.Config$getContext(java.lang.Class((kotlin.Any)))/type">type</span><span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html"><span class="identifier">Class</span></a><span class="symbol">&lt;</span><span class="identifier">*</span><span class="symbol">&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">&lt;ERROR CLASS&gt;</span></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

15
docs/build/html/api/api/-config/services.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>Config.services - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">Config</a>&nbsp;/&nbsp;<a href=".">services</a><br/>
<br/>
<h1>services</h1>
<a name="api.Config$services"></a>
<code><span class="keyword">val </span><span class="identifier">services</span><span class="symbol">: </span><a href="../../core.node/-service-hub/index.html"><span class="identifier">ServiceHub</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

14
docs/build/html/api/api/-contract-class-ref/-init-.html vendored Normal file
View File

@ -0,0 +1,14 @@
<HTML>
<HEAD>
<title>ContractClassRef.<init> - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">ContractClassRef</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<code><span class="identifier">ContractClassRef</span><span class="symbol">(</span><span class="identifier" id="api.ContractClassRef$<init>(kotlin.String)/className">className</span><span class="symbol">:</span>&nbsp;<span class="identifier">String</span><span class="symbol">)</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-contract-class-ref/class-name.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>ContractClassRef.className - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">ContractClassRef</a>&nbsp;/&nbsp;<a href=".">className</a><br/>
<br/>
<h1>className</h1>
<a name="api.ContractClassRef$className"></a>
<code><span class="keyword">val </span><span class="identifier">className</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

36
docs/build/html/api/api/-contract-class-ref/index.html vendored Normal file
View File

@ -0,0 +1,36 @@
<HTML>
<HEAD>
<title>ContractClassRef - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href=".">ContractClassRef</a><br/>
<br/>
<h1>ContractClassRef</h1>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">ContractClassRef</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../-contract-def-ref.html"><span class="identifier">ContractDefRef</span></a></code><br/>
<br/>
<br/>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-init-.html">&lt;init&gt;</a></td>
<td>
<code><span class="identifier">ContractClassRef</span><span class="symbol">(</span><span class="identifier" id="api.ContractClassRef$<init>(kotlin.String)/className">className</span><span class="symbol">:</span>&nbsp;<span class="identifier">String</span><span class="symbol">)</span></code></td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<a href="class-name.html">className</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">className</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

32
docs/build/html/api/api/-contract-def-ref.html vendored Normal file
View File

@ -0,0 +1,32 @@
<HTML>
<HEAD>
<title>ContractDefRef - </title>
<link rel="stylesheet" href="../style.css">
</HEAD>
<BODY>
<a href="index.html">api</a>&nbsp;/&nbsp;<a href=".">ContractDefRef</a><br/>
<br/>
<h1>ContractDefRef</h1>
<code><span class="keyword">interface </span><span class="identifier">ContractDefRef</span></code><br/>
<p>Encapsulates the contract type. e.g. Cash or CommercialPaper etc.</p>
<br/>
<br/>
<h3>Inheritors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-contract-class-ref/index.html">ContractClassRef</a></td>
<td>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">ContractClassRef</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">ContractDefRef</span></code></td>
</tr>
<tr>
<td>
<a href="-contract-ledger-ref/index.html">ContractLedgerRef</a></td>
<td>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">ContractLedgerRef</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">ContractDefRef</span></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

14
docs/build/html/api/api/-contract-ledger-ref/-init-.html vendored Normal file
View File

@ -0,0 +1,14 @@
<HTML>
<HEAD>
<title>ContractLedgerRef.<init> - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">ContractLedgerRef</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<code><span class="identifier">ContractLedgerRef</span><span class="symbol">(</span><span class="identifier" id="api.ContractLedgerRef$<init>(core.crypto.SecureHash)/hash">hash</span><span class="symbol">:</span>&nbsp;<a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">)</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-contract-ledger-ref/hash.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>ContractLedgerRef.hash - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">ContractLedgerRef</a>&nbsp;/&nbsp;<a href=".">hash</a><br/>
<br/>
<h1>hash</h1>
<a name="api.ContractLedgerRef$hash"></a>
<code><span class="keyword">val </span><span class="identifier">hash</span><span class="symbol">: </span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

36
docs/build/html/api/api/-contract-ledger-ref/index.html vendored Normal file
View File

@ -0,0 +1,36 @@
<HTML>
<HEAD>
<title>ContractLedgerRef - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href=".">ContractLedgerRef</a><br/>
<br/>
<h1>ContractLedgerRef</h1>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">ContractLedgerRef</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../-contract-def-ref.html"><span class="identifier">ContractDefRef</span></a></code><br/>
<br/>
<br/>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-init-.html">&lt;init&gt;</a></td>
<td>
<code><span class="identifier">ContractLedgerRef</span><span class="symbol">(</span><span class="identifier" id="api.ContractLedgerRef$<init>(core.crypto.SecureHash)/hash">hash</span><span class="symbol">:</span>&nbsp;<a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">)</span></code></td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<a href="hash.html">hash</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">hash</span><span class="symbol">: </span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

28
docs/build/html/api/api/-interest-rate-swap-a-p-i/-init-.html vendored Normal file
View File

@ -0,0 +1,28 @@
<HTML>
<HEAD>
<title>InterestRateSwapAPI.<init> - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">InterestRateSwapAPI</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<code><span class="identifier">InterestRateSwapAPI</span><span class="symbol">(</span><span class="identifier" id="api.InterestRateSwapAPI$<init>(api.APIServer)/api">api</span><span class="symbol">:</span>&nbsp;<a href="../-a-p-i-server/index.html"><span class="identifier">APIServer</span></a><span class="symbol">)</span></code><br/>
<p>This provides a simplified API, currently for demonstration use only.</p>
<p>It provides several JSON REST calls as follows:</p>
<p>GET /api/irs/deals - returns an array of all deals tracked by the wallet of this node.
GET /api/irs/deals/{ref} - return the deal referenced by the externally provided refence that was previously uploaded.
POST /api/irs/deals - Payload is a JSON formatted <a href="../../contracts/-interest-rate-swap/-state/index.html">InterestRateSwap.State</a> create a new deal (includes an externally provided reference for use above).</p>
<p>TODO: where we currently refer to singular external deal reference, of course this could easily be multiple identifiers e.g. CUSIP, ISIN.</p>
<p>GET /api/irs/demodate - return the current date as viewed by the system in YYYY-MM-DD format.
PUT /api/irs/demodate - put date in format YYYY-MM-DD to advance the current date as viewed by the system and
simulate any associated business processing (currently fixing).</p>
<p>TODO: replace simulated date advancement with business event based implementation</p>
<p>PUT /api/irs/restart - (empty payload) cause the node to restart for API user emergency use in case any servers become unresponsive,
or if the demodate or population of deals should be reset (will only work while persistence is disabled).</p>
<br/>
<br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-interest-rate-swap-a-p-i/api.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>InterestRateSwapAPI.api - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">InterestRateSwapAPI</a>&nbsp;/&nbsp;<a href=".">api</a><br/>
<br/>
<h1>api</h1>
<a name="api.InterestRateSwapAPI$api"></a>
<code><span class="keyword">val </span><span class="identifier">api</span><span class="symbol">: </span><a href="../-a-p-i-server/index.html"><span class="identifier">APIServer</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-interest-rate-swap-a-p-i/exit-server.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>InterestRateSwapAPI.exitServer - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">InterestRateSwapAPI</a>&nbsp;/&nbsp;<a href=".">exitServer</a><br/>
<br/>
<h1>exitServer</h1>
<a name="api.InterestRateSwapAPI$exitServer()"></a>
<code><span class="keyword">fun </span><span class="identifier">exitServer</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">&lt;ERROR CLASS&gt;</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-interest-rate-swap-a-p-i/fetch-deal.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>InterestRateSwapAPI.fetchDeal - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">InterestRateSwapAPI</a>&nbsp;/&nbsp;<a href=".">fetchDeal</a><br/>
<br/>
<h1>fetchDeal</h1>
<a name="api.InterestRateSwapAPI$fetchDeal(kotlin.String)"></a>
<code><span class="keyword">fun </span><span class="identifier">fetchDeal</span><span class="symbol">(</span><span class="identifier" id="api.InterestRateSwapAPI$fetchDeal(kotlin.String)/ref">ref</span><span class="symbol">:</span>&nbsp;<span class="identifier">String</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">&lt;ERROR CLASS&gt;</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-interest-rate-swap-a-p-i/fetch-deals.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>InterestRateSwapAPI.fetchDeals - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">InterestRateSwapAPI</a>&nbsp;/&nbsp;<a href=".">fetchDeals</a><br/>
<br/>
<h1>fetchDeals</h1>
<a name="api.InterestRateSwapAPI$fetchDeals()"></a>
<code><span class="keyword">fun </span><span class="identifier">fetchDeals</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Array</span><span class="symbol">&lt;</span><a href="../../contracts/-interest-rate-swap/-state/index.html"><span class="identifier">State</span></a><span class="symbol">&gt;</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-interest-rate-swap-a-p-i/fetch-demo-date.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>InterestRateSwapAPI.fetchDemoDate - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">InterestRateSwapAPI</a>&nbsp;/&nbsp;<a href=".">fetchDemoDate</a><br/>
<br/>
<h1>fetchDemoDate</h1>
<a name="api.InterestRateSwapAPI$fetchDemoDate()"></a>
<code><span class="keyword">fun </span><span class="identifier">fetchDemoDate</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/time/LocalDate.html"><span class="identifier">LocalDate</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

92
docs/build/html/api/api/-interest-rate-swap-a-p-i/index.html vendored Normal file
View File

@ -0,0 +1,92 @@
<HTML>
<HEAD>
<title>InterestRateSwapAPI - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href=".">InterestRateSwapAPI</a><br/>
<br/>
<h1>InterestRateSwapAPI</h1>
<code><span class="keyword">class </span><span class="identifier">InterestRateSwapAPI</span></code><br/>
<p>This provides a simplified API, currently for demonstration use only.</p>
<p>It provides several JSON REST calls as follows:</p>
<p>GET /api/irs/deals - returns an array of all deals tracked by the wallet of this node.
GET /api/irs/deals/{ref} - return the deal referenced by the externally provided refence that was previously uploaded.
POST /api/irs/deals - Payload is a JSON formatted <a href="../../contracts/-interest-rate-swap/-state/index.html">InterestRateSwap.State</a> create a new deal (includes an externally provided reference for use above).</p>
<p>TODO: where we currently refer to singular external deal reference, of course this could easily be multiple identifiers e.g. CUSIP, ISIN.</p>
<p>GET /api/irs/demodate - return the current date as viewed by the system in YYYY-MM-DD format.
PUT /api/irs/demodate - put date in format YYYY-MM-DD to advance the current date as viewed by the system and
simulate any associated business processing (currently fixing).</p>
<p>TODO: replace simulated date advancement with business event based implementation</p>
<p>PUT /api/irs/restart - (empty payload) cause the node to restart for API user emergency use in case any servers become unresponsive,
or if the demodate or population of deals should be reset (will only work while persistence is disabled).</p>
<br/>
<br/>
<br/>
<br/>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-init-.html">&lt;init&gt;</a></td>
<td>
<code><span class="identifier">InterestRateSwapAPI</span><span class="symbol">(</span><span class="identifier" id="api.InterestRateSwapAPI$<init>(api.APIServer)/api">api</span><span class="symbol">:</span>&nbsp;<a href="../-a-p-i-server/index.html"><span class="identifier">APIServer</span></a><span class="symbol">)</span></code><p>This provides a simplified API, currently for demonstration use only.</p>
</td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<a href="api.html">api</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">api</span><span class="symbol">: </span><a href="../-a-p-i-server/index.html"><span class="identifier">APIServer</span></a></code></td>
</tr>
</tbody>
</table>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
<a href="exit-server.html">exitServer</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">exitServer</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">&lt;ERROR CLASS&gt;</span></code></td>
</tr>
<tr>
<td>
<a href="fetch-deal.html">fetchDeal</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">fetchDeal</span><span class="symbol">(</span><span class="identifier" id="api.InterestRateSwapAPI$fetchDeal(kotlin.String)/ref">ref</span><span class="symbol">:</span>&nbsp;<span class="identifier">String</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">&lt;ERROR CLASS&gt;</span></code></td>
</tr>
<tr>
<td>
<a href="fetch-deals.html">fetchDeals</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">fetchDeals</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Array</span><span class="symbol">&lt;</span><a href="../../contracts/-interest-rate-swap/-state/index.html"><span class="identifier">State</span></a><span class="symbol">&gt;</span></code></td>
</tr>
<tr>
<td>
<a href="fetch-demo-date.html">fetchDemoDate</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">fetchDemoDate</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/time/LocalDate.html"><span class="identifier">LocalDate</span></a></code></td>
</tr>
<tr>
<td>
<a href="store-deal.html">storeDeal</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">storeDeal</span><span class="symbol">(</span><span class="identifier" id="api.InterestRateSwapAPI$storeDeal(contracts.InterestRateSwap.State)/newDeal">newDeal</span><span class="symbol">:</span>&nbsp;<a href="../../contracts/-interest-rate-swap/-state/index.html"><span class="identifier">State</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">&lt;ERROR CLASS&gt;</span></code></td>
</tr>
<tr>
<td>
<a href="store-demo-date.html">storeDemoDate</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">storeDemoDate</span><span class="symbol">(</span><span class="identifier" id="api.InterestRateSwapAPI$storeDemoDate(java.time.LocalDate)/newDemoDate">newDemoDate</span><span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/time/LocalDate.html"><span class="identifier">LocalDate</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">&lt;ERROR CLASS&gt;</span></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

15
docs/build/html/api/api/-interest-rate-swap-a-p-i/store-deal.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>InterestRateSwapAPI.storeDeal - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">InterestRateSwapAPI</a>&nbsp;/&nbsp;<a href=".">storeDeal</a><br/>
<br/>
<h1>storeDeal</h1>
<a name="api.InterestRateSwapAPI$storeDeal(contracts.InterestRateSwap.State)"></a>
<code><span class="keyword">fun </span><span class="identifier">storeDeal</span><span class="symbol">(</span><span class="identifier" id="api.InterestRateSwapAPI$storeDeal(contracts.InterestRateSwap.State)/newDeal">newDeal</span><span class="symbol">:</span>&nbsp;<a href="../../contracts/-interest-rate-swap/-state/index.html"><span class="identifier">State</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">&lt;ERROR CLASS&gt;</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-interest-rate-swap-a-p-i/store-demo-date.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>InterestRateSwapAPI.storeDemoDate - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">InterestRateSwapAPI</a>&nbsp;/&nbsp;<a href=".">storeDemoDate</a><br/>
<br/>
<h1>storeDemoDate</h1>
<a name="api.InterestRateSwapAPI$storeDemoDate(java.time.LocalDate)"></a>
<code><span class="keyword">fun </span><span class="identifier">storeDemoDate</span><span class="symbol">(</span><span class="identifier" id="api.InterestRateSwapAPI$storeDemoDate(java.time.LocalDate)/newDemoDate">newDemoDate</span><span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/time/LocalDate.html"><span class="identifier">LocalDate</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">&lt;ERROR CLASS&gt;</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

14
docs/build/html/api/api/-protocol-class-ref/-init-.html vendored Normal file
View File

@ -0,0 +1,14 @@
<HTML>
<HEAD>
<title>ProtocolClassRef.<init> - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">ProtocolClassRef</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<code><span class="identifier">ProtocolClassRef</span><span class="symbol">(</span><span class="identifier" id="api.ProtocolClassRef$<init>(kotlin.String)/className">className</span><span class="symbol">:</span>&nbsp;<span class="identifier">String</span><span class="symbol">)</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-protocol-class-ref/class-name.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>ProtocolClassRef.className - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">ProtocolClassRef</a>&nbsp;/&nbsp;<a href=".">className</a><br/>
<br/>
<h1>className</h1>
<a name="api.ProtocolClassRef$className"></a>
<code><span class="keyword">val </span><span class="identifier">className</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

36
docs/build/html/api/api/-protocol-class-ref/index.html vendored Normal file
View File

@ -0,0 +1,36 @@
<HTML>
<HEAD>
<title>ProtocolClassRef - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href=".">ProtocolClassRef</a><br/>
<br/>
<h1>ProtocolClassRef</h1>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">ProtocolClassRef</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../-protocol-ref.html"><span class="identifier">ProtocolRef</span></a></code><br/>
<br/>
<br/>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-init-.html">&lt;init&gt;</a></td>
<td>
<code><span class="identifier">ProtocolClassRef</span><span class="symbol">(</span><span class="identifier" id="api.ProtocolClassRef$<init>(kotlin.String)/className">className</span><span class="symbol">:</span>&nbsp;<span class="identifier">String</span><span class="symbol">)</span></code></td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<a href="class-name.html">className</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">className</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

14
docs/build/html/api/api/-protocol-instance-ref/-init-.html vendored Normal file
View File

@ -0,0 +1,14 @@
<HTML>
<HEAD>
<title>ProtocolInstanceRef.<init> - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">ProtocolInstanceRef</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<code><span class="identifier">ProtocolInstanceRef</span><span class="symbol">(</span><span class="identifier" id="api.ProtocolInstanceRef$<init>(core.crypto.SecureHash, api.ProtocolClassRef, kotlin.String)/protocolInstance">protocolInstance</span><span class="symbol">:</span>&nbsp;<a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">, </span><span class="identifier" id="api.ProtocolInstanceRef$<init>(core.crypto.SecureHash, api.ProtocolClassRef, kotlin.String)/protocolClass">protocolClass</span><span class="symbol">:</span>&nbsp;<a href="../-protocol-class-ref/index.html"><span class="identifier">ProtocolClassRef</span></a><span class="symbol">, </span><span class="identifier" id="api.ProtocolInstanceRef$<init>(core.crypto.SecureHash, api.ProtocolClassRef, kotlin.String)/protocolStepId">protocolStepId</span><span class="symbol">:</span>&nbsp;<span class="identifier">String</span><span class="symbol">)</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

48
docs/build/html/api/api/-protocol-instance-ref/index.html vendored Normal file
View File

@ -0,0 +1,48 @@
<HTML>
<HEAD>
<title>ProtocolInstanceRef - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href=".">ProtocolInstanceRef</a><br/>
<br/>
<h1>ProtocolInstanceRef</h1>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">ProtocolInstanceRef</span></code><br/>
<br/>
<br/>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-init-.html">&lt;init&gt;</a></td>
<td>
<code><span class="identifier">ProtocolInstanceRef</span><span class="symbol">(</span><span class="identifier" id="api.ProtocolInstanceRef$<init>(core.crypto.SecureHash, api.ProtocolClassRef, kotlin.String)/protocolInstance">protocolInstance</span><span class="symbol">:</span>&nbsp;<a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">, </span><span class="identifier" id="api.ProtocolInstanceRef$<init>(core.crypto.SecureHash, api.ProtocolClassRef, kotlin.String)/protocolClass">protocolClass</span><span class="symbol">:</span>&nbsp;<a href="../-protocol-class-ref/index.html"><span class="identifier">ProtocolClassRef</span></a><span class="symbol">, </span><span class="identifier" id="api.ProtocolInstanceRef$<init>(core.crypto.SecureHash, api.ProtocolClassRef, kotlin.String)/protocolStepId">protocolStepId</span><span class="symbol">:</span>&nbsp;<span class="identifier">String</span><span class="symbol">)</span></code></td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<a href="protocol-class.html">protocolClass</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">protocolClass</span><span class="symbol">: </span><a href="../-protocol-class-ref/index.html"><span class="identifier">ProtocolClassRef</span></a></code></td>
</tr>
<tr>
<td>
<a href="protocol-instance.html">protocolInstance</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">protocolInstance</span><span class="symbol">: </span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code></td>
</tr>
<tr>
<td>
<a href="protocol-step-id.html">protocolStepId</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">protocolStepId</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

15
docs/build/html/api/api/-protocol-instance-ref/protocol-class.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>ProtocolInstanceRef.protocolClass - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">ProtocolInstanceRef</a>&nbsp;/&nbsp;<a href=".">protocolClass</a><br/>
<br/>
<h1>protocolClass</h1>
<a name="api.ProtocolInstanceRef$protocolClass"></a>
<code><span class="keyword">val </span><span class="identifier">protocolClass</span><span class="symbol">: </span><a href="../-protocol-class-ref/index.html"><span class="identifier">ProtocolClassRef</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-protocol-instance-ref/protocol-instance.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>ProtocolInstanceRef.protocolInstance - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">ProtocolInstanceRef</a>&nbsp;/&nbsp;<a href=".">protocolInstance</a><br/>
<br/>
<h1>protocolInstance</h1>
<a name="api.ProtocolInstanceRef$protocolInstance"></a>
<code><span class="keyword">val </span><span class="identifier">protocolInstance</span><span class="symbol">: </span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-protocol-instance-ref/protocol-step-id.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>ProtocolInstanceRef.protocolStepId - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">ProtocolInstanceRef</a>&nbsp;/&nbsp;<a href=".">protocolStepId</a><br/>
<br/>
<h1>protocolStepId</h1>
<a name="api.ProtocolInstanceRef$protocolStepId"></a>
<code><span class="keyword">val </span><span class="identifier">protocolStepId</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

26
docs/build/html/api/api/-protocol-ref.html vendored Normal file
View File

@ -0,0 +1,26 @@
<HTML>
<HEAD>
<title>ProtocolRef - </title>
<link rel="stylesheet" href="../style.css">
</HEAD>
<BODY>
<a href="index.html">api</a>&nbsp;/&nbsp;<a href=".">ProtocolRef</a><br/>
<br/>
<h1>ProtocolRef</h1>
<code><span class="keyword">interface </span><span class="identifier">ProtocolRef</span></code><br/>
<p>Encapsulates the protocol to be instantiated. e.g. TwoPartyTradeProtocol.Buyer.</p>
<br/>
<br/>
<h3>Inheritors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-protocol-class-ref/index.html">ProtocolClassRef</a></td>
<td>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">ProtocolClassRef</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">ProtocolRef</span></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

15
docs/build/html/api/api/-protocol-requiring-attention/-init-.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>ProtocolRequiringAttention.<init> - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">ProtocolRequiringAttention</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<code><span class="identifier">ProtocolRequiringAttention</span><span class="symbol">(</span><span class="identifier" id="api.ProtocolRequiringAttention$<init>(api.ProtocolInstanceRef, kotlin.String, kotlin.collections.Map((core.crypto.SecureHash, kotlin.String)), java.time.Instant)/ref">ref</span><span class="symbol">:</span>&nbsp;<a href="../-protocol-instance-ref/index.html"><span class="identifier">ProtocolInstanceRef</span></a><span class="symbol">, </span><span class="identifier" id="api.ProtocolRequiringAttention$<init>(api.ProtocolInstanceRef, kotlin.String, kotlin.collections.Map((core.crypto.SecureHash, kotlin.String)), java.time.Instant)/prompt">prompt</span><span class="symbol">:</span>&nbsp;<span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="api.ProtocolRequiringAttention$<init>(api.ProtocolInstanceRef, kotlin.String, kotlin.collections.Map((core.crypto.SecureHash, kotlin.String)), java.time.Instant)/choiceIdsToMessages">choiceIdsToMessages</span><span class="symbol">:</span>&nbsp;<span class="identifier">Map</span><span class="symbol">&lt;</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">,</span>&nbsp;<span class="identifier">String</span><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier" id="api.ProtocolRequiringAttention$<init>(api.ProtocolInstanceRef, kotlin.String, kotlin.collections.Map((core.crypto.SecureHash, kotlin.String)), java.time.Instant)/dueBy">dueBy</span><span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/time/Instant.html"><span class="identifier">Instant</span></a><span class="symbol">)</span></code><br/>
<p>Thinking that Instant is OK for short lived protocol deadlines.</p>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-protocol-requiring-attention/choice-ids-to-messages.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>ProtocolRequiringAttention.choiceIdsToMessages - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">ProtocolRequiringAttention</a>&nbsp;/&nbsp;<a href=".">choiceIdsToMessages</a><br/>
<br/>
<h1>choiceIdsToMessages</h1>
<a name="api.ProtocolRequiringAttention$choiceIdsToMessages"></a>
<code><span class="keyword">val </span><span class="identifier">choiceIdsToMessages</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol">&lt;</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">,</span>&nbsp;<span class="identifier">String</span><span class="symbol">&gt;</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-protocol-requiring-attention/due-by.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>ProtocolRequiringAttention.dueBy - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">ProtocolRequiringAttention</a>&nbsp;/&nbsp;<a href=".">dueBy</a><br/>
<br/>
<h1>dueBy</h1>
<a name="api.ProtocolRequiringAttention$dueBy"></a>
<code><span class="keyword">val </span><span class="identifier">dueBy</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/time/Instant.html"><span class="identifier">Instant</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

56
docs/build/html/api/api/-protocol-requiring-attention/index.html vendored Normal file
View File

@ -0,0 +1,56 @@
<HTML>
<HEAD>
<title>ProtocolRequiringAttention - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href=".">ProtocolRequiringAttention</a><br/>
<br/>
<h1>ProtocolRequiringAttention</h1>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">ProtocolRequiringAttention</span></code><br/>
<p>Thinking that Instant is OK for short lived protocol deadlines.</p>
<br/>
<br/>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-init-.html">&lt;init&gt;</a></td>
<td>
<code><span class="identifier">ProtocolRequiringAttention</span><span class="symbol">(</span><span class="identifier" id="api.ProtocolRequiringAttention$<init>(api.ProtocolInstanceRef, kotlin.String, kotlin.collections.Map((core.crypto.SecureHash, kotlin.String)), java.time.Instant)/ref">ref</span><span class="symbol">:</span>&nbsp;<a href="../-protocol-instance-ref/index.html"><span class="identifier">ProtocolInstanceRef</span></a><span class="symbol">, </span><span class="identifier" id="api.ProtocolRequiringAttention$<init>(api.ProtocolInstanceRef, kotlin.String, kotlin.collections.Map((core.crypto.SecureHash, kotlin.String)), java.time.Instant)/prompt">prompt</span><span class="symbol">:</span>&nbsp;<span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="api.ProtocolRequiringAttention$<init>(api.ProtocolInstanceRef, kotlin.String, kotlin.collections.Map((core.crypto.SecureHash, kotlin.String)), java.time.Instant)/choiceIdsToMessages">choiceIdsToMessages</span><span class="symbol">:</span>&nbsp;<span class="identifier">Map</span><span class="symbol">&lt;</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">,</span>&nbsp;<span class="identifier">String</span><span class="symbol">&gt;</span><span class="symbol">, </span><span class="identifier" id="api.ProtocolRequiringAttention$<init>(api.ProtocolInstanceRef, kotlin.String, kotlin.collections.Map((core.crypto.SecureHash, kotlin.String)), java.time.Instant)/dueBy">dueBy</span><span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/time/Instant.html"><span class="identifier">Instant</span></a><span class="symbol">)</span></code><p>Thinking that Instant is OK for short lived protocol deadlines.</p>
</td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<a href="choice-ids-to-messages.html">choiceIdsToMessages</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">choiceIdsToMessages</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol">&lt;</span><a href="../../core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">,</span>&nbsp;<span class="identifier">String</span><span class="symbol">&gt;</span></code></td>
</tr>
<tr>
<td>
<a href="due-by.html">dueBy</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">dueBy</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/time/Instant.html"><span class="identifier">Instant</span></a></code></td>
</tr>
<tr>
<td>
<a href="prompt.html">prompt</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">prompt</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
</tr>
<tr>
<td>
<a href="ref.html">ref</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">ref</span><span class="symbol">: </span><a href="../-protocol-instance-ref/index.html"><span class="identifier">ProtocolInstanceRef</span></a></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

15
docs/build/html/api/api/-protocol-requiring-attention/prompt.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>ProtocolRequiringAttention.prompt - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">ProtocolRequiringAttention</a>&nbsp;/&nbsp;<a href=".">prompt</a><br/>
<br/>
<h1>prompt</h1>
<a name="api.ProtocolRequiringAttention$prompt"></a>
<code><span class="keyword">val </span><span class="identifier">prompt</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-protocol-requiring-attention/ref.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>ProtocolRequiringAttention.ref - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">ProtocolRequiringAttention</a>&nbsp;/&nbsp;<a href=".">ref</a><br/>
<br/>
<h1>ref</h1>
<a name="api.ProtocolRequiringAttention$ref"></a>
<code><span class="keyword">val </span><span class="identifier">ref</span><span class="symbol">: </span><a href="../-protocol-instance-ref/index.html"><span class="identifier">ProtocolInstanceRef</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-response-filter/-init-.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>ResponseFilter.<init> - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">ResponseFilter</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<code><span class="identifier">ResponseFilter</span><span class="symbol">(</span><span class="symbol">)</span></code><br/>
<p>This adds headers needed for cross site scripting on API clients</p>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-response-filter/filter.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>ResponseFilter.filter - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">ResponseFilter</a>&nbsp;/&nbsp;<a href=".">filter</a><br/>
<br/>
<h1>filter</h1>
<a name="api.ResponseFilter$filter(, )"></a>
<code><span class="keyword">fun </span><span class="identifier">filter</span><span class="symbol">(</span><span class="identifier" id="api.ResponseFilter$filter(, )/requestContext">requestContext</span><span class="symbol">:</span>&nbsp;<span class="identifier">&lt;ERROR CLASS&gt;</span><span class="symbol">, </span><span class="identifier" id="api.ResponseFilter$filter(, )/responseContext">responseContext</span><span class="symbol">:</span>&nbsp;<span class="identifier">&lt;ERROR CLASS&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

38
docs/build/html/api/api/-response-filter/index.html vendored Normal file
View File

@ -0,0 +1,38 @@
<HTML>
<HEAD>
<title>ResponseFilter - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href=".">ResponseFilter</a><br/>
<br/>
<h1>ResponseFilter</h1>
<code><span class="keyword">class </span><span class="identifier">ResponseFilter</span></code><br/>
<p>This adds headers needed for cross site scripting on API clients</p>
<br/>
<br/>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-init-.html">&lt;init&gt;</a></td>
<td>
<code><span class="identifier">ResponseFilter</span><span class="symbol">(</span><span class="symbol">)</span></code><p>This adds headers needed for cross site scripting on API clients</p>
</td>
</tr>
</tbody>
</table>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
<a href="filter.html">filter</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">filter</span><span class="symbol">(</span><span class="identifier" id="api.ResponseFilter$filter(, )/requestContext">requestContext</span><span class="symbol">:</span>&nbsp;<span class="identifier">&lt;ERROR CLASS&gt;</span><span class="symbol">, </span><span class="identifier" id="api.ResponseFilter$filter(, )/responseContext">responseContext</span><span class="symbol">:</span>&nbsp;<span class="identifier">&lt;ERROR CLASS&gt;</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

14
docs/build/html/api/api/-states-query/-criteria/-all-deals.html vendored Normal file
View File

@ -0,0 +1,14 @@
<HTML>
<HEAD>
<title>StatesQuery.Criteria.AllDeals - </title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">api</a>&nbsp;/&nbsp;<a href="../index.html">StatesQuery</a>&nbsp;/&nbsp;<a href="index.html">Criteria</a>&nbsp;/&nbsp;<a href=".">AllDeals</a><br/>
<br/>
<h1>AllDeals</h1>
<code><span class="keyword">object </span><span class="identifier">AllDeals</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="index.html"><span class="identifier">Criteria</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

14
docs/build/html/api/api/-states-query/-criteria/-deal/-init-.html vendored Normal file
View File

@ -0,0 +1,14 @@
<HTML>
<HEAD>
<title>StatesQuery.Criteria.Deal.<init> - </title>
<link rel="stylesheet" href="../../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">api</a>&nbsp;/&nbsp;<a href="../../index.html">StatesQuery</a>&nbsp;/&nbsp;<a href="../index.html">Criteria</a>&nbsp;/&nbsp;<a href="index.html">Deal</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<code><span class="identifier">Deal</span><span class="symbol">(</span><span class="identifier" id="api.StatesQuery.Criteria.Deal$<init>(kotlin.String)/ref">ref</span><span class="symbol">:</span>&nbsp;<span class="identifier">String</span><span class="symbol">)</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

36
docs/build/html/api/api/-states-query/-criteria/-deal/index.html vendored Normal file
View File

@ -0,0 +1,36 @@
<HTML>
<HEAD>
<title>StatesQuery.Criteria.Deal - </title>
<link rel="stylesheet" href="../../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">api</a>&nbsp;/&nbsp;<a href="../../index.html">StatesQuery</a>&nbsp;/&nbsp;<a href="../index.html">Criteria</a>&nbsp;/&nbsp;<a href=".">Deal</a><br/>
<br/>
<h1>Deal</h1>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Deal</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../index.html"><span class="identifier">Criteria</span></a></code><br/>
<br/>
<br/>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-init-.html">&lt;init&gt;</a></td>
<td>
<code><span class="identifier">Deal</span><span class="symbol">(</span><span class="identifier" id="api.StatesQuery.Criteria.Deal$<init>(kotlin.String)/ref">ref</span><span class="symbol">:</span>&nbsp;<span class="identifier">String</span><span class="symbol">)</span></code></td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<a href="ref.html">ref</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">ref</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

15
docs/build/html/api/api/-states-query/-criteria/-deal/ref.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>StatesQuery.Criteria.Deal.ref - </title>
<link rel="stylesheet" href="../../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">api</a>&nbsp;/&nbsp;<a href="../../index.html">StatesQuery</a>&nbsp;/&nbsp;<a href="../index.html">Criteria</a>&nbsp;/&nbsp;<a href="index.html">Deal</a>&nbsp;/&nbsp;<a href=".">ref</a><br/>
<br/>
<h1>ref</h1>
<a name="api.StatesQuery.Criteria.Deal$ref"></a>
<code><span class="keyword">val </span><span class="identifier">ref</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

48
docs/build/html/api/api/-states-query/-criteria/index.html vendored Normal file
View File

@ -0,0 +1,48 @@
<HTML>
<HEAD>
<title>StatesQuery.Criteria - </title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">api</a>&nbsp;/&nbsp;<a href="../index.html">StatesQuery</a>&nbsp;/&nbsp;<a href=".">Criteria</a><br/>
<br/>
<h1>Criteria</h1>
<code><span class="keyword">interface </span><span class="identifier">Criteria</span></code><br/>
<br/>
<br/>
<h3>Types</h3>
<table>
<tbody>
<tr>
<td>
<a href="-all-deals.html">AllDeals</a></td>
<td>
<code><span class="keyword">object </span><span class="identifier">AllDeals</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">Criteria</span></code></td>
</tr>
<tr>
<td>
<a href="-deal/index.html">Deal</a></td>
<td>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Deal</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">Criteria</span></code></td>
</tr>
</tbody>
</table>
<h3>Inheritors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-all-deals.html">AllDeals</a></td>
<td>
<code><span class="keyword">object </span><span class="identifier">AllDeals</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">Criteria</span></code></td>
</tr>
<tr>
<td>
<a href="-deal/index.html">Deal</a></td>
<td>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Deal</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">Criteria</span></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

14
docs/build/html/api/api/-states-query/-selection/-init-.html vendored Normal file
View File

@ -0,0 +1,14 @@
<HTML>
<HEAD>
<title>StatesQuery.Selection.<init> - </title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">api</a>&nbsp;/&nbsp;<a href="../index.html">StatesQuery</a>&nbsp;/&nbsp;<a href="index.html">Selection</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<code><span class="identifier">Selection</span><span class="symbol">(</span><span class="identifier" id="api.StatesQuery.Selection$<init>(api.StatesQuery.Criteria)/criteria">criteria</span><span class="symbol">:</span>&nbsp;<a href="../-criteria/index.html"><span class="identifier">Criteria</span></a><span class="symbol">)</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-states-query/-selection/criteria.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>StatesQuery.Selection.criteria - </title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">api</a>&nbsp;/&nbsp;<a href="../index.html">StatesQuery</a>&nbsp;/&nbsp;<a href="index.html">Selection</a>&nbsp;/&nbsp;<a href=".">criteria</a><br/>
<br/>
<h1>criteria</h1>
<a name="api.StatesQuery.Selection$criteria"></a>
<code><span class="keyword">val </span><span class="identifier">criteria</span><span class="symbol">: </span><a href="../-criteria/index.html"><span class="identifier">Criteria</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

36
docs/build/html/api/api/-states-query/-selection/index.html vendored Normal file
View File

@ -0,0 +1,36 @@
<HTML>
<HEAD>
<title>StatesQuery.Selection - </title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">api</a>&nbsp;/&nbsp;<a href="../index.html">StatesQuery</a>&nbsp;/&nbsp;<a href=".">Selection</a><br/>
<br/>
<h1>Selection</h1>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Selection</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../index.html"><span class="identifier">StatesQuery</span></a></code><br/>
<br/>
<br/>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-init-.html">&lt;init&gt;</a></td>
<td>
<code><span class="identifier">Selection</span><span class="symbol">(</span><span class="identifier" id="api.StatesQuery.Selection$<init>(api.StatesQuery.Criteria)/criteria">criteria</span><span class="symbol">:</span>&nbsp;<a href="../-criteria/index.html"><span class="identifier">Criteria</span></a><span class="symbol">)</span></code></td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<a href="criteria.html">criteria</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">criteria</span><span class="symbol">: </span><a href="../-criteria/index.html"><span class="identifier">Criteria</span></a></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

66
docs/build/html/api/api/-states-query/index.html vendored Normal file
View File

@ -0,0 +1,66 @@
<HTML>
<HEAD>
<title>StatesQuery - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href=".">StatesQuery</a><br/>
<br/>
<h1>StatesQuery</h1>
<code><span class="keyword">interface </span><span class="identifier">StatesQuery</span></code><br/>
<p>Extremely rudimentary query language which should most likely be replaced with a product</p>
<br/>
<br/>
<h3>Types</h3>
<table>
<tbody>
<tr>
<td>
<a href="-criteria/index.html">Criteria</a></td>
<td>
<code><span class="keyword">interface </span><span class="identifier">Criteria</span></code></td>
</tr>
<tr>
<td>
<a href="-selection/index.html">Selection</a></td>
<td>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Selection</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">StatesQuery</span></code></td>
</tr>
</tbody>
</table>
<h3>Companion Object Functions</h3>
<table>
<tbody>
<tr>
<td>
<a href="select.html">select</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">select</span><span class="symbol">(</span><span class="identifier" id="api.StatesQuery.Companion$select(api.StatesQuery.Criteria)/criteria">criteria</span><span class="symbol">:</span>&nbsp;<a href="-criteria/index.html"><span class="identifier">Criteria</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="-selection/index.html"><span class="identifier">Selection</span></a></code></td>
</tr>
<tr>
<td>
<a href="select-all-deals.html">selectAllDeals</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">selectAllDeals</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="-selection/index.html"><span class="identifier">Selection</span></a></code></td>
</tr>
<tr>
<td>
<a href="select-deal.html">selectDeal</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">selectDeal</span><span class="symbol">(</span><span class="identifier" id="api.StatesQuery.Companion$selectDeal(kotlin.String)/ref">ref</span><span class="symbol">:</span>&nbsp;<span class="identifier">String</span><span class="symbol">)</span><span class="symbol">: </span><a href="-selection/index.html"><span class="identifier">Selection</span></a></code></td>
</tr>
</tbody>
</table>
<h3>Inheritors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-selection/index.html">Selection</a></td>
<td>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Selection</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">StatesQuery</span></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

15
docs/build/html/api/api/-states-query/select-all-deals.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>StatesQuery.selectAllDeals - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">StatesQuery</a>&nbsp;/&nbsp;<a href=".">selectAllDeals</a><br/>
<br/>
<h1>selectAllDeals</h1>
<a name="api.StatesQuery.Companion$selectAllDeals()"></a>
<code><span class="keyword">fun </span><span class="identifier">selectAllDeals</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="-selection/index.html"><span class="identifier">Selection</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-states-query/select-deal.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>StatesQuery.selectDeal - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">StatesQuery</a>&nbsp;/&nbsp;<a href=".">selectDeal</a><br/>
<br/>
<h1>selectDeal</h1>
<a name="api.StatesQuery.Companion$selectDeal(kotlin.String)"></a>
<code><span class="keyword">fun </span><span class="identifier">selectDeal</span><span class="symbol">(</span><span class="identifier" id="api.StatesQuery.Companion$selectDeal(kotlin.String)/ref">ref</span><span class="symbol">:</span>&nbsp;<span class="identifier">String</span><span class="symbol">)</span><span class="symbol">: </span><a href="-selection/index.html"><span class="identifier">Selection</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-states-query/select.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>StatesQuery.select - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">StatesQuery</a>&nbsp;/&nbsp;<a href=".">select</a><br/>
<br/>
<h1>select</h1>
<a name="api.StatesQuery.Companion$select(api.StatesQuery.Criteria)"></a>
<code><span class="keyword">fun </span><span class="identifier">select</span><span class="symbol">(</span><span class="identifier" id="api.StatesQuery.Companion$select(api.StatesQuery.Criteria)/criteria">criteria</span><span class="symbol">:</span>&nbsp;<a href="-criteria/index.html"><span class="identifier">Criteria</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="-selection/index.html"><span class="identifier">Selection</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-transaction-build-step/-init-.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>TransactionBuildStep.<init> - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">TransactionBuildStep</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<code><span class="identifier">TransactionBuildStep</span><span class="symbol">(</span><span class="identifier" id="api.TransactionBuildStep$<init>(kotlin.String, kotlin.collections.Map((kotlin.String, kotlin.Any)))/generateMethodName">generateMethodName</span><span class="symbol">:</span>&nbsp;<span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="api.TransactionBuildStep$<init>(kotlin.String, kotlin.collections.Map((kotlin.String, kotlin.Any)))/args">args</span><span class="symbol">:</span>&nbsp;<span class="identifier">Map</span><span class="symbol">&lt;</span><span class="identifier">String</span><span class="symbol">,</span>&nbsp;<span class="identifier">Any</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">)</span></code><br/>
<p>Encapsulate a generateXXX method call on a contract.</p>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-transaction-build-step/args.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>TransactionBuildStep.args - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">TransactionBuildStep</a>&nbsp;/&nbsp;<a href=".">args</a><br/>
<br/>
<h1>args</h1>
<a name="api.TransactionBuildStep$args"></a>
<code><span class="keyword">val </span><span class="identifier">args</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol">&lt;</span><span class="identifier">String</span><span class="symbol">,</span>&nbsp;<span class="identifier">Any</span><span class="symbol">?</span><span class="symbol">&gt;</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/api/-transaction-build-step/generate-method-name.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>TransactionBuildStep.generateMethodName - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href="index.html">TransactionBuildStep</a>&nbsp;/&nbsp;<a href=".">generateMethodName</a><br/>
<br/>
<h1>generateMethodName</h1>
<a name="api.TransactionBuildStep$generateMethodName"></a>
<code><span class="keyword">val </span><span class="identifier">generateMethodName</span><span class="symbol">: </span><span class="identifier">String</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

44
docs/build/html/api/api/-transaction-build-step/index.html vendored Normal file
View File

@ -0,0 +1,44 @@
<HTML>
<HEAD>
<title>TransactionBuildStep - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">api</a>&nbsp;/&nbsp;<a href=".">TransactionBuildStep</a><br/>
<br/>
<h1>TransactionBuildStep</h1>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">TransactionBuildStep</span></code><br/>
<p>Encapsulate a generateXXX method call on a contract.</p>
<br/>
<br/>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-init-.html">&lt;init&gt;</a></td>
<td>
<code><span class="identifier">TransactionBuildStep</span><span class="symbol">(</span><span class="identifier" id="api.TransactionBuildStep$<init>(kotlin.String, kotlin.collections.Map((kotlin.String, kotlin.Any)))/generateMethodName">generateMethodName</span><span class="symbol">:</span>&nbsp;<span class="identifier">String</span><span class="symbol">, </span><span class="identifier" id="api.TransactionBuildStep$<init>(kotlin.String, kotlin.collections.Map((kotlin.String, kotlin.Any)))/args">args</span><span class="symbol">:</span>&nbsp;<span class="identifier">Map</span><span class="symbol">&lt;</span><span class="identifier">String</span><span class="symbol">,</span>&nbsp;<span class="identifier">Any</span><span class="symbol">?</span><span class="symbol">&gt;</span><span class="symbol">)</span></code><p>Encapsulate a generateXXX method call on a contract.</p>
</td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<a href="args.html">args</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">args</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol">&lt;</span><span class="identifier">String</span><span class="symbol">,</span>&nbsp;<span class="identifier">Any</span><span class="symbol">?</span><span class="symbol">&gt;</span></code></td>
</tr>
<tr>
<td>
<a href="generate-method-name.html">generateMethodName</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">generateMethodName</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

110
docs/build/html/api/api/index.html vendored Normal file
View File

@ -0,0 +1,110 @@
<HTML>
<HEAD>
<title>api - </title>
<link rel="stylesheet" href="../style.css">
</HEAD>
<BODY>
<a href=".">api</a><br/>
<br/>
<h2>Package api</h2>
<h3>Types</h3>
<table>
<tbody>
<tr>
<td>
<a href="-a-p-i-server/index.html">APIServer</a></td>
<td>
<code><span class="keyword">interface </span><span class="identifier">APIServer</span></code><p>Top level interface to external interaction with the distributed ledger.</p>
</td>
</tr>
<tr>
<td>
<a href="-a-p-i-server-impl/index.html">APIServerImpl</a></td>
<td>
<code><span class="keyword">class </span><span class="identifier">APIServerImpl</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="-a-p-i-server/index.html"><span class="identifier">APIServer</span></a></code></td>
</tr>
<tr>
<td>
<a href="-config/index.html">Config</a></td>
<td>
<code><span class="keyword">class </span><span class="identifier">Config</span></code><p>Primary purpose is to install Kotlin extensions for Jackson ObjectMapper so data classes work
and to organise serializers / deserializers for java.time.* classes as necessary</p>
</td>
</tr>
<tr>
<td>
<a href="-contract-class-ref/index.html">ContractClassRef</a></td>
<td>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">ContractClassRef</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="-contract-def-ref.html"><span class="identifier">ContractDefRef</span></a></code></td>
</tr>
<tr>
<td>
<a href="-contract-def-ref.html">ContractDefRef</a></td>
<td>
<code><span class="keyword">interface </span><span class="identifier">ContractDefRef</span></code><p>Encapsulates the contract type. e.g. Cash or CommercialPaper etc.</p>
</td>
</tr>
<tr>
<td>
<a href="-contract-ledger-ref/index.html">ContractLedgerRef</a></td>
<td>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">ContractLedgerRef</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="-contract-def-ref.html"><span class="identifier">ContractDefRef</span></a></code></td>
</tr>
<tr>
<td>
<a href="-interest-rate-swap-a-p-i/index.html">InterestRateSwapAPI</a></td>
<td>
<code><span class="keyword">class </span><span class="identifier">InterestRateSwapAPI</span></code><p>This provides a simplified API, currently for demonstration use only.</p>
</td>
</tr>
<tr>
<td>
<a href="-protocol-class-ref/index.html">ProtocolClassRef</a></td>
<td>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">ProtocolClassRef</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="-protocol-ref.html"><span class="identifier">ProtocolRef</span></a></code></td>
</tr>
<tr>
<td>
<a href="-protocol-instance-ref/index.html">ProtocolInstanceRef</a></td>
<td>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">ProtocolInstanceRef</span></code></td>
</tr>
<tr>
<td>
<a href="-protocol-ref.html">ProtocolRef</a></td>
<td>
<code><span class="keyword">interface </span><span class="identifier">ProtocolRef</span></code><p>Encapsulates the protocol to be instantiated. e.g. TwoPartyTradeProtocol.Buyer.</p>
</td>
</tr>
<tr>
<td>
<a href="-protocol-requiring-attention/index.html">ProtocolRequiringAttention</a></td>
<td>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">ProtocolRequiringAttention</span></code><p>Thinking that Instant is OK for short lived protocol deadlines.</p>
</td>
</tr>
<tr>
<td>
<a href="-response-filter/index.html">ResponseFilter</a></td>
<td>
<code><span class="keyword">class </span><span class="identifier">ResponseFilter</span></code><p>This adds headers needed for cross site scripting on API clients</p>
</td>
</tr>
<tr>
<td>
<a href="-states-query/index.html">StatesQuery</a></td>
<td>
<code><span class="keyword">interface </span><span class="identifier">StatesQuery</span></code><p>Extremely rudimentary query language which should most likely be replaced with a product</p>
</td>
</tr>
<tr>
<td>
<a href="-transaction-build-step/index.html">TransactionBuildStep</a></td>
<td>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">TransactionBuildStep</span></code><p>Encapsulate a generateXXX method call on a contract.</p>
</td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

15
docs/build/html/api/contracts/-c-a-s-h_-p-r-o-g-r-a-m_-i-d.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>CASH_PROGRAM_ID - </title>
<link rel="stylesheet" href="../style.css">
</HEAD>
<BODY>
<a href="index.html">contracts</a>&nbsp;/&nbsp;<a href=".">CASH_PROGRAM_ID</a><br/>
<br/>
<h1>CASH_PROGRAM_ID</h1>
<a name="contracts$CASH_PROGRAM_ID"></a>
<code><span class="keyword">val </span><span class="identifier">CASH_PROGRAM_ID</span><span class="symbol">: </span><a href="-cash/index.html"><span class="identifier">Cash</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

34
docs/build/html/api/contracts/-c-p_-p-r-o-g-r-a-m_-i-d.html vendored Normal file
View File

@ -0,0 +1,34 @@
<HTML>
<HEAD>
<title>CP_PROGRAM_ID - </title>
<link rel="stylesheet" href="../style.css">
</HEAD>
<BODY>
<a href="index.html">contracts</a>&nbsp;/&nbsp;<a href=".">CP_PROGRAM_ID</a><br/>
<br/>
<h1>CP_PROGRAM_ID</h1>
<a name="contracts$CP_PROGRAM_ID"></a>
<code><span class="keyword">val </span><span class="identifier">CP_PROGRAM_ID</span><span class="symbol">: </span><a href="-commercial-paper/index.html"><span class="identifier">CommercialPaper</span></a></code><br/>
<p>This is an ultra-trivial implementation of commercial paper, which is essentially a simpler version of a corporate
bond. It can be seen as a company-specific currency. A company issues CP with a particular face value, say $100,
but sells it for less, say $90. The paper can be redeemed for cash at a given date in the future. Thus this example
would have a 10% interest rate with a single repayment. Commercial paper is often rolled over (the maturity date
is adjusted as if the paper was redeemed and immediately repurchased, but without having to front the cash).</p>
<p>This contract is not intended to realistically model CP. It is here only to act as a next step up above cash in
the prototyping phase. It is thus very incomplete.</p>
<p>Open issues:</p>
<ul><li><p>In this model, you cannot merge or split CP. Can you do this normally? We could model CP as a specialised form
of cash, or reuse some of the cash code? Waiting on response from Ayoub and Rajar about whether CP can always
be split/merged or only in secondary markets. Even if current systems cant do this, would it be a desirable
feature to have anyway?</p>
</li><li><p>The funding steps of CP is totally ignored in this model.</p>
</li><li><p>No attention is paid to the existing roles of custodians, funding banks, etc.</p>
</li><li><p>There are regional variations on the CP concept, for instance, American CP requires a special "CUSIP number"
which may need to be tracked. That, in turn, requires validation logic (there is a bean validator that knows how
to do this in the Apache BVal project).</p>
</li></ul><br/>
<br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/contracts/-c-r-o-w-d-f-u-n-d_-p-r-o-g-r-a-m_-i-d.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>CROWDFUND_PROGRAM_ID - </title>
<link rel="stylesheet" href="../style.css">
</HEAD>
<BODY>
<a href="index.html">contracts</a>&nbsp;/&nbsp;<a href=".">CROWDFUND_PROGRAM_ID</a><br/>
<br/>
<h1>CROWDFUND_PROGRAM_ID</h1>
<a name="contracts$CROWDFUND_PROGRAM_ID"></a>
<code><span class="keyword">val </span><span class="identifier">CROWDFUND_PROGRAM_ID</span><span class="symbol">: </span><a href="-crowd-fund/index.html"><span class="identifier">CrowdFund</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

16
docs/build/html/api/contracts/-cash/-commands/-exit/-init-.html vendored Normal file
View File

@ -0,0 +1,16 @@
<HTML>
<HEAD>
<title>Cash.Commands.Exit.<init> - </title>
<link rel="stylesheet" href="../../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">contracts</a>&nbsp;/&nbsp;<a href="../../index.html">Cash</a>&nbsp;/&nbsp;<a href="../index.html">Commands</a>&nbsp;/&nbsp;<a href="index.html">Exit</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<code><span class="identifier">Exit</span><span class="symbol">(</span><span class="identifier" id="contracts.Cash.Commands.Exit$<init>(core.Amount)/amount">amount</span><span class="symbol">:</span>&nbsp;<a href="../../../../core/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">)</span></code><br/>
<p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
in some other way.</p>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/contracts/-cash/-commands/-exit/amount.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>Cash.Commands.Exit.amount - </title>
<link rel="stylesheet" href="../../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">contracts</a>&nbsp;/&nbsp;<a href="../../index.html">Cash</a>&nbsp;/&nbsp;<a href="../index.html">Commands</a>&nbsp;/&nbsp;<a href="index.html">Exit</a>&nbsp;/&nbsp;<a href=".">amount</a><br/>
<br/>
<h1>amount</h1>
<a name="contracts.Cash.Commands.Exit$amount"></a>
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../../core/-amount/index.html"><span class="identifier">Amount</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

40
docs/build/html/api/contracts/-cash/-commands/-exit/index.html vendored Normal file
View File

@ -0,0 +1,40 @@
<HTML>
<HEAD>
<title>Cash.Commands.Exit - </title>
<link rel="stylesheet" href="../../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">contracts</a>&nbsp;/&nbsp;<a href="../../index.html">Cash</a>&nbsp;/&nbsp;<a href="../index.html">Commands</a>&nbsp;/&nbsp;<a href=".">Exit</a><br/>
<br/>
<h1>Exit</h1>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Exit</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../index.html"><span class="identifier">Commands</span></a></code><br/>
<p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
in some other way.</p>
<br/>
<br/>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-init-.html">&lt;init&gt;</a></td>
<td>
<code><span class="identifier">Exit</span><span class="symbol">(</span><span class="identifier" id="contracts.Cash.Commands.Exit$<init>(core.Amount)/amount">amount</span><span class="symbol">:</span>&nbsp;<a href="../../../../core/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">)</span></code><p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
in some other way.</p>
</td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<a href="amount.html">amount</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../../core/-amount/index.html"><span class="identifier">Amount</span></a></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

16
docs/build/html/api/contracts/-cash/-commands/-issue/-init-.html vendored Normal file
View File

@ -0,0 +1,16 @@
<HTML>
<HEAD>
<title>Cash.Commands.Issue.<init> - </title>
<link rel="stylesheet" href="../../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">contracts</a>&nbsp;/&nbsp;<a href="../../index.html">Cash</a>&nbsp;/&nbsp;<a href="../index.html">Commands</a>&nbsp;/&nbsp;<a href="index.html">Issue</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<code><span class="identifier">Issue</span><span class="symbol">(</span><span class="identifier" id="contracts.Cash.Commands.Issue$<init>(kotlin.Long)/nonce">nonce</span><span class="symbol">:</span>&nbsp;<span class="identifier">Long</span>&nbsp;<span class="symbol">=</span>&nbsp;SecureRandom.getInstanceStrong().nextLong()<span class="symbol">)</span></code><br/>
<p>Allows new cash states to be issued into existence: the nonce ("number used once") ensures the transaction
has a unique ID even when there are no inputs.</p>
<br/>
<br/>
</BODY>
</HTML>

40
docs/build/html/api/contracts/-cash/-commands/-issue/index.html vendored Normal file
View File

@ -0,0 +1,40 @@
<HTML>
<HEAD>
<title>Cash.Commands.Issue - </title>
<link rel="stylesheet" href="../../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">contracts</a>&nbsp;/&nbsp;<a href="../../index.html">Cash</a>&nbsp;/&nbsp;<a href="../index.html">Commands</a>&nbsp;/&nbsp;<a href=".">Issue</a><br/>
<br/>
<h1>Issue</h1>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Issue</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../index.html"><span class="identifier">Commands</span></a></code><br/>
<p>Allows new cash states to be issued into existence: the nonce ("number used once") ensures the transaction
has a unique ID even when there are no inputs.</p>
<br/>
<br/>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-init-.html">&lt;init&gt;</a></td>
<td>
<code><span class="identifier">Issue</span><span class="symbol">(</span><span class="identifier" id="contracts.Cash.Commands.Issue$<init>(kotlin.Long)/nonce">nonce</span><span class="symbol">:</span>&nbsp;<span class="identifier">Long</span>&nbsp;<span class="symbol">=</span>&nbsp;SecureRandom.getInstanceStrong().nextLong()<span class="symbol">)</span></code><p>Allows new cash states to be issued into existence: the nonce ("number used once") ensures the transaction
has a unique ID even when there are no inputs.</p>
</td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<a href="nonce.html">nonce</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">nonce</span><span class="symbol">: </span><span class="identifier">Long</span></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

15
docs/build/html/api/contracts/-cash/-commands/-issue/nonce.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>Cash.Commands.Issue.nonce - </title>
<link rel="stylesheet" href="../../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">contracts</a>&nbsp;/&nbsp;<a href="../../index.html">Cash</a>&nbsp;/&nbsp;<a href="../index.html">Commands</a>&nbsp;/&nbsp;<a href="index.html">Issue</a>&nbsp;/&nbsp;<a href=".">nonce</a><br/>
<br/>
<h1>nonce</h1>
<a name="contracts.Cash.Commands.Issue$nonce"></a>
<code><span class="keyword">val </span><span class="identifier">nonce</span><span class="symbol">: </span><span class="identifier">Long</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

14
docs/build/html/api/contracts/-cash/-commands/-move/-init-.html vendored Normal file
View File

@ -0,0 +1,14 @@
<HTML>
<HEAD>
<title>Cash.Commands.Move.<init> - </title>
<link rel="stylesheet" href="../../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">contracts</a>&nbsp;/&nbsp;<a href="../../index.html">Cash</a>&nbsp;/&nbsp;<a href="../index.html">Commands</a>&nbsp;/&nbsp;<a href="index.html">Move</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<code><span class="identifier">Move</span><span class="symbol">(</span><span class="symbol">)</span></code><br/>
<br/>
<br/>
</BODY>
</HTML>

42
docs/build/html/api/contracts/-cash/-commands/-move/index.html vendored Normal file
View File

@ -0,0 +1,42 @@
<HTML>
<HEAD>
<title>Cash.Commands.Move - </title>
<link rel="stylesheet" href="../../../../style.css">
</HEAD>
<BODY>
<a href="../../../index.html">contracts</a>&nbsp;/&nbsp;<a href="../../index.html">Cash</a>&nbsp;/&nbsp;<a href="../index.html">Commands</a>&nbsp;/&nbsp;<a href=".">Move</a><br/>
<br/>
<h1>Move</h1>
<code><span class="keyword">class </span><span class="identifier">Move</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../../../core/-type-only-command-data/index.html"><span class="identifier">TypeOnlyCommandData</span></a><span class="symbol">, </span><a href="../index.html"><span class="identifier">Commands</span></a></code><br/>
<br/>
<br/>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-init-.html">&lt;init&gt;</a></td>
<td>
<code><span class="identifier">Move</span><span class="symbol">(</span><span class="symbol">)</span></code></td>
</tr>
</tbody>
</table>
<h3>Inherited Functions</h3>
<table>
<tbody>
<tr>
<td>
<a href="../../../../core/-type-only-command-data/equals.html">equals</a></td>
<td>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">equals</span><span class="symbol">(</span><span class="identifier" id="core.TypeOnlyCommandData$equals(kotlin.Any)/other">other</span><span class="symbol">:</span>&nbsp;<span class="identifier">Any</span><span class="symbol">?</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Boolean</span></code></td>
</tr>
<tr>
<td>
<a href="../../../../core/-type-only-command-data/hash-code.html">hashCode</a></td>
<td>
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">hashCode</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">&lt;ERROR CLASS&gt;</span></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

68
docs/build/html/api/contracts/-cash/-commands/index.html vendored Normal file
View File

@ -0,0 +1,68 @@
<HTML>
<HEAD>
<title>Cash.Commands - </title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">contracts</a>&nbsp;/&nbsp;<a href="../index.html">Cash</a>&nbsp;/&nbsp;<a href=".">Commands</a><br/>
<br/>
<h1>Commands</h1>
<code><span class="keyword">interface </span><span class="identifier">Commands</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../../core/-command-data.html"><span class="identifier">CommandData</span></a></code><br/>
<br/>
<br/>
<h3>Types</h3>
<table>
<tbody>
<tr>
<td>
<a href="-exit/index.html">Exit</a></td>
<td>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Exit</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">Commands</span></code><p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
in some other way.</p>
</td>
</tr>
<tr>
<td>
<a href="-issue/index.html">Issue</a></td>
<td>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Issue</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">Commands</span></code><p>Allows new cash states to be issued into existence: the nonce ("number used once") ensures the transaction
has a unique ID even when there are no inputs.</p>
</td>
</tr>
<tr>
<td>
<a href="-move/index.html">Move</a></td>
<td>
<code><span class="keyword">class </span><span class="identifier">Move</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../../core/-type-only-command-data/index.html"><span class="identifier">TypeOnlyCommandData</span></a><span class="symbol">, </span><span class="identifier">Commands</span></code></td>
</tr>
</tbody>
</table>
<h3>Inheritors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-exit/index.html">Exit</a></td>
<td>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Exit</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">Commands</span></code><p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
in some other way.</p>
</td>
</tr>
<tr>
<td>
<a href="-issue/index.html">Issue</a></td>
<td>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Issue</span>&nbsp;<span class="symbol">:</span>&nbsp;<span class="identifier">Commands</span></code><p>Allows new cash states to be issued into existence: the nonce ("number used once") ensures the transaction
has a unique ID even when there are no inputs.</p>
</td>
</tr>
<tr>
<td>
<a href="-move/index.html">Move</a></td>
<td>
<code><span class="keyword">class </span><span class="identifier">Move</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../../core/-type-only-command-data/index.html"><span class="identifier">TypeOnlyCommandData</span></a><span class="symbol">, </span><span class="identifier">Commands</span></code></td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

25
docs/build/html/api/contracts/-cash/-init-.html vendored Normal file
View File

@ -0,0 +1,25 @@
<HTML>
<HEAD>
<title>Cash.<init> - </title>
<link rel="stylesheet" href="../../style.css">
</HEAD>
<BODY>
<a href="../index.html">contracts</a>&nbsp;/&nbsp;<a href="index.html">Cash</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<code><span class="identifier">Cash</span><span class="symbol">(</span><span class="symbol">)</span></code><br/>
<p>A cash transaction may split and merge money represented by a set of (issuer, depositRef) pairs, across multiple
input and output states. Imagine a Bitcoin transaction but in which all UTXOs had a colour
(a blend of issuer+depositRef) and you couldnt merge outputs of two colours together, but you COULD put them in
the same transaction.</p>
<p>The goal of this design is to ensure that money can be withdrawn from the ledger easily: if you receive some money
via this contract, you always know where to go in order to extract it from the R3 ledger, no matter how many hands
it has passed through in the intervening time.</p>
<p>At the same time, other contracts that just want money and dont care much who is currently holding it in their
vaults can ignore the issuer/depositRefs and just examine the amount fields.</p>
<br/>
<br/>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/contracts/-cash/-state/-init-.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>Cash.State.<init> - </title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">contracts</a>&nbsp;/&nbsp;<a href="../index.html">Cash</a>&nbsp;/&nbsp;<a href="index.html">State</a>&nbsp;/&nbsp;<a href=".">&lt;init&gt;</a><br/>
<br/>
<h1>&lt;init&gt;</h1>
<code><span class="identifier">State</span><span class="symbol">(</span><span class="identifier" id="contracts.Cash.State$<init>(core.PartyReference, core.Amount, java.security.PublicKey)/deposit">deposit</span><span class="symbol">:</span>&nbsp;<a href="../../../core/-party-reference/index.html"><span class="identifier">PartyReference</span></a><span class="symbol">, </span><span class="identifier" id="contracts.Cash.State$<init>(core.PartyReference, core.Amount, java.security.PublicKey)/amount">amount</span><span class="symbol">:</span>&nbsp;<a href="../../../core/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">, </span><span class="identifier" id="contracts.Cash.State$<init>(core.PartyReference, core.Amount, java.security.PublicKey)/owner">owner</span><span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span></code><br/>
<p>A state representing a cash claim against some party</p>
<br/>
<br/>
</BODY>
</HTML>

15
docs/build/html/api/contracts/-cash/-state/amount.html vendored Normal file
View File

@ -0,0 +1,15 @@
<HTML>
<HEAD>
<title>Cash.State.amount - </title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">contracts</a>&nbsp;/&nbsp;<a href="../index.html">Cash</a>&nbsp;/&nbsp;<a href="index.html">State</a>&nbsp;/&nbsp;<a href=".">amount</a><br/>
<br/>
<h1>amount</h1>
<a name="contracts.Cash.State$amount"></a>
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../core/-amount/index.html"><span class="identifier">Amount</span></a></code><br/>
<br/>
<br/>
</BODY>
</HTML>

17
docs/build/html/api/contracts/-cash/-state/contract.html vendored Normal file
View File

@ -0,0 +1,17 @@
<HTML>
<HEAD>
<title>Cash.State.contract - </title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">contracts</a>&nbsp;/&nbsp;<a href="../index.html">Cash</a>&nbsp;/&nbsp;<a href="index.html">State</a>&nbsp;/&nbsp;<a href=".">contract</a><br/>
<br/>
<h1>contract</h1>
<a name="contracts.Cash.State$contract"></a>
<code><span class="keyword">val </span><span class="identifier">contract</span><span class="symbol">: </span><a href="../index.html"><span class="identifier">Cash</span></a></code><br/>
Overrides <a href="../../../core/-contract-state/contract.html">ContractState.contract</a><br/>
<p>Contract by which the state belongs</p>
<br/>
<br/>
</BODY>
</HTML>

16
docs/build/html/api/contracts/-cash/-state/deposit.html vendored Normal file
View File

@ -0,0 +1,16 @@
<HTML>
<HEAD>
<title>Cash.State.deposit - </title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">contracts</a>&nbsp;/&nbsp;<a href="../index.html">Cash</a>&nbsp;/&nbsp;<a href="index.html">State</a>&nbsp;/&nbsp;<a href=".">deposit</a><br/>
<br/>
<h1>deposit</h1>
<a name="contracts.Cash.State$deposit"></a>
<code><span class="keyword">val </span><span class="identifier">deposit</span><span class="symbol">: </span><a href="../../../core/-party-reference/index.html"><span class="identifier">PartyReference</span></a></code><br/>
<p>Where the underlying currency backing this ledger entry can be found (propagated)</p>
<br/>
<br/>
</BODY>
</HTML>

77
docs/build/html/api/contracts/-cash/-state/index.html vendored Normal file
View File

@ -0,0 +1,77 @@
<HTML>
<HEAD>
<title>Cash.State - </title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">contracts</a>&nbsp;/&nbsp;<a href="../index.html">Cash</a>&nbsp;/&nbsp;<a href=".">State</a><br/>
<br/>
<h1>State</h1>
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">State</span>&nbsp;<span class="symbol">:</span>&nbsp;<a href="../../../core/-ownable-state/index.html"><span class="identifier">OwnableState</span></a></code><br/>
<p>A state representing a cash claim against some party</p>
<br/>
<br/>
<h3>Constructors</h3>
<table>
<tbody>
<tr>
<td>
<a href="-init-.html">&lt;init&gt;</a></td>
<td>
<code><span class="identifier">State</span><span class="symbol">(</span><span class="identifier" id="contracts.Cash.State$<init>(core.PartyReference, core.Amount, java.security.PublicKey)/deposit">deposit</span><span class="symbol">:</span>&nbsp;<a href="../../../core/-party-reference/index.html"><span class="identifier">PartyReference</span></a><span class="symbol">, </span><span class="identifier" id="contracts.Cash.State$<init>(core.PartyReference, core.Amount, java.security.PublicKey)/amount">amount</span><span class="symbol">:</span>&nbsp;<a href="../../../core/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol">, </span><span class="identifier" id="contracts.Cash.State$<init>(core.PartyReference, core.Amount, java.security.PublicKey)/owner">owner</span><span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span></code><p>A state representing a cash claim against some party</p>
</td>
</tr>
</tbody>
</table>
<h3>Properties</h3>
<table>
<tbody>
<tr>
<td>
<a href="amount.html">amount</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../core/-amount/index.html"><span class="identifier">Amount</span></a></code></td>
</tr>
<tr>
<td>
<a href="contract.html">contract</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">contract</span><span class="symbol">: </span><a href="../index.html"><span class="identifier">Cash</span></a></code><p>Contract by which the state belongs</p>
</td>
</tr>
<tr>
<td>
<a href="deposit.html">deposit</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">deposit</span><span class="symbol">: </span><a href="../../../core/-party-reference/index.html"><span class="identifier">PartyReference</span></a></code><p>Where the underlying currency backing this ledger entry can be found (propagated)</p>
</td>
</tr>
<tr>
<td>
<a href="owner.html">owner</a></td>
<td>
<code><span class="keyword">val </span><span class="identifier">owner</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a></code><p>There must be a MoveCommand signed by this key to claim the amount</p>
</td>
</tr>
</tbody>
</table>
<h3>Functions</h3>
<table>
<tbody>
<tr>
<td>
<a href="to-string.html">toString</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">toString</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">String</span></code></td>
</tr>
<tr>
<td>
<a href="with-new-owner.html">withNewOwner</a></td>
<td>
<code><span class="keyword">fun </span><span class="identifier">withNewOwner</span><span class="symbol">(</span><span class="identifier" id="contracts.Cash.State$withNewOwner(java.security.PublicKey)/newOwner">newOwner</span><span class="symbol">:</span>&nbsp;<a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">&lt;ERROR CLASS&gt;</span></code><p>Copies the underlying data structure, replacing the owner field with this new value and leaving the rest alone</p>
</td>
</tr>
</tbody>
</table>
</BODY>
</HTML>

17
docs/build/html/api/contracts/-cash/-state/owner.html vendored Normal file
View File

@ -0,0 +1,17 @@
<HTML>
<HEAD>
<title>Cash.State.owner - </title>
<link rel="stylesheet" href="../../../style.css">
</HEAD>
<BODY>
<a href="../../index.html">contracts</a>&nbsp;/&nbsp;<a href="../index.html">Cash</a>&nbsp;/&nbsp;<a href="index.html">State</a>&nbsp;/&nbsp;<a href=".">owner</a><br/>
<br/>
<h1>owner</h1>
<a name="contracts.Cash.State$owner"></a>
<code><span class="keyword">val </span><span class="identifier">owner</span><span class="symbol">: </span><a href="http://docs.oracle.com/javase/6/docs/api/java/security/PublicKey.html"><span class="identifier">PublicKey</span></a></code><br/>
Overrides <a href="../../../core/-ownable-state/owner.html">OwnableState.owner</a><br/>
<p>There must be a MoveCommand signed by this key to claim the amount</p>
<br/>
<br/>
</BODY>
</HTML>

Some files were not shown because too many files have changed in this diff Show More