mirror of
https://github.com/corda/corda.git
synced 2025-02-01 00:45:59 +00:00
Regen docsite
This commit is contained in:
Mike Hearn
parent
5167ed7df2
commit
7e6c1332e7
@ -7,7 +7,9 @@
|
||||
Writing a contract
|
||||
==================
|
||||
|
||||
This tutorial will take you through how the commercial paper contract works.
|
||||
This tutorial will take you through how the commercial paper contract works. This uses a simple contract structure of
|
||||
everything being in one contract class, while most actual contracts in Corda are broken into clauses (which we'll
|
||||
discuss in the next tutorial). You can see the full Kotlin version of this contract in the code as ``CommercialPaperLegacy``.
|
||||
|
||||
The code in this tutorial is available in both Kotlin and Java. You can quickly switch between them to get a feeling
|
||||
for how Kotlin syntax works.
|
||||
|
||||
148
docs/build/html/api/alltypes/index.html
vendored
148
docs/build/html/api/alltypes/index.html
vendored
@ -39,6 +39,22 @@ if the terminal supports it. Otherwise it just prints out the name of the step w
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.clause/-abstract-conserve-amount/index.html">com.r3corda.contracts.clause.AbstractConserveAmount</a></td>
|
||||
<td>
|
||||
<p>Standardised clause for checking input/output balances of fungible assets. Requires that a
|
||||
Move command is provided, and errors if absent. Must be the last clause under a grouping clause;
|
||||
errors on no-match, ends on match.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.clause/-abstract-issue/index.html">com.r3corda.contracts.clause.AbstractIssue</a></td>
|
||||
<td>
|
||||
<p>Standard issue clause for contracts that issue fungible assets.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.internal/-abstract-node/index.html">com.r3corda.node.internal.AbstractNode</a></td>
|
||||
<td>
|
||||
<p>A base node implementation that can be customised either for production (with real implementations that do real
|
||||
@ -54,7 +70,7 @@ I/O), or a mock implementation suitable for unit test environments.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../protocols/-abstract-state-replacement-protocol/index.html">protocols.AbstractStateReplacementProtocol</a></td>
|
||||
<a href="../com.r3corda.protocols/-abstract-state-replacement-protocol/index.html">com.r3corda.protocols.AbstractStateReplacementProtocol</a></td>
|
||||
<td>
|
||||
<p>Abstract protocol to be used for replacing one state with another, for example when changing the notary of a state.
|
||||
Notably this requires a one to one replacement of states, states cannot be split, merged or issued as part of these
|
||||
@ -135,8 +151,8 @@ properties loaded from the attachments. And perhaps the authenticated user for
|
||||
<td>
|
||||
<p>This class implements the <a href="../com.r3corda.core.messaging/-messaging-service/index.html">MessagingService</a> API using Apache Artemis, the successor to their ActiveMQ product.
|
||||
Artemis is a message queue broker and here, we embed the entire server inside our own process. Nodes communicate
|
||||
with each other using (by default) an Artemis specific protocol, but it supports other protocols like AQMP/1.0
|
||||
as well.</p>
|
||||
with each other using an Artemis specific protocol, but it supports other protocols like AMQP/1.0
|
||||
as well for interop.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -195,6 +211,15 @@ API call from a single party without bi-directional access to the database of of
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.clause/-bilateral-net-state/index.html">com.r3corda.contracts.clause.BilateralNetState</a></td>
|
||||
<td>
|
||||
<p>Subset of state, containing the elements which must match for two obligation transactions to be nettable.
|
||||
If two obligation state objects produce equal bilateral net states, they are considered safe to net directly.
|
||||
Bilateral states are used in close-out netting.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.contracts/-bilateral-nettable-state/index.html">com.r3corda.core.contracts.BilateralNettableState</a></td>
|
||||
<td>
|
||||
<p>Interface for state objects that support being netted with other state objects.</p>
|
||||
@ -326,6 +351,12 @@ that delegates to the supplied list of clauses.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts/-commercial-paper-legacy/index.html">com.r3corda.contracts.CommercialPaperLegacy</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.servlets/-config/index.html">com.r3corda.node.servlets.Config</a></td>
|
||||
<td>
|
||||
<p>Primary purpose is to install Kotlin extensions for Jackson ObjectMapper so data classes work
|
||||
@ -622,6 +653,12 @@ attachments are saved to local storage automatically.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.services.statemachine/-fiber-request/index.html">com.r3corda.node.services.statemachine.FiberRequest</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.contracts/-fix/index.html">com.r3corda.core.contracts.Fix</a></td>
|
||||
<td>
|
||||
<p>A <a href="../com.r3corda.core.contracts/-fix/index.html">Fix</a> represents a named interest rate, on a given day, for a given duration. It can be embedded in a tx.</p>
|
||||
@ -691,19 +728,12 @@ that would divide into (eg annually = 1, semiannual = 2, monthly = 12 etc).</p>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.asset/-fungible-asset/index.html">com.r3corda.contracts.asset.FungibleAsset</a></td>
|
||||
<td>
|
||||
<p>Superclass for contracts representing assets which are fungible, countable and issued by a specific party. States
|
||||
contain assets which are equivalent (such as cash of the same currency), so records of their existence can
|
||||
be merged or split as needed where the issuer is the same. For instance, dollars issued by the Fed are fungible and
|
||||
countable (in cents), barrels of West Texas crude are fungible and countable (oil from two small containers
|
||||
can be poured into one large container), shares of the same class in a specific company are fungible and
|
||||
countable, and so on.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.asset/-fungible-asset-state/index.html">com.r3corda.contracts.asset.FungibleAssetState</a></td>
|
||||
<td>
|
||||
<p>Common elements of cash contract states.</p>
|
||||
<p>Interface for contract states representing assets which are fungible, countable and issued by a
|
||||
specific party. States contain assets which are equivalent (such as cash of the same currency),
|
||||
so records of their existence can be merged or split as needed where the issuer is the same. For
|
||||
instance, dollars issued by the Fed are fungible and countable (in cents), barrels of West Texas
|
||||
crude are fungible and countable (oil from two small containers can be poured into one large
|
||||
container), shares of the same class in a specific company are fungible and countable, and so on.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -1143,6 +1173,25 @@ This is not an interface because it is too lightweight to bother mocking out.</p
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.clause/-multilateral-net-state/index.html">com.r3corda.contracts.clause.MultilateralNetState</a></td>
|
||||
<td>
|
||||
<p>Subset of state, containing the elements which must match for two or more obligation transactions to be candidates
|
||||
for netting (this does not include the checks to enforce that everyones amounts received are the same at the end,
|
||||
which is handled under the verify() function).
|
||||
In comparison to <a href="../com.r3corda.contracts.clause/-bilateral-net-state/index.html">BilateralNetState</a>, this doesnt include the parties keys, as ensuring balances match on
|
||||
input and output is handled elsewhere.
|
||||
Used in cases where all parties (or their proxies) are signing, such as central clearing.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.contracts/-multilateral-nettable-state/index.html">com.r3corda.core.contracts.MultilateralNettableState</a></td>
|
||||
<td>
|
||||
<p>Interface for state objects that support being netted with other state objects.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.utilities/-mutable-clock/index.html">com.r3corda.node.utilities.MutableClock</a></td>
|
||||
<td>
|
||||
<p>An abstract class with helper methods for a type of Clock that might have its concept of "now"
|
||||
@ -1158,6 +1207,21 @@ adjusted externally.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.clause/-net-clause/index.html">com.r3corda.contracts.clause.NetClause</a></td>
|
||||
<td>
|
||||
<p>Clause for netting contract states. Currently only supports obligation contract.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.clause/-net-state/index.html">com.r3corda.contracts.clause.NetState</a></td>
|
||||
<td>
|
||||
<p>Common interface for the state subsets used when determining nettability of two or more states. Exposes the
|
||||
underlying issued thing.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.contracts/-net-type/index.html">com.r3corda.core.contracts.NetType</a></td>
|
||||
<td>
|
||||
<p>Enum for the types of netting that can be applied to state objects. Exact behaviour
|
||||
@ -1166,6 +1230,12 @@ for each type of netting is left to the contract to determine.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.contracts/-nettable-state.html">com.r3corda.core.contracts.NettableState</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.node.services/-network-cache-error/index.html">com.r3corda.core.node.services.NetworkCacheError</a></td>
|
||||
<td>
|
||||
</td>
|
||||
@ -1198,6 +1268,14 @@ replace each other based on a serial number present in the change.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.clause/-no-zero-sized-outputs/index.html">com.r3corda.contracts.clause.NoZeroSizedOutputs</a></td>
|
||||
<td>
|
||||
<p>Clause for fungible asset contracts, which enforces that no output state should have
|
||||
a balance of zero.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.internal/-node/index.html">com.r3corda.node.internal.Node</a></td>
|
||||
<td>
|
||||
<p>A Node manages a standalone server that takes part in the P2P network. It creates the services found in <a href="../com.r3corda.core.node/-service-hub/index.html">ServiceHub</a>,
|
||||
@ -1293,7 +1371,7 @@ trying to construct the set.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../protocols/-notary-change-protocol/index.html">protocols.NotaryChangeProtocol</a></td>
|
||||
<a href="../com.r3corda.protocols/-notary-change-protocol/index.html">com.r3corda.protocols.NotaryChangeProtocol</a></td>
|
||||
<td>
|
||||
<p>A protocol to be used for changing a states Notary. This is required since all input states to a transaction
|
||||
must point to the same notary.</p>
|
||||
@ -1304,7 +1382,7 @@ must point to the same notary.</p>
|
||||
<a href="../com.r3corda.node.services/-notary-change-service/index.html">com.r3corda.node.services.NotaryChangeService</a></td>
|
||||
<td>
|
||||
<p>A service that monitors the network for requests for changing the notary of a state,
|
||||
and immediately runs the <a href="../protocols/-notary-change-protocol/index.html">NotaryChangeProtocol</a> if the auto-accept criteria are met.</p>
|
||||
and immediately runs the <a href="../com.r3corda.protocols/-notary-change-protocol/index.html">NotaryChangeProtocol</a> if the auto-accept criteria are met.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -1873,13 +1951,13 @@ transaction defined the state and where in that transaction it was.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../protocols/-state-replacement-exception/index.html">protocols.StateReplacementException</a></td>
|
||||
<a href="../com.r3corda.protocols/-state-replacement-exception/index.html">com.r3corda.protocols.StateReplacementException</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../protocols/-state-replacement-refused/index.html">protocols.StateReplacementRefused</a></td>
|
||||
<a href="../com.r3corda.protocols/-state-replacement-refused/index.html">com.r3corda.protocols.StateReplacementRefused</a></td>
|
||||
<td>
|
||||
<p>Thrown when a participant refuses proposed the state replacement</p>
|
||||
</td>
|
||||
@ -2220,6 +2298,30 @@ consumed by someone else first</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.crypto/-whitelist-trust-manager/index.html">com.r3corda.core.crypto.WhitelistTrustManager</a></td>
|
||||
<td>
|
||||
<p>Our TrustManager extension takes the standard certificate checker and first delegates all the
|
||||
chain checking to that. If everything is well formed we then simply add a check against our whitelist</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.crypto/-whitelist-trust-manager-provider/index.html">com.r3corda.core.crypto.WhitelistTrustManagerProvider</a></td>
|
||||
<td>
|
||||
<p>Custom Security Provider that forces the TrustManagerFactory to be our custom one.
|
||||
Also holds the identity of the original TrustManager algorithm so
|
||||
that we can delegate most of the checking to the proper Java code. We simply add some more checks.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.crypto/-whitelist-trust-manager-spi/index.html">com.r3corda.core.crypto.WhitelistTrustManagerSpi</a></td>
|
||||
<td>
|
||||
<p>Registered TrustManagerFactorySpi</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.node.services.network/-wire-node-registration/index.html">com.r3corda.node.services.network.WireNodeRegistration</a></td>
|
||||
<td>
|
||||
<p>A node registration and its signature as a pair.</p>
|
||||
@ -2246,6 +2348,12 @@ consumed by someone else first</p>
|
||||
<p>A latitude/longitude pair.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.core.crypto/-x509-utilities/index.html">com.r3corda.core.crypto.X509Utilities</a></td>
|
||||
<td>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../../index.html">com.r3corda.contracts.asset</a> / <a href="../index.html">Cash</a> / <a href=".">Commands</a><br/>
|
||||
<br/>
|
||||
<h1>Commands</h1>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a></code><br/>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <a href="../../-fungible-asset/-commands/index.html"><span class="identifier">Commands</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Types</h3>
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
<h1>amount</h1>
|
||||
<a name="com.r3corda.contracts.asset.Cash.State$amount"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../../-fungible-asset/-state/amount.html">State.amount</a><br/>
|
||||
Overrides <a href="../../-fungible-asset/amount.html">FungibleAsset.amount</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -9,11 +9,13 @@
|
||||
<h1>deposit</h1>
|
||||
<a name="com.r3corda.contracts.asset.Cash.State$deposit"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">deposit</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a></code><br/>
|
||||
Overrides <a href="../../-fungible-asset/-state/deposit.html">State.deposit</a><br/>
|
||||
<p>Where the underlying currency backing this ledger entry can be found (propagated)</p>
|
||||
<strong>Getter</strong><br/>
|
||||
<p>Where the underlying currency backing this ledger entry can be found (propagated)</p>
|
||||
<br/>
|
||||
Overrides <a href="../../-fungible-asset/deposit.html">FungibleAsset.deposit</a><br/>
|
||||
<p>Where the underlying asset backing this ledger entry can be found. The reference
|
||||
is only intended for use by the issuer, and is not intended to be meaningful to others.</p>
|
||||
<p><strong>Getter</strong><br/>
|
||||
<p>Where the underlying asset backing this ledger entry can be found. The reference
|
||||
is only intended for use by the issuer, and is not intended to be meaningful to others.</p>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -9,11 +9,11 @@
|
||||
<h1>exitKeys</h1>
|
||||
<a name="com.r3corda.contracts.asset.Cash.State$exitKeys"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">exitKeys</span><span class="symbol">: </span><span class="identifier">Collection</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><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../../-fungible-asset/-state/exit-keys.html">State.exitKeys</a><br/>
|
||||
Overrides <a href="../../-fungible-asset/exit-keys.html">FungibleAsset.exitKeys</a><br/>
|
||||
<p>There must be an ExitCommand signed by these keys to destroy the amount</p>
|
||||
<strong>Getter</strong><br/>
|
||||
<p><strong>Getter</strong><br/>
|
||||
<p>There must be an ExitCommand signed by these keys to destroy the amount</p>
|
||||
<br/>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../../index.html">com.r3corda.contracts.asset</a> / <a href="../index.html">Cash</a> / <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> <span class="symbol">:</span> <a href="../../-fungible-asset/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">State</span> <span class="symbol">:</span> <a href="../../-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><br/>
|
||||
<p>A state representing a cash claim against some party</p>
|
||||
<br/>
|
||||
<br/>
|
||||
@ -43,7 +43,8 @@
|
||||
<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="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a></code><p>Where the underlying currency backing this ledger entry can be found (propagated)</p>
|
||||
<code><span class="keyword">val </span><span class="identifier">deposit</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a></code><p>Where the underlying asset backing this ledger entry can be found. The reference
|
||||
is only intended for use by the issuer, and is not intended to be meaningful to others.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -73,12 +74,6 @@
|
||||
<code><span class="keyword">val </span><span class="identifier">participants</span><span class="symbol">: </span><span class="identifier">List</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><span class="symbol">></span></code><p>A <emph>participant</emph> is any party that is able to consume this state in a valid transaction.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="product-amount.html">productAmount</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">productAmount</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Functions</h3>
|
||||
@ -88,7 +83,7 @@
|
||||
<td>
|
||||
<a href="move.html">move</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">move</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Cash.State$move(com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey)/newAmount">newAmount</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Cash.State$move(com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey)/newOwner">newOwner</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><span class="symbol">)</span><span class="symbol">: </span><a href="../../-fungible-asset/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code></td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">move</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Cash.State$move(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.security.PublicKey)/newAmount">newAmount</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Cash.State$move(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.security.PublicKey)/newOwner">newOwner</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><span class="symbol">)</span><span class="symbol">: </span><a href="../../-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
<h1>issuanceDef</h1>
|
||||
<a name="com.r3corda.contracts.asset.Cash.State$issuanceDef"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">issuanceDef</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../../-fungible-asset-state/issuance-def.html">FungibleAssetState.issuanceDef</a><br/>
|
||||
Overrides <a href="../../-fungible-asset/issuance-def.html">FungibleAsset.issuanceDef</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,8 +7,8 @@
|
||||
<a href="../../index.html">com.r3corda.contracts.asset</a> / <a href="../index.html">Cash</a> / <a href="index.html">State</a> / <a href=".">move</a><br/>
|
||||
<br/>
|
||||
<h1>move</h1>
|
||||
<a name="com.r3corda.contracts.asset.Cash.State$move(com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">move</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Cash.State$move(com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey)/newAmount">newAmount</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Cash.State$move(com.r3corda.core.contracts.Amount((java.util.Currency)), java.security.PublicKey)/newOwner">newOwner</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><span class="symbol">)</span><span class="symbol">: </span><a href="../../-fungible-asset/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><br/>
|
||||
<a name="com.r3corda.contracts.asset.Cash.State$move(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.security.PublicKey)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">move</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Cash.State$move(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.security.PublicKey)/newAmount">newAmount</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Cash.State$move(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.security.PublicKey)/newOwner">newOwner</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><span class="symbol">)</span><span class="symbol">: </span><a href="../../-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -9,7 +9,7 @@
|
||||
<h1>owner</h1>
|
||||
<a name="com.r3corda.contracts.asset.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="../../-fungible-asset/-state/owner.html">State.owner</a><br/>
|
||||
Overrides <a href="../../-fungible-asset/owner.html">FungibleAsset.owner</a><br/>
|
||||
<p>There must be a MoveCommand signed by this key to claim the amount</p>
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
@ -19,7 +19,7 @@ they possess, since someone consumed that state during the notary change process
|
||||
list should just contain the owner.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<strong>Getter</strong><br/>
|
||||
<p><strong>Getter</strong><br/>
|
||||
<p>A <emph>participant</emph> is any party that is able to consume this state in a valid transaction.</p>
|
||||
<p>The list of participants is required for certain types of transactions. For example, when changing the notary
|
||||
for this state (<a href="../../../com.r3corda.core.contracts/-transaction-type/-notary-change/index.html">TransactionType.NotaryChange</a>), every participants has to be involved and approve the transaction
|
||||
@ -27,7 +27,7 @@ so that they receive the updated state, and dont end up in a situation where the
|
||||
they possess, since someone consumed that state during the notary change process.</p>
|
||||
<p>The participants list should normally be derived from the contents of the state. E.g. for <a href="../index.html">Cash</a> the participants
|
||||
list should just contain the owner.</p>
|
||||
<br/>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
32
docs/build/html/api/com.r3corda.contracts.asset/-cash/generate-exit.html
vendored
Normal file
32
docs/build/html/api/com.r3corda.contracts.asset/-cash/generate-exit.html
vendored
Normal file
@ -0,0 +1,32 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Cash.generateExit - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts.asset</a> / <a href="index.html">Cash</a> / <a href=".">generateExit</a><br/>
|
||||
<br/>
|
||||
<h1>generateExit</h1>
|
||||
<a name="com.r3corda.contracts.asset.Cash$generateExit(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Cash.State)))))"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateExit</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Cash$generateExit(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Cash.State)))))/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Cash$generateExit(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Cash.State)))))/amountIssued">amountIssued</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Cash$generateExit(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Cash.State)))))/changeKey">changeKey</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><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Cash$generateExit(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Cash.State)))))/cashStates">cashStates</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</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/>
|
||||
<p>Generate an transaction exiting cash from the ledger.</p>
|
||||
<h3>Parameters</h3>
|
||||
<a name="tx"></a>
|
||||
<code>tx</code> - transaction builder to add states and commands to.<br/>
|
||||
<br/>
|
||||
<a name="amountIssued"></a>
|
||||
<code>amountIssued</code> - the amount to be exited, represented as a quantity of issued currency.<br/>
|
||||
<br/>
|
||||
<a name="changeKey"></a>
|
||||
<code>changeKey</code> - the key to send any change to. This needs to be explicitly stated as the input states are not
|
||||
necessarily owned by us.<br/>
|
||||
<br/>
|
||||
<a name="cashStates"></a>
|
||||
<code>cashStates</code> - the cash states to take funds from. No checks are done about ownership of these states, it is
|
||||
the responsibility of the caller to check that they do not exit funds held by others.<br/>
|
||||
<p><strong>Return</strong><br/>
|
||||
the public key of the cash issuer, who must sign the transaction for it to be valid.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../index.html">com.r3corda.contracts.asset</a> / <a href=".">Cash</a><br/>
|
||||
<br/>
|
||||
<h1>Cash</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">Cash</span> <span class="symbol">:</span> <a href="../-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">class </span><span class="identifier">Cash</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts.clauses/-clause-verifier/index.html"><span class="identifier">ClauseVerifier</span></a></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
|
||||
@ -26,15 +26,21 @@ vaults can ignore the issuer/depositRefs and just examine the amount fields.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-clauses/index.html">Clauses</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Clauses</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-commands/index.html">Commands</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a></code></td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <a href="../-fungible-asset/-commands/index.html"><span class="identifier">Commands</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-state/index.html">State</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">State</span> <span class="symbol">:</span> <a href="../-fungible-asset/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><p>A state representing a cash claim against some party</p>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">State</span> <span class="symbol">:</span> <a href="../-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><p>A state representing a cash claim against some party</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -59,6 +65,12 @@ the same transaction.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="clauses.html">clauses</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">clauses</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts.clauses/-single-clause.html"><span class="identifier">SingleClause</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="legal-contract-reference.html">legalContractReference</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">legalContractReference</span><span class="symbol">: </span><a href="../../com.r3corda.core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><p>TODO:</p>
|
||||
@ -71,6 +83,19 @@ the same transaction.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="extract-commands.html">extractCommands</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">extractCommands</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Cash$extractCommands(com.r3corda.core.contracts.TransactionForContract)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-authenticated-object/index.html"><span class="identifier">AuthenticatedObject</span></a><span class="symbol"><</span><a href="../-fungible-asset/-commands/index.html"><span class="identifier">Commands</span></a><span class="symbol">></span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="generate-exit.html">generateExit</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateExit</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Cash$generateExit(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Cash.State)))))/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Cash$generateExit(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Cash.State)))))/amountIssued">amountIssued</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Cash$generateExit(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Cash.State)))))/changeKey">changeKey</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><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Cash$generateExit(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.security.PublicKey, kotlin.collections.List((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Cash.State)))))/cashStates">cashStates</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</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>Generate an transaction exiting cash from the ledger.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="generate-issue.html">generateIssue</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((java.util.Currency)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((java.util.Currency)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/tokenDef">tokenDef</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((java.util.Currency)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/pennies">pennies</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((java.util.Currency)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/owner">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><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Cash$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((java.util.Currency)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>Puts together an issuance transaction from the given template, that starts out being owned by the given pubkey.</p>
|
||||
@ -93,9 +118,12 @@ Note that the wallet list is not updated: its up to you to do that.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-fungible-asset/verify.html">verify</a></td>
|
||||
<a href="../../com.r3corda.core.contracts.clauses/-clause-verifier/verify.html">verify</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">verify</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.FungibleAsset$verify(com.r3corda.core.contracts.TransactionForContract)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>This is the function EVERYONE runs</p>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">verify</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.core.contracts.clauses.ClauseVerifier$verify(com.r3corda.core.contracts.TransactionForContract)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>Takes an object that represents a state transition, and ensures the inputs/outputs/commands make sense.
|
||||
Must throw an exception if theres a problem that should prevent state transition. Takes a single object
|
||||
rather than an argument so that additional data can be added without breaking binary compatibility with
|
||||
existing contract code.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -10,9 +10,9 @@
|
||||
<a name="com.r3corda.contracts.asset$DUMMY_CASH_ISSUER"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">DUMMY_CASH_ISSUER</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><br/>
|
||||
<p>A dummy, randomly generated issuer party by the name of "Snake Oil Issuer"</p>
|
||||
<strong>Getter</strong><br/>
|
||||
<p><strong>Getter</strong><br/>
|
||||
<p>A dummy, randomly generated issuer party by the name of "Snake Oil Issuer"</p>
|
||||
<br/>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -10,9 +10,9 @@
|
||||
<a name="com.r3corda.contracts.asset$DUMMY_CASH_ISSUER_KEY"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">DUMMY_CASH_ISSUER_KEY</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><br/>
|
||||
<p>A randomly generated key.</p>
|
||||
<strong>Getter</strong><br/>
|
||||
<p><strong>Getter</strong><br/>
|
||||
<p>A randomly generated key.</p>
|
||||
<br/>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -34,6 +34,14 @@ in some other way.</p>
|
||||
in some other way.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../../-obligation/-commands/-exit/index.html">Exit</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Exit</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../../-obligation/-commands/index.html"><span class="identifier">Commands</span></a><span class="symbol">, </span><span class="identifier">Exit</span><span class="symbol"><</span><a href="../../../-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span></code><p>A command stating that the debt is being released by the beneficiary. Normally would indicate
|
||||
either settlement outside of the ledger, or that the obligor is unable to pay.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
|
||||
@ -34,6 +34,14 @@ has a unique ID even when there are no inputs.</p>
|
||||
has a unique ID even when there are no inputs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../-obligation/-commands/-issue/index.html">Issue</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Issue</span> <span class="symbol">:</span> <span class="identifier">Issue</span><span class="symbol">, </span><a href="../../-obligation/-commands/index.html"><span class="identifier">Commands</span></a></code><p>Allows new obligation 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>
|
||||
</BODY>
|
||||
|
||||
@ -33,6 +33,13 @@ order to settle an obligation contracts state object(s).</p>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Move</span> <span class="symbol">:</span> <span class="identifier">Move</span><span class="symbol">, </span><a href="../../-cash/-commands/index.html"><span class="identifier">Commands</span></a></code><p>A command stating that money has been moved, optionally to fulfil another contract.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../-obligation/-commands/-move/index.html">Move</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Move</span> <span class="symbol">:</span> <a href="../../-obligation/-commands/index.html"><span class="identifier">Commands</span></a><span class="symbol">, </span><span class="identifier">Move</span></code><p>A command stating that a debt has been moved, optionally to fulfil another contract.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
|
||||
@ -42,6 +42,18 @@ has a unique ID even when there are no inputs.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../-cash/-commands/index.html">Commands</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <span class="identifier">Commands</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../-obligation/-commands/index.html">Commands</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <span class="identifier">Commands</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-exit/index.html">Exit</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Exit</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Commands</span></code><p>A command stating that money has been withdrawn from the shared ledger and is now accounted for
|
||||
|
||||
@ -7,14 +7,15 @@
|
||||
<a href="../index.html">com.r3corda.contracts.asset</a> / <a href=".">FungibleAsset</a><br/>
|
||||
<br/>
|
||||
<h1>FungibleAsset</h1>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">FungibleAsset</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-contract/index.html"><span class="identifier">Contract</span></a></code><br/>
|
||||
<p>Superclass for contracts representing assets which are fungible, countable and issued by a specific party. States
|
||||
contain assets which are equivalent (such as cash of the same currency), so records of their existence can
|
||||
be merged or split as needed where the issuer is the same. For instance, dollars issued by the Fed are fungible and
|
||||
countable (in cents), barrels of West Texas crude are fungible and countable (oil from two small containers
|
||||
can be poured into one large container), shares of the same class in a specific company are fungible and
|
||||
countable, and so on.</p>
|
||||
<p>See <a href="../-cash/index.html">Cash</a> for an example subclass that implements currency.</p>
|
||||
<code><span class="keyword">interface </span><span class="identifier">FungibleAsset</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-ownable-state/index.html"><span class="identifier">OwnableState</span></a></code><br/>
|
||||
<p>Interface for contract states representing assets which are fungible, countable and issued by a
|
||||
specific party. States contain assets which are equivalent (such as cash of the same currency),
|
||||
so records of their existence can be merged or split as needed where the issuer is the same. For
|
||||
instance, dollars issued by the Fed are fungible and countable (in cents), barrels of West Texas
|
||||
crude are fungible and countable (oil from two small containers can be poured into one large
|
||||
container), shares of the same class in a specific company are fungible and countable, and so on.</p>
|
||||
<p>See <a href="../-cash/index.html">Cash</a> for an example contract that implements currency using state objects that implement
|
||||
this interface.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Parameters</h3>
|
||||
@ -32,41 +33,43 @@ countable, and so on.</p>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-state/index.html">State</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">State</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../-fungible-asset-state/index.html"><span class="identifier">FungibleAssetState</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">,</span> <a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">></span></code><p>A state representing a cash claim against some party</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Constructors</h3>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<a href="amount.html">amount</a></td>
|
||||
<td>
|
||||
<code><span class="identifier">FungibleAsset</span><span class="symbol">(</span><span class="symbol">)</span></code><p>Superclass for contracts representing assets which are fungible, countable and issued by a specific party. States
|
||||
contain assets which are equivalent (such as cash of the same currency), so records of their existence can
|
||||
be merged or split as needed where the issuer is the same. For instance, dollars issued by the Fed are fungible and
|
||||
countable (in cents), barrels of West Texas crude are fungible and countable (oil from two small containers
|
||||
can be poured into one large container), shares of the same class in a specific company are fungible and
|
||||
countable, and so on.</p>
|
||||
</td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../com.r3corda.core.contracts/-contract/legal-contract-reference.html">legalContractReference</a></td>
|
||||
<a href="deposit.html">deposit</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">legalContractReference</span><span class="symbol">: </span><a href="../../com.r3corda.core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><p>Unparsed reference to the natural language contract that this code is supposed to express (usually a hash of
|
||||
the contracts contents).</p>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">deposit</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a></code><p>Where the underlying asset backing this ledger entry can be found. The reference
|
||||
is only intended for use by the issuer, and is not intended to be meaningful to others.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="exit-keys.html">exitKeys</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">exitKeys</span><span class="symbol">: </span><span class="identifier">Collection</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><span class="symbol">></span></code><p>There must be an ExitCommand signed by these keys to destroy the amount</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="issuance-def.html">issuanceDef</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">val </span><span class="identifier">issuanceDef</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="owner.html">owner</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <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>
|
||||
@ -76,9 +79,32 @@ the contracts contents).</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="verify.html">verify</a></td>
|
||||
<a href="move.html">move</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">verify</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.FungibleAsset$verify(com.r3corda.core.contracts.TransactionForContract)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>This is the function EVERYONE runs</p>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">move</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.FungibleAsset$move(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.FungibleAsset.T)))), java.security.PublicKey)/newAmount">newAmount</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.FungibleAsset$move(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.FungibleAsset.T)))), java.security.PublicKey)/newOwner">newOwner</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><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">FungibleAsset</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../com.r3corda.core.contracts/-ownable-state/with-new-owner.html">withNewOwner</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">withNewOwner</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.core.contracts.OwnableState$withNewOwner(java.security.PublicKey)/newOwner">newOwner</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><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a><span class="symbol">,</span> <a href="../../com.r3corda.core.contracts/-ownable-state/index.html"><span class="identifier">OwnableState</span></a><span class="symbol">></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>
|
||||
<h3>Extension Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../com.r3corda.core.contracts/hash.html">hash</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">.</span><span class="identifier">hash</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><p>Returns the SHA-256 hash of the serialised contents of this state (not cached)</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -88,12 +114,18 @@ the contracts contents).</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-cash/index.html">Cash</a></td>
|
||||
<a href="../-cash/-state/index.html">State</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Cash</span> <span class="symbol">:</span> <span class="identifier">FungibleAsset</span><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><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>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">State</span> <span class="symbol">:</span> <span class="identifier">FungibleAsset</span><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><p>A state representing a cash claim against some party</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-obligation/-state/index.html">State</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">State</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">FungibleAsset</span><span class="symbol"><</span><a href="../-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><a href="../../com.r3corda.core.contracts/-nettable-state.html"><span class="identifier">NettableState</span></a><span class="symbol"><</span><a href="../-obligation/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">,</span> <a href="../../com.r3corda.contracts.clause/-multilateral-net-state/index.html"><span class="identifier">MultilateralNetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span></code><p>A state representing the obligation of one party (obligor) to deliver a specified number of
|
||||
units of an underlying asset (described as token.acceptableIssuedProducts) to the beneficiary
|
||||
no later than the specified time.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
<br/>
|
||||
<h1>OBLIGATION_DEF</h1>
|
||||
<a name="com.r3corda.contracts.asset$OBLIGATION_DEF#com.r3corda.core.contracts.Issued((java.util.Currency))"></a>
|
||||
<code><span class="keyword">val </span><a href="../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">OBLIGATION_DEF</span><span class="symbol">: </span><a href="-obligation/-state-template/index.html"><span class="identifier">StateTemplate</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">val </span><a href="../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">OBLIGATION_DEF</span><span class="symbol">: </span><a href="-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../../../index.html">com.r3corda.contracts.asset</a> / <a href="../../index.html">Obligation</a> / <a href="../index.html">Commands</a> / <a href="index.html">Exit</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Exit</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Exit$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.Exit.P)), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.Obligation.Commands.Exit.P)))/aggregateState">aggregateState</span><span class="symbol">:</span> <a href="../../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Exit$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.Exit.P)), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.Obligation.Commands.Exit.P)))/amount">amount</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">)</span></code><br/>
|
||||
<code><span class="identifier">Exit</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Exit$<init>(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.Commands.Exit.P)))))))/amount">amount</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span></code><br/>
|
||||
<p>A command stating that the debt is being released by the beneficiary. Normally would indicate
|
||||
either settlement outside of the ledger, or that the obligor is unable to pay.</p>
|
||||
<br/>
|
||||
|
||||
@ -8,7 +8,8 @@
|
||||
<br/>
|
||||
<h1>amount</h1>
|
||||
<a name="com.r3corda.contracts.asset.Obligation.Commands.Exit$amount"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../../../-fungible-asset/-commands/-exit/amount.html">Exit.amount</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../../../index.html">com.r3corda.contracts.asset</a> / <a href="../../index.html">Obligation</a> / <a href="../index.html">Commands</a> / <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><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../index.html"><span class="identifier">Commands</span></a><span class="symbol">, </span><a href="../../-issuance-commands/index.html"><span class="identifier">IssuanceCommands</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Exit</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../index.html"><span class="identifier">Commands</span></a><span class="symbol">, </span><a href="../../../-fungible-asset/-commands/-exit/index.html"><span class="identifier">Exit</span></a><span class="symbol"><</span><a href="../../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
<p>A command stating that the debt is being released by the beneficiary. Normally would indicate
|
||||
either settlement outside of the ledger, or that the obligor is unable to pay.</p>
|
||||
<br/>
|
||||
@ -19,7 +19,7 @@ either settlement outside of the ledger, or that the obligor is unable to pay.</
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">Exit</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Exit$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.Exit.P)), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.Obligation.Commands.Exit.P)))/aggregateState">aggregateState</span><span class="symbol">:</span> <a href="../../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Exit$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.Exit.P)), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.Obligation.Commands.Exit.P)))/amount">amount</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">)</span></code><p>A command stating that the debt is being released by the beneficiary. Normally would indicate
|
||||
<code><span class="identifier">Exit</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Exit$<init>(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.Commands.Exit.P)))))))/amount">amount</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span></code><p>A command stating that the debt is being released by the beneficiary. Normally would indicate
|
||||
either settlement outside of the ledger, or that the obligor is unable to pay.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -30,15 +30,9 @@ either settlement outside of the ledger, or that the obligor is unable to pay.</
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="aggregate-state.html">aggregateState</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">aggregateState</span><span class="symbol">: </span><a href="../../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<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="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code></td>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../../../index.html">com.r3corda.contracts.asset</a> / <a href="../../index.html">Obligation</a> / <a href="../index.html">Commands</a> / <a href="index.html">Issue</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Issue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Issue$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.Issue.P)), kotlin.Long)/aggregateState">aggregateState</span><span class="symbol">:</span> <a href="../../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Issue$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.Issue.P)), kotlin.Long)/nonce">nonce</span><span class="symbol">:</span> <span class="identifier">Long</span> <span class="symbol">=</span> random63BitValue()<span class="symbol">)</span></code><br/>
|
||||
<code><span class="identifier">Issue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Issue$<init>(kotlin.Long)/nonce">nonce</span><span class="symbol">:</span> <span class="identifier">Long</span> <span class="symbol">=</span> random63BitValue()<span class="symbol">)</span></code><br/>
|
||||
<p>Allows new obligation 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/>
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../../../index.html">com.r3corda.contracts.asset</a> / <a href="../../index.html">Obligation</a> / <a href="../index.html">Commands</a> / <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><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../index.html"><span class="identifier">Commands</span></a><span class="symbol">, </span><a href="../../-issuance-commands/index.html"><span class="identifier">IssuanceCommands</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Issue</span> <span class="symbol">:</span> <a href="../../../-fungible-asset/-commands/-issue.html"><span class="identifier">Issue</span></a><span class="symbol">, </span><a href="../index.html"><span class="identifier">Commands</span></a></code><br/>
|
||||
<p>Allows new obligation 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/>
|
||||
@ -19,7 +19,7 @@ transaction has a unique ID even when there are no inputs.</p>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">Issue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Issue$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.Issue.P)), kotlin.Long)/aggregateState">aggregateState</span><span class="symbol">:</span> <a href="../../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Issue$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.Issue.P)), kotlin.Long)/nonce">nonce</span><span class="symbol">:</span> <span class="identifier">Long</span> <span class="symbol">=</span> random63BitValue()<span class="symbol">)</span></code><p>Allows new obligation states to be issued into existence: the nonce ("number used once") ensures the
|
||||
<code><span class="identifier">Issue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Issue$<init>(kotlin.Long)/nonce">nonce</span><span class="symbol">:</span> <span class="identifier">Long</span> <span class="symbol">=</span> random63BitValue()<span class="symbol">)</span></code><p>Allows new obligation 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>
|
||||
@ -30,12 +30,6 @@ transaction has a unique ID even when there are no inputs.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="aggregate-state.html">aggregateState</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">aggregateState</span><span class="symbol">: </span><a href="../../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<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>
|
||||
|
||||
@ -9,6 +9,7 @@
|
||||
<h1>nonce</h1>
|
||||
<a name="com.r3corda.contracts.asset.Obligation.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/>
|
||||
Overrides <a href="../../../../com.r3corda.core.contracts/-issue-command/nonce.html">IssueCommand.nonce</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../../../index.html">com.r3corda.contracts.asset</a> / <a href="../../index.html">Obligation</a> / <a href="../index.html">Commands</a> / <a href="index.html">Move</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Move</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Move$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.Move.P)), com.r3corda.core.crypto.SecureHash)/aggregateState">aggregateState</span><span class="symbol">:</span> <a href="../../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Move$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.Move.P)), com.r3corda.core.crypto.SecureHash)/contractHash">contractHash</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span></code><br/>
|
||||
<code><span class="identifier">Move</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Move$<init>(com.r3corda.core.crypto.SecureHash)/contractHash">contractHash</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span></code><br/>
|
||||
<p>A command stating that a debt has been moved, optionally to fulfil another contract.</p>
|
||||
<h3>Parameters</h3>
|
||||
<a name="contractHash"></a>
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../../../index.html">com.r3corda.contracts.asset</a> / <a href="../../index.html">Obligation</a> / <a href="../index.html">Commands</a> / <a href=".">Move</a><br/>
|
||||
<br/>
|
||||
<h1>Move</h1>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Move</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../index.html"><span class="identifier">Commands</span></a><span class="symbol">, </span><a href="../../-issuance-commands/index.html"><span class="identifier">IssuanceCommands</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><a href="../../../../com.r3corda.core.contracts/-move-command/index.html"><span class="identifier">MoveCommand</span></a></code><br/>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Move</span> <span class="symbol">:</span> <a href="../index.html"><span class="identifier">Commands</span></a><span class="symbol">, </span><a href="../../../-fungible-asset/-commands/-move.html"><span class="identifier">Move</span></a></code><br/>
|
||||
<p>A command stating that a debt has been moved, optionally to fulfil another contract.</p>
|
||||
<h3>Parameters</h3>
|
||||
<a name="contractHash"></a>
|
||||
@ -23,7 +23,7 @@ null.<br/>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">Move</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Move$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.Move.P)), com.r3corda.core.crypto.SecureHash)/aggregateState">aggregateState</span><span class="symbol">:</span> <a href="../../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Move$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.Move.P)), com.r3corda.core.crypto.SecureHash)/contractHash">contractHash</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span></code><p>A command stating that a debt has been moved, optionally to fulfil another contract.</p>
|
||||
<code><span class="identifier">Move</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Move$<init>(com.r3corda.core.crypto.SecureHash)/contractHash">contractHash</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">?</span> <span class="symbol">=</span> null<span class="symbol">)</span></code><p>A command stating that a debt has been moved, optionally to fulfil another contract.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -33,12 +33,6 @@ null.<br/>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="aggregate-state.html">aggregateState</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">aggregateState</span><span class="symbol">: </span><a href="../../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="contract-hash.html">contractHash</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">contractHash</span><span class="symbol">: </span><a href="../../../../com.r3corda.core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">?</span></code><p>Contract code the moved state(s) are for the attention of, for example to indicate that the states are moved in
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../../../index.html">com.r3corda.contracts.asset</a> / <a href="../../index.html">Obligation</a> / <a href="../index.html">Commands</a> / <a href="index.html">SetLifecycle</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">SetLifecycle</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle.P)), com.r3corda.contracts.asset.Obligation.Lifecycle)/aggregateState">aggregateState</span><span class="symbol">:</span> <a href="../../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle.P)), com.r3corda.contracts.asset.Obligation.Lifecycle)/lifecycle">lifecycle</span><span class="symbol">:</span> <a href="../../-lifecycle/index.html"><span class="identifier">Lifecycle</span></a><span class="symbol">)</span></code><br/>
|
||||
<code><span class="identifier">SetLifecycle</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle)/lifecycle">lifecycle</span><span class="symbol">:</span> <a href="../../-lifecycle/index.html"><span class="identifier">Lifecycle</span></a><span class="symbol">)</span></code><br/>
|
||||
<p>A command stating that the beneficiary is moving the contract into the defaulted state as it has not been settled
|
||||
by the due date, or resetting a defaulted contract back to the issued state.</p>
|
||||
<br/>
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../../../index.html">com.r3corda.contracts.asset</a> / <a href="../../index.html">Obligation</a> / <a href="../index.html">Commands</a> / <a href=".">SetLifecycle</a><br/>
|
||||
<br/>
|
||||
<h1>SetLifecycle</h1>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">SetLifecycle</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../index.html"><span class="identifier">Commands</span></a><span class="symbol">, </span><a href="../../-issuance-commands/index.html"><span class="identifier">IssuanceCommands</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">SetLifecycle</span> <span class="symbol">:</span> <a href="../index.html"><span class="identifier">Commands</span></a></code><br/>
|
||||
<p>A command stating that the beneficiary is moving the contract into the defaulted state as it has not been settled
|
||||
by the due date, or resetting a defaulted contract back to the issued state.</p>
|
||||
<br/>
|
||||
@ -19,7 +19,7 @@ by the due date, or resetting a defaulted contract back to the issued state.</p>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">SetLifecycle</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle.P)), com.r3corda.contracts.asset.Obligation.Lifecycle)/aggregateState">aggregateState</span><span class="symbol">:</span> <a href="../../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle.P)), com.r3corda.contracts.asset.Obligation.Lifecycle)/lifecycle">lifecycle</span><span class="symbol">:</span> <a href="../../-lifecycle/index.html"><span class="identifier">Lifecycle</span></a><span class="symbol">)</span></code><p>A command stating that the beneficiary is moving the contract into the defaulted state as it has not been settled
|
||||
<code><span class="identifier">SetLifecycle</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle)/lifecycle">lifecycle</span><span class="symbol">:</span> <a href="../../-lifecycle/index.html"><span class="identifier">Lifecycle</span></a><span class="symbol">)</span></code><p>A command stating that the beneficiary is moving the contract into the defaulted state as it has not been settled
|
||||
by the due date, or resetting a defaulted contract back to the issued state.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -30,12 +30,6 @@ by the due date, or resetting a defaulted contract back to the issued state.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="aggregate-state.html">aggregateState</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">aggregateState</span><span class="symbol">: </span><a href="../../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="inverse.html">inverse</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">inverse</span><span class="symbol">: </span><a href="../../-lifecycle/index.html"><span class="identifier">Lifecycle</span></a></code></td>
|
||||
|
||||
@ -7,12 +7,12 @@
|
||||
<a href="../../../index.html">com.r3corda.contracts.asset</a> / <a href="../../index.html">Obligation</a> / <a href="../index.html">Commands</a> / <a href="index.html">Settle</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Settle</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Settle$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.Settle.P)), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.Obligation.Commands.Settle.P)))/aggregateState">aggregateState</span><span class="symbol">:</span> <a href="../../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Settle$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.Settle.P)), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.Obligation.Commands.Settle.P)))/amount">amount</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">)</span></code><br/>
|
||||
<code><span class="identifier">Settle</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Settle$<init>(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.Commands.Settle.P)))))))/amount">amount</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span></code><br/>
|
||||
<p>A command stating that the obligor is settling some or all of the amount owed by transferring a suitable
|
||||
state object to the beneficiary. If this reduces the balance to zero, the state object is destroyed.</p>
|
||||
<strong>See Also</strong><br/>
|
||||
<p><strong>See Also</strong><br/>
|
||||
<p><a href="../../../../com.r3corda.core.contracts/-move-command/index.html">MoveCommand</a></p>
|
||||
<br/>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
<br/>
|
||||
<h1>amount</h1>
|
||||
<a name="com.r3corda.contracts.asset.Obligation.Commands.Settle$amount"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,12 +7,12 @@
|
||||
<a href="../../../index.html">com.r3corda.contracts.asset</a> / <a href="../../index.html">Obligation</a> / <a href="../index.html">Commands</a> / <a href=".">Settle</a><br/>
|
||||
<br/>
|
||||
<h1>Settle</h1>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Settle</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../index.html"><span class="identifier">Commands</span></a><span class="symbol">, </span><a href="../../-issuance-commands/index.html"><span class="identifier">IssuanceCommands</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Settle</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../index.html"><span class="identifier">Commands</span></a></code><br/>
|
||||
<p>A command stating that the obligor is settling some or all of the amount owed by transferring a suitable
|
||||
state object to the beneficiary. If this reduces the balance to zero, the state object is destroyed.</p>
|
||||
<strong>See Also</strong><br/>
|
||||
<p><strong>See Also</strong><br/>
|
||||
<p><a href="../../../../com.r3corda.core.contracts/-move-command/index.html">MoveCommand</a></p>
|
||||
<br/>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
@ -22,7 +22,7 @@ state object to the beneficiary. If this reduces the balance to zero, the state
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">Settle</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Settle$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.Settle.P)), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.Obligation.Commands.Settle.P)))/aggregateState">aggregateState</span><span class="symbol">:</span> <a href="../../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Settle$<init>(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.Obligation.Commands.Settle.P)), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.Obligation.Commands.Settle.P)))/amount">amount</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">)</span></code><p>A command stating that the obligor is settling some or all of the amount owed by transferring a suitable
|
||||
<code><span class="identifier">Settle</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.Commands.Settle$<init>(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.Commands.Settle.P)))))))/amount">amount</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span></code><p>A command stating that the obligor is settling some or all of the amount owed by transferring a suitable
|
||||
state object to the beneficiary. If this reduces the balance to zero, the state object is destroyed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -33,15 +33,9 @@ state object to the beneficiary. If this reduces the balance to zero, the state
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="aggregate-state.html">aggregateState</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">aggregateState</span><span class="symbol">: </span><a href="../../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<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="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code></td>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../../index.html">com.r3corda.contracts.asset</a> / <a href="../index.html">Obligation</a> / <a href=".">Commands</a><br/>
|
||||
<br/>
|
||||
<h1>Commands</h1>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a></code><br/>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <a href="../../-fungible-asset/-commands/index.html"><span class="identifier">Commands</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Types</h3>
|
||||
@ -17,7 +17,7 @@
|
||||
<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><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Commands</span><span class="symbol">, </span><a href="../-issuance-commands/index.html"><span class="identifier">IssuanceCommands</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>A command stating that the debt is being released by the beneficiary. Normally would indicate
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Exit</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Commands</span><span class="symbol">, </span><a href="../../-fungible-asset/-commands/-exit/index.html"><span class="identifier">Exit</span></a><span class="symbol"><</span><a href="../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span></code><p>A command stating that the debt is being released by the beneficiary. Normally would indicate
|
||||
either settlement outside of the ledger, or that the obligor is unable to pay.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -25,7 +25,7 @@ either settlement outside of the ledger, or that the obligor is unable to pay.</
|
||||
<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><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Commands</span><span class="symbol">, </span><a href="../-issuance-commands/index.html"><span class="identifier">IssuanceCommands</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>Allows new obligation states to be issued into existence: the nonce ("number used once") ensures the
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Issue</span> <span class="symbol">:</span> <a href="../../-fungible-asset/-commands/-issue.html"><span class="identifier">Issue</span></a><span class="symbol">, </span><span class="identifier">Commands</span></code><p>Allows new obligation 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>
|
||||
@ -33,7 +33,7 @@ transaction has a unique ID even when there are no inputs.</p>
|
||||
<td>
|
||||
<a href="-move/index.html">Move</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Move</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Commands</span><span class="symbol">, </span><a href="../-issuance-commands/index.html"><span class="identifier">IssuanceCommands</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><a href="../../../com.r3corda.core.contracts/-move-command/index.html"><span class="identifier">MoveCommand</span></a></code><p>A command stating that a debt has been moved, optionally to fulfil another contract.</p>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Move</span> <span class="symbol">:</span> <span class="identifier">Commands</span><span class="symbol">, </span><a href="../../-fungible-asset/-commands/-move.html"><span class="identifier">Move</span></a></code><p>A command stating that a debt has been moved, optionally to fulfil another contract.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -48,7 +48,7 @@ as only the beneficiary (not the obligor) needs to sign.</p>
|
||||
<td>
|
||||
<a href="-set-lifecycle/index.html">SetLifecycle</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">SetLifecycle</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Commands</span><span class="symbol">, </span><a href="../-issuance-commands/index.html"><span class="identifier">IssuanceCommands</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>A command stating that the beneficiary is moving the contract into the defaulted state as it has not been settled
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">SetLifecycle</span> <span class="symbol">:</span> <span class="identifier">Commands</span></code><p>A command stating that the beneficiary is moving the contract into the defaulted state as it has not been settled
|
||||
by the due date, or resetting a defaulted contract back to the issued state.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -56,7 +56,7 @@ by the due date, or resetting a defaulted contract back to the issued state.</p>
|
||||
<td>
|
||||
<a href="-settle/index.html">Settle</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Settle</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Commands</span><span class="symbol">, </span><a href="../-issuance-commands/index.html"><span class="identifier">IssuanceCommands</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>A command stating that the obligor is settling some or all of the amount owed by transferring a suitable
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Settle</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Commands</span></code><p>A command stating that the obligor is settling some or all of the amount owed by transferring a suitable
|
||||
state object to the beneficiary. If this reduces the balance to zero, the state object is destroyed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -69,7 +69,7 @@ state object to the beneficiary. If this reduces the balance to zero, the state
|
||||
<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><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Commands</span><span class="symbol">, </span><a href="../-issuance-commands/index.html"><span class="identifier">IssuanceCommands</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>A command stating that the debt is being released by the beneficiary. Normally would indicate
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Exit</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Commands</span><span class="symbol">, </span><a href="../../-fungible-asset/-commands/-exit/index.html"><span class="identifier">Exit</span></a><span class="symbol"><</span><a href="../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span></code><p>A command stating that the debt is being released by the beneficiary. Normally would indicate
|
||||
either settlement outside of the ledger, or that the obligor is unable to pay.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -77,7 +77,7 @@ either settlement outside of the ledger, or that the obligor is unable to pay.</
|
||||
<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><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Commands</span><span class="symbol">, </span><a href="../-issuance-commands/index.html"><span class="identifier">IssuanceCommands</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>Allows new obligation states to be issued into existence: the nonce ("number used once") ensures the
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Issue</span> <span class="symbol">:</span> <a href="../../-fungible-asset/-commands/-issue.html"><span class="identifier">Issue</span></a><span class="symbol">, </span><span class="identifier">Commands</span></code><p>Allows new obligation 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>
|
||||
@ -85,7 +85,7 @@ transaction has a unique ID even when there are no inputs.</p>
|
||||
<td>
|
||||
<a href="-move/index.html">Move</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Move</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Commands</span><span class="symbol">, </span><a href="../-issuance-commands/index.html"><span class="identifier">IssuanceCommands</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><a href="../../../com.r3corda.core.contracts/-move-command/index.html"><span class="identifier">MoveCommand</span></a></code><p>A command stating that a debt has been moved, optionally to fulfil another contract.</p>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Move</span> <span class="symbol">:</span> <span class="identifier">Commands</span><span class="symbol">, </span><a href="../../-fungible-asset/-commands/-move.html"><span class="identifier">Move</span></a></code><p>A command stating that a debt has been moved, optionally to fulfil another contract.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -100,7 +100,7 @@ as only the beneficiary (not the obligor) needs to sign.</p>
|
||||
<td>
|
||||
<a href="-set-lifecycle/index.html">SetLifecycle</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">SetLifecycle</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Commands</span><span class="symbol">, </span><a href="../-issuance-commands/index.html"><span class="identifier">IssuanceCommands</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>A command stating that the beneficiary is moving the contract into the defaulted state as it has not been settled
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">SetLifecycle</span> <span class="symbol">:</span> <span class="identifier">Commands</span></code><p>A command stating that the beneficiary is moving the contract into the defaulted state as it has not been settled
|
||||
by the due date, or resetting a defaulted contract back to the issued state.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -108,7 +108,7 @@ by the due date, or resetting a defaulted contract back to the issued state.</p>
|
||||
<td>
|
||||
<a href="-settle/index.html">Settle</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Settle</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Commands</span><span class="symbol">, </span><a href="../-issuance-commands/index.html"><span class="identifier">IssuanceCommands</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>A command stating that the obligor is settling some or all of the amount owed by transferring a suitable
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Settle</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">Commands</span></code><p>A command stating that the obligor is settling some or all of the amount owed by transferring a suitable
|
||||
state object to the beneficiary. If this reduces the balance to zero, the state object is destroyed.</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
@ -7,9 +7,9 @@
|
||||
<a href="../../index.html">com.r3corda.contracts.asset</a> / <a href="../index.html">Obligation</a> / <a href="index.html">State</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">State</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/lifecycle">lifecycle</span><span class="symbol">:</span> <a href="../-lifecycle/index.html"><span class="identifier">Lifecycle</span></a> <span class="symbol">=</span> Lifecycle.NORMAL<span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/obligor">obligor</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/template">template</span><span class="symbol">:</span> <a href="../-state-template/index.html"><span class="identifier">StateTemplate</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/quantity">quantity</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/beneficiary">beneficiary</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><span class="symbol">)</span></code><br/>
|
||||
<code><span class="identifier">State</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/lifecycle">lifecycle</span><span class="symbol">:</span> <a href="../-lifecycle/index.html"><span class="identifier">Lifecycle</span></a> <span class="symbol">=</span> Lifecycle.NORMAL<span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/obligor">obligor</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/template">template</span><span class="symbol">:</span> <a href="../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/quantity">quantity</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/beneficiary">beneficiary</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><span class="symbol">)</span></code><br/>
|
||||
<p>A state representing the obligation of one party (obligor) to deliver a specified number of
|
||||
units of an underlying asset (described as issuanceDef.acceptableIssuedProducts) to the beneficiary
|
||||
units of an underlying asset (described as token.acceptableIssuedProducts) to the beneficiary
|
||||
no later than the specified time.</p>
|
||||
<h3>Parameters</h3>
|
||||
<a name="P"></a>
|
||||
|
||||
@ -8,7 +8,8 @@
|
||||
<br/>
|
||||
<h1>amount</h1>
|
||||
<a name="com.r3corda.contracts.asset.Obligation.State$amount"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../../-fungible-asset/amount.html">FungibleAsset.amount</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -8,14 +8,14 @@
|
||||
<br/>
|
||||
<h1>bilateralNetState</h1>
|
||||
<a name="com.r3corda.contracts.asset.Obligation.State$bilateralNetState"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">bilateralNetState</span><span class="symbol">: </span><a href="../-bilateral-net-state/index.html"><span class="identifier">BilateralNetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">val </span><span class="identifier">bilateralNetState</span><span class="symbol">: </span><a href="../../../com.r3corda.contracts.clause/-bilateral-net-state/index.html"><span class="identifier">BilateralNetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.core.contracts/-bilateral-nettable-state/bilateral-net-state.html">BilateralNettableState.bilateralNetState</a><br/>
|
||||
<p>Returns an object used to determine if two states can be subject to close-out netting. If two states return
|
||||
equal objects, they can be close out netted together.</p>
|
||||
<strong>Getter</strong><br/>
|
||||
<p><strong>Getter</strong><br/>
|
||||
<p>Returns an object used to determine if two states can be subject to close-out netting. If two states return
|
||||
equal objects, they can be close out netted together.</p>
|
||||
<br/>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,9 +7,9 @@
|
||||
<a href="../../index.html">com.r3corda.contracts.asset</a> / <a href="../index.html">Obligation</a> / <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><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../-fungible-asset-state/index.html"><span class="identifier">FungibleAssetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">,</span> <a href="../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><a href="../../../com.r3corda.core.contracts/-bilateral-nettable-state/index.html"><span class="identifier">BilateralNettableState</span></a><span class="symbol"><</span><span class="identifier">State</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">State</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><a href="../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><a href="../../../com.r3corda.core.contracts/-nettable-state.html"><span class="identifier">NettableState</span></a><span class="symbol"><</span><span class="identifier">State</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">,</span> <a href="../../../com.r3corda.contracts.clause/-multilateral-net-state/index.html"><span class="identifier">MultilateralNetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
<p>A state representing the obligation of one party (obligor) to deliver a specified number of
|
||||
units of an underlying asset (described as issuanceDef.acceptableIssuedProducts) to the beneficiary
|
||||
units of an underlying asset (described as token.acceptableIssuedProducts) to the beneficiary
|
||||
no later than the specified time.</p>
|
||||
<h3>Parameters</h3>
|
||||
<a name="P"></a>
|
||||
@ -23,8 +23,8 @@ no later than the specified time.</p>
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">State</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/lifecycle">lifecycle</span><span class="symbol">:</span> <a href="../-lifecycle/index.html"><span class="identifier">Lifecycle</span></a> <span class="symbol">=</span> Lifecycle.NORMAL<span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/obligor">obligor</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/template">template</span><span class="symbol">:</span> <a href="../-state-template/index.html"><span class="identifier">StateTemplate</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/quantity">quantity</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/beneficiary">beneficiary</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><span class="symbol">)</span></code><p>A state representing the obligation of one party (obligor) to deliver a specified number of
|
||||
units of an underlying asset (described as issuanceDef.acceptableIssuedProducts) to the beneficiary
|
||||
<code><span class="identifier">State</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/lifecycle">lifecycle</span><span class="symbol">:</span> <a href="../-lifecycle/index.html"><span class="identifier">Lifecycle</span></a> <span class="symbol">=</span> Lifecycle.NORMAL<span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/obligor">obligor</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/template">template</span><span class="symbol">:</span> <a href="../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/quantity">quantity</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$<init>(com.r3corda.contracts.asset.Obligation.Lifecycle, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.State.P)), kotlin.Long, java.security.PublicKey)/beneficiary">beneficiary</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><span class="symbol">)</span></code><p>A state representing the obligation of one party (obligor) to deliver a specified number of
|
||||
units of an underlying asset (described as token.acceptableIssuedProducts) to the beneficiary
|
||||
no later than the specified time.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -35,27 +35,9 @@ no later than the specified time.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="acceptable-contracts.html">acceptableContracts</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">acceptableContracts</span><span class="symbol">: </span><a href="../../../com.r3corda.core.utilities/-non-empty-set/index.html"><span class="identifier">NonEmptySet</span></a><span class="symbol"><</span><a href="../../../com.r3corda.core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="acceptable-issuance-definitions.html">acceptableIssuanceDefinitions</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">acceptableIssuanceDefinitions</span><span class="symbol">: </span><a href="../../../com.r3corda.core.utilities/-non-empty-set/index.html"><span class="identifier">NonEmptySet</span></a><span class="symbol"><</span><span class="identifier">*</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="aggregate-state.html">aggregateState</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">aggregateState</span><span class="symbol">: </span><a href="../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<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="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code></td>
|
||||
<code><span class="keyword">val </span><span class="identifier">amount</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
@ -68,7 +50,7 @@ no later than the specified time.</p>
|
||||
<td>
|
||||
<a href="bilateral-net-state.html">bilateralNetState</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">bilateralNetState</span><span class="symbol">: </span><a href="../-bilateral-net-state/index.html"><span class="identifier">BilateralNetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>Returns an object used to determine if two states can be subject to close-out netting. If two states return
|
||||
<code><span class="keyword">val </span><span class="identifier">bilateralNetState</span><span class="symbol">: </span><a href="../../../com.r3corda.contracts.clause/-bilateral-net-state/index.html"><span class="identifier">BilateralNetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>Returns an object used to determine if two states can be subject to close-out netting. If two states return
|
||||
equal objects, they can be close out netted together.</p>
|
||||
</td>
|
||||
</tr>
|
||||
@ -81,15 +63,30 @@ equal objects, they can be close out netted together.</p>
|
||||
</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="../../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a></code><p>Where the underlying asset backing this ledger entry can be found. The reference
|
||||
is only intended for use by the issuer, and is not intended to be meaningful to others.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="due-before.html">dueBefore</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">dueBefore</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="exit-keys.html">exitKeys</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">exitKeys</span><span class="symbol">: </span><span class="identifier">Collection</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><span class="symbol">></span></code><p>There must be an ExitCommand signed by these keys to destroy the amount</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="issuance-def.html">issuanceDef</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">issuanceDef</span><span class="symbol">: </span><a href="../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code></td>
|
||||
<code><span class="keyword">val </span><span class="identifier">issuanceDef</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
@ -101,7 +98,9 @@ equal objects, they can be close out netted together.</p>
|
||||
<td>
|
||||
<a href="multilateral-net-state.html">multilateralNetState</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">multilateralNetState</span><span class="symbol">: </span><a href="../-multilateral-net-state/index.html"><span class="identifier">MultilateralNetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code></td>
|
||||
<code><span class="keyword">val </span><span class="identifier">multilateralNetState</span><span class="symbol">: </span><a href="../../../com.r3corda.contracts.clause/-multilateral-net-state/index.html"><span class="identifier">MultilateralNetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>Returns an object used to determine if two states can be subject to close-out netting. If two states return
|
||||
equal objects, they can be close out netted together.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
@ -126,12 +125,6 @@ equal objects, they can be close out netted together.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="product-amount.html">productAmount</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">productAmount</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="quantity.html">quantity</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">quantity</span><span class="symbol">: </span><span class="identifier">Long</span></code></td>
|
||||
@ -140,7 +133,7 @@ equal objects, they can be close out netted together.</p>
|
||||
<td>
|
||||
<a href="template.html">template</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">template</span><span class="symbol">: </span><a href="../-state-template/index.html"><span class="identifier">StateTemplate</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code></td>
|
||||
<code><span class="keyword">val </span><span class="identifier">template</span><span class="symbol">: </span><a href="../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@ -151,7 +144,7 @@ equal objects, they can be close out netted together.</p>
|
||||
<td>
|
||||
<a href="move.html">move</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">move</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$move(com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.Obligation.State.P)), java.security.PublicKey)/newAmount">newAmount</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$move(com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.Obligation.State.P)), java.security.PublicKey)/newOwner">newOwner</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><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">State</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code></td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">move</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$move(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.State.P)))))), java.security.PublicKey)/newAmount">newAmount</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$move(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.State.P)))))), java.security.PublicKey)/newOwner">newOwner</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><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">State</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
@ -8,8 +8,8 @@
|
||||
<br/>
|
||||
<h1>issuanceDef</h1>
|
||||
<a name="com.r3corda.contracts.asset.Obligation.State$issuanceDef"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">issuanceDef</span><span class="symbol">: </span><a href="../-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../../-fungible-asset-state/issuance-def.html">FungibleAssetState.issuanceDef</a><br/>
|
||||
<code><span class="keyword">val </span><span class="identifier">issuanceDef</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../../-fungible-asset/issuance-def.html">FungibleAsset.issuanceDef</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,8 +7,8 @@
|
||||
<a href="../../index.html">com.r3corda.contracts.asset</a> / <a href="../index.html">Obligation</a> / <a href="index.html">State</a> / <a href=".">move</a><br/>
|
||||
<br/>
|
||||
<h1>move</h1>
|
||||
<a name="com.r3corda.contracts.asset.Obligation.State$move(com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.Obligation.State.P)), java.security.PublicKey)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">move</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$move(com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.Obligation.State.P)), java.security.PublicKey)/newAmount">newAmount</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$move(com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.Obligation.State.P)), java.security.PublicKey)/newOwner">newOwner</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><span class="symbol">)</span><span class="symbol">: </span><a href="index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
<a name="com.r3corda.contracts.asset.Obligation.State$move(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.State.P)))))), java.security.PublicKey)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">move</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$move(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.State.P)))))), java.security.PublicKey)/newAmount">newAmount</span><span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation.State$move(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.State.P)))))), java.security.PublicKey)/newOwner">newOwner</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><span class="symbol">)</span><span class="symbol">: </span><a href="index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -8,7 +8,14 @@
|
||||
<br/>
|
||||
<h1>multilateralNetState</h1>
|
||||
<a name="com.r3corda.contracts.asset.Obligation.State$multilateralNetState"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">multilateralNetState</span><span class="symbol">: </span><a href="../-multilateral-net-state/index.html"><span class="identifier">MultilateralNetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">val </span><span class="identifier">multilateralNetState</span><span class="symbol">: </span><a href="../../../com.r3corda.contracts.clause/-multilateral-net-state/index.html"><span class="identifier">MultilateralNetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.core.contracts/-multilateral-nettable-state/multilateral-net-state.html">MultilateralNettableState.multilateralNetState</a><br/>
|
||||
<p>Returns an object used to determine if two states can be subject to close-out netting. If two states return
|
||||
equal objects, they can be close out netted together.</p>
|
||||
<p><strong>Getter</strong><br/>
|
||||
<p>Returns an object used to determine if two states can be subject to close-out netting. If two states return
|
||||
equal objects, they can be close out netted together.</p>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -9,11 +9,11 @@
|
||||
<h1>owner</h1>
|
||||
<a name="com.r3corda.contracts.asset.Obligation.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="../../../com.r3corda.core.contracts/-ownable-state/owner.html">OwnableState.owner</a><br/>
|
||||
Overrides <a href="../../-fungible-asset/owner.html">FungibleAsset.owner</a><br/>
|
||||
<p>There must be a MoveCommand signed by this key to claim the amount</p>
|
||||
<strong>Getter</strong><br/>
|
||||
<p><strong>Getter</strong><br/>
|
||||
<p>There must be a MoveCommand signed by this key to claim the amount</p>
|
||||
<br/>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -19,7 +19,7 @@ they possess, since someone consumed that state during the notary change process
|
||||
list should just contain the owner.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<strong>Getter</strong><br/>
|
||||
<p><strong>Getter</strong><br/>
|
||||
<p>A <emph>participant</emph> is any party that is able to consume this state in a valid transaction.</p>
|
||||
<p>The list of participants is required for certain types of transactions. For example, when changing the notary
|
||||
for this state (<a href="../../../com.r3corda.core.contracts/-transaction-type/-notary-change/index.html">TransactionType.NotaryChange</a>), every participants has to be involved and approve the transaction
|
||||
@ -27,7 +27,7 @@ so that they receive the updated state, and dont end up in a situation where the
|
||||
they possess, since someone consumed that state during the notary change process.</p>
|
||||
<p>The participants list should normally be derived from the contents of the state. E.g. for <a href="../../-cash/index.html">Cash</a> the participants
|
||||
list should just contain the owner.</p>
|
||||
<br/>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
<br/>
|
||||
<h1>template</h1>
|
||||
<a name="com.r3corda.contracts.asset.Obligation.State$template"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">template</span><span class="symbol">: </span><a href="../-state-template/index.html"><span class="identifier">StateTemplate</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">val </span><span class="identifier">template</span><span class="symbol">: </span><a href="../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,8 +7,8 @@
|
||||
<a href="../index.html">com.r3corda.contracts.asset</a> / <a href="index.html">Obligation</a> / <a href=".">generateIssue</a><br/>
|
||||
<br/>
|
||||
<h1>generateIssue</h1>
|
||||
<a name="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/obligor">obligor</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/issuanceDef">issuanceDef</span><span class="symbol">:</span> <a href="-state-template/index.html"><span class="identifier">StateTemplate</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/pennies">pennies</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/beneficiary">beneficiary</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><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
<a name="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/obligor">obligor</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/issuanceDef">issuanceDef</span><span class="symbol">:</span> <a href="-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/pennies">pennies</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/beneficiary">beneficiary</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><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
<p>Puts together an issuance transaction for the specified amount that starts out being owned by the given pubkey.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
@ -7,8 +7,8 @@
|
||||
<a href="../index.html">com.r3corda.contracts.asset</a> / <a href="index.html">Obligation</a> / <a href=".">generatePaymentNetting</a><br/>
|
||||
<br/>
|
||||
<h1>generatePaymentNetting</h1>
|
||||
<a name="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.P)), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generatePaymentNetting</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.P)), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.P)), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/issued">issued</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.P)), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="keyword">vararg</span> <span class="identifier" id="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.P)), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/states">states</span><span class="symbol">:</span> <a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
<a name="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generatePaymentNetting</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/issued">issued</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="keyword">vararg</span> <span class="identifier" id="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/states">states</span><span class="symbol">:</span> <a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,8 +7,8 @@
|
||||
<a href="../index.html">com.r3corda.contracts.asset</a> / <a href="index.html">Obligation</a> / <a href=".">generateSettle</a><br/>
|
||||
<br/>
|
||||
<h1>generateSettle</h1>
|
||||
<a name="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAssetState((com.r3corda.contracts.asset.Obligation.P, kotlin.Any)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateSettle</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAssetState((com.r3corda.contracts.asset.Obligation.P, kotlin.Any)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAssetState((com.r3corda.contracts.asset.Obligation.P, kotlin.Any)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/statesAndRefs">statesAndRefs</span><span class="symbol">:</span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAssetState((com.r3corda.contracts.asset.Obligation.P, kotlin.Any)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/assetStatesAndRefs">assetStatesAndRefs</span><span class="symbol">:</span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="../-fungible-asset-state/index.html"><span class="identifier">FungibleAssetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">,</span> <span class="identifier">*</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAssetState((com.r3corda.contracts.asset.Obligation.P, kotlin.Any)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/moveCommand">moveCommand</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-move-command/index.html"><span class="identifier">MoveCommand</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAssetState((com.r3corda.contracts.asset.Obligation.P, kotlin.Any)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
<a name="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateSettle</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/statesAndRefs">statesAndRefs</span><span class="symbol">:</span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/assetStatesAndRefs">assetStatesAndRefs</span><span class="symbol">:</span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="../-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/moveCommand">moveCommand</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-move-command/index.html"><span class="identifier">MoveCommand</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
<h3>Parameters</h3>
|
||||
<a name="statesAndRefs"></a>
|
||||
<code>statesAndRefs</code> - a list of state objects, which MUST all have the same aggregate state. This is done as
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../index.html">com.r3corda.contracts.asset</a> / <a href=".">Obligation</a><br/>
|
||||
<br/>
|
||||
<h1>Obligation</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">Obligation</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-contract/index.html"><span class="identifier">Contract</span></a></code><br/>
|
||||
<code><span class="keyword">class </span><span class="identifier">Obligation</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts.clauses/-clause-verifier/index.html"><span class="identifier">ClauseVerifier</span></a></code><br/>
|
||||
<p>An obligation contract commits the obligor to delivering a specified amount of a fungible asset (for example the
|
||||
<a href="../-cash/index.html">Cash</a> contract) at a specified future point in time. Settlement transactions may split and merge contracts across
|
||||
multiple input and output states. The goal of this design is to handle amounts owed, and these contracts are expected
|
||||
@ -22,34 +22,15 @@ to be netted/merged, with settlement only for any remainder amount.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-bilateral-net-state/index.html">BilateralNetState</a></td>
|
||||
<a href="-clauses/index.html">Clauses</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">BilateralNetState</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="-net-state/index.html"><span class="identifier">NetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>Subset of state, containing the elements which must match for two obligation transactions to be nettable.
|
||||
If two obligation state objects produce equal bilateral net states, they are considered safe to net directly.
|
||||
Bilateral states are used in close-out netting.</p>
|
||||
</td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Clauses</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-commands/index.html">Commands</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-issuance-commands/index.html">IssuanceCommands</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">IssuanceCommands</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a></code><p>Interface for commands that apply to states grouped by issuance definition</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-issuance-definition/index.html">IssuanceDefinition</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">IssuanceDefinition</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>Subset of state, containing the elements specified when issuing a new settlement contract.
|
||||
TODO: This needs to be something common to contracts that we can be obliged to pay, and moved
|
||||
out into core accordingly.</p>
|
||||
</td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <a href="../-fungible-asset/-commands/index.html"><span class="identifier">Commands</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
@ -62,38 +43,18 @@ represented by absence of the state on transaction output.</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-multilateral-net-state/index.html">MultilateralNetState</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">MultilateralNetState</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="-net-state/index.html"><span class="identifier">NetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>Subset of state, containing the elements which must match for two or more obligation transactions to be candidates
|
||||
for netting (this does not include the checks to enforce that everyones amounts received are the same at the end,
|
||||
which is handled under the verify() function).
|
||||
In comparison to <a href="-bilateral-net-state/index.html">BilateralNetState</a>, this doesnt include the parties keys, as ensuring balances match on
|
||||
input and output is handled elsewhere.
|
||||
Used in cases where all parties (or their proxies) are signing, such as central clearing.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-net-state/index.html">NetState</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">NetState</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>Common interface for the state subsets used when determining nettability of two or more states. Exposes the
|
||||
underlying issued thing.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-state/index.html">State</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">State</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../-fungible-asset-state/index.html"><span class="identifier">FungibleAssetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">,</span> <a href="-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><a href="../../com.r3corda.core.contracts/-bilateral-nettable-state/index.html"><span class="identifier">BilateralNettableState</span></a><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span></code><p>A state representing the obligation of one party (obligor) to deliver a specified number of
|
||||
units of an underlying asset (described as issuanceDef.acceptableIssuedProducts) to the beneficiary
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">State</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><a href="-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><a href="../../com.r3corda.core.contracts/-nettable-state.html"><span class="identifier">NettableState</span></a><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">,</span> <a href="../../com.r3corda.contracts.clause/-multilateral-net-state/index.html"><span class="identifier">MultilateralNetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span></code><p>A state representing the obligation of one party (obligor) to deliver a specified number of
|
||||
units of an underlying asset (described as token.acceptableIssuedProducts) to the beneficiary
|
||||
no later than the specified time.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-state-template/index.html">StateTemplate</a></td>
|
||||
<a href="-terms/index.html">Terms</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">StateTemplate</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>Subset of state, containing the elements specified when issuing a new settlement contract.</p>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Terms</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>Subset of state, containing the elements specified when issuing a new settlement contract.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -118,6 +79,12 @@ to be netted/merged, with settlement only for any remainder amount.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="clauses.html">clauses</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">clauses</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts.clauses/-single-clause.html"><span class="identifier">SingleClause</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="legal-contract-reference.html">legalContractReference</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">legalContractReference</span><span class="symbol">: </span><a href="../../com.r3corda.core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><p>TODO:</p>
|
||||
@ -130,6 +97,12 @@ to be netted/merged, with settlement only for any remainder amount.</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="extract-commands.html">extractCommands</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">extractCommands</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$extractCommands(com.r3corda.core.contracts.TransactionForContract)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-authenticated-object/index.html"><span class="identifier">AuthenticatedObject</span></a><span class="symbol"><</span><a href="../-fungible-asset/-commands/index.html"><span class="identifier">Commands</span></a><span class="symbol">></span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="generate-close-out-netting.html">generateCloseOutNetting</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateCloseOutNetting</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateCloseOutNetting(com.r3corda.core.contracts.TransactionBuilder, java.security.PublicKey, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateCloseOutNetting(com.r3corda.core.contracts.TransactionBuilder, java.security.PublicKey, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/signer">signer</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><span class="symbol">, </span><span class="keyword">vararg</span> <span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateCloseOutNetting(com.r3corda.core.contracts.TransactionBuilder, java.security.PublicKey, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/states">states</span><span class="symbol">:</span> <a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>Generate a transaction performing close-out netting of two or more states.</p>
|
||||
@ -139,14 +112,14 @@ to be netted/merged, with settlement only for any remainder amount.</p>
|
||||
<td>
|
||||
<a href="generate-issue.html">generateIssue</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/obligor">obligor</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/issuanceDef">issuanceDef</span><span class="symbol">:</span> <a href="-state-template/index.html"><span class="identifier">StateTemplate</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/pennies">pennies</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/beneficiary">beneficiary</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><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.StateTemplate((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>Puts together an issuance transaction for the specified amount that starts out being owned by the given pubkey.</p>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/obligor">obligor</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/issuanceDef">issuanceDef</span><span class="symbol">:</span> <a href="-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/pennies">pennies</span><span class="symbol">:</span> <span class="identifier">Long</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/beneficiary">beneficiary</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><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateIssue(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.crypto.Party, com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)), kotlin.Long, java.security.PublicKey, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>Puts together an issuance transaction for the specified amount that starts out being owned by the given pubkey.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="generate-payment-netting.html">generatePaymentNetting</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generatePaymentNetting</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.P)), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.P)), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/issued">issued</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.P)), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="keyword">vararg</span> <span class="identifier" id="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.P)), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/states">states</span><span class="symbol">:</span> <a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generatePaymentNetting</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/issued">issued</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="keyword">vararg</span> <span class="identifier" id="com.r3corda.contracts.asset.Obligation$generatePaymentNetting(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.crypto.Party, kotlin.Array((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))/states">states</span><span class="symbol">:</span> <a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
@ -159,33 +132,28 @@ to be netted/merged, with settlement only for any remainder amount.</p>
|
||||
<td>
|
||||
<a href="generate-settle.html">generateSettle</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateSettle</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAssetState((com.r3corda.contracts.asset.Obligation.P, kotlin.Any)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAssetState((com.r3corda.contracts.asset.Obligation.P, kotlin.Any)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/statesAndRefs">statesAndRefs</span><span class="symbol">:</span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAssetState((com.r3corda.contracts.asset.Obligation.P, kotlin.Any)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/assetStatesAndRefs">assetStatesAndRefs</span><span class="symbol">:</span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="../-fungible-asset-state/index.html"><span class="identifier">FungibleAssetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">,</span> <span class="identifier">*</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAssetState((com.r3corda.contracts.asset.Obligation.P, kotlin.Any)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/moveCommand">moveCommand</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-move-command/index.html"><span class="identifier">MoveCommand</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAssetState((com.r3corda.contracts.asset.Obligation.P, kotlin.Any)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="verify.html">verify</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">verify</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verify(com.r3corda.core.contracts.TransactionForContract)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>This is the function EVERYONE runs</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="verify-issue-command.html">verifyIssueCommand</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">verifyIssueCommand</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifyIssueCommand(kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.Issue((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.P)), com.r3corda.core.crypto.Party)/inputs">inputs</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifyIssueCommand(kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.Issue((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.P)), com.r3corda.core.crypto.Party)/outputs">outputs</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifyIssueCommand(kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.Issue((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.P)), com.r3corda.core.crypto.Party)/issueCommand">issueCommand</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-authenticated-object/index.html"><span class="identifier">AuthenticatedObject</span></a><span class="symbol"><</span><a href="-commands/-issue/index.html"><span class="identifier">Issue</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifyIssueCommand(kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.Issue((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.P)), com.r3corda.core.crypto.Party)/issued">issued</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifyIssueCommand(kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.Issue((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.P)), com.r3corda.core.crypto.Party)/obligor">obligor</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="verify-net-command.html">verifyNetCommand</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">verifyNetCommand</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifyNetCommand(kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.Net)), com.r3corda.contracts.asset.Obligation.NetState((com.r3corda.contracts.asset.Obligation.P)))/inputs">inputs</span><span class="symbol">:</span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifyNetCommand(kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.Net)), com.r3corda.contracts.asset.Obligation.NetState((com.r3corda.contracts.asset.Obligation.P)))/outputs">outputs</span><span class="symbol">:</span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifyNetCommand(kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.Net)), com.r3corda.contracts.asset.Obligation.NetState((com.r3corda.contracts.asset.Obligation.P)))/command">command</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-authenticated-object/index.html"><span class="identifier">AuthenticatedObject</span></a><span class="symbol"><</span><a href="-commands/-net/index.html"><span class="identifier">Net</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifyNetCommand(kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.Net)), com.r3corda.contracts.asset.Obligation.NetState((com.r3corda.contracts.asset.Obligation.P)))/netState">netState</span><span class="symbol">:</span> <a href="-net-state/index.html"><span class="identifier">NetState</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>Verify a netting command. This handles both close-out and payment netting.</p>
|
||||
</td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateSettle</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/statesAndRefs">statesAndRefs</span><span class="symbol">:</span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/assetStatesAndRefs">assetStatesAndRefs</span><span class="symbol">:</span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="../-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/moveCommand">moveCommand</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-move-command/index.html"><span class="identifier">MoveCommand</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$generateSettle(com.r3corda.core.contracts.TransactionBuilder, kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.Iterable((com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.MoveCommand, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="verify-set-lifecycle-command.html">verifySetLifecycleCommand</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">verifySetLifecycleCommand</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle((com.r3corda.contracts.asset.Obligation.P)))))/inputs">inputs</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle((com.r3corda.contracts.asset.Obligation.P)))))/outputs">outputs</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle((com.r3corda.contracts.asset.Obligation.P)))))/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle((com.r3corda.contracts.asset.Obligation.P)))))/setLifecycleCommand">setLifecycleCommand</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-authenticated-object/index.html"><span class="identifier">AuthenticatedObject</span></a><span class="symbol"><</span><a href="-commands/-set-lifecycle/index.html"><span class="identifier">SetLifecycle</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>A default command mutates inputs and produces identical outputs, except that the lifecycle changes.</p>
|
||||
<code><span class="keyword">fun </span><span class="identifier">verifySetLifecycleCommand</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle)))/inputs">inputs</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="../-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><a href="-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle)))/outputs">outputs</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="../-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><a href="-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle)))/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle)))/setLifecycleCommand">setLifecycleCommand</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-authenticated-object/index.html"><span class="identifier">AuthenticatedObject</span></a><span class="symbol"><</span><a href="-commands/-set-lifecycle/index.html"><span class="identifier">SetLifecycle</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>A default command mutates inputs and produces identical outputs, except that the lifecycle changes.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../com.r3corda.core.contracts.clauses/-clause-verifier/verify.html">verify</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">verify</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.core.contracts.clauses.ClauseVerifier$verify(com.r3corda.core.contracts.TransactionForContract)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>Takes an object that represents a state transition, and ensures the inputs/outputs/commands make sense.
|
||||
Must throw an exception if theres a problem that should prevent state transition. Takes a single object
|
||||
rather than an argument so that additional data can be added without breaking binary compatibility with
|
||||
existing contract code.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -7,8 +7,8 @@
|
||||
<a href="../index.html">com.r3corda.contracts.asset</a> / <a href="index.html">Obligation</a> / <a href=".">verifySetLifecycleCommand</a><br/>
|
||||
<br/>
|
||||
<h1>verifySetLifecycleCommand</h1>
|
||||
<a name="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle((com.r3corda.contracts.asset.Obligation.P)))))"></a>
|
||||
<code><span class="keyword">protected</span> <span class="keyword">fun </span><span class="identifier">verifySetLifecycleCommand</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle((com.r3corda.contracts.asset.Obligation.P)))))/inputs">inputs</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle((com.r3corda.contracts.asset.Obligation.P)))))/outputs">outputs</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle((com.r3corda.contracts.asset.Obligation.P)))))/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), kotlin.collections.List((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.Obligation.P)))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle((com.r3corda.contracts.asset.Obligation.P)))))/setLifecycleCommand">setLifecycleCommand</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-authenticated-object/index.html"><span class="identifier">AuthenticatedObject</span></a><span class="symbol"><</span><a href="-commands/-set-lifecycle/index.html"><span class="identifier">SetLifecycle</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
<a name="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle)))"></a>
|
||||
<code><span class="keyword">protected</span> <span class="keyword">fun </span><span class="identifier">verifySetLifecycleCommand</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle)))/inputs">inputs</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="../-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><a href="-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle)))/outputs">outputs</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><a href="../-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><a href="-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle)))/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset.Obligation$verifySetLifecycleCommand(kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), kotlin.collections.List((com.r3corda.contracts.asset.FungibleAsset((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.Obligation.P)))))), com.r3corda.core.contracts.TransactionForContract, com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.contracts.asset.Obligation.Commands.SetLifecycle)))/setLifecycleCommand">setLifecycleCommand</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-authenticated-object/index.html"><span class="identifier">AuthenticatedObject</span></a><span class="symbol"><</span><a href="-commands/-set-lifecycle/index.html"><span class="identifier">SetLifecycle</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
<p>A default command mutates inputs and produces identical outputs, except that the lifecycle changes.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
@ -9,8 +9,6 @@
|
||||
<h1>at</h1>
|
||||
<a name="com.r3corda.contracts.asset$at(com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.at.T)), java.time.Instant)"></a>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <a href="-obligation/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">.</span><span class="identifier">at</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$at(com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.at.T)), java.time.Instant)/dueBefore">dueBefore</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><span class="symbol">)</span><span class="symbol">: </span><a href="-obligation/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code><br/>
|
||||
<a name="com.r3corda.contracts.asset$at(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.at.T)), java.time.Instant)"></a>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <a href="-obligation/-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">.</span><span class="identifier">at</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$at(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.at.T)), java.time.Instant)/dueBefore">dueBefore</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><span class="symbol">)</span><span class="symbol">: </span><a href="-obligation/-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,11 +7,11 @@
|
||||
<a href="index.html">com.r3corda.contracts.asset</a> / <a href=".">extractAmountsDue</a><br/>
|
||||
<br/>
|
||||
<h1>extractAmountsDue</h1>
|
||||
<a name="com.r3corda.contracts.asset$extractAmountsDue(com.r3corda.contracts.asset.extractAmountsDue.P, kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.extractAmountsDue.P)))))"></a>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">extractAmountsDue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$extractAmountsDue(com.r3corda.contracts.asset.extractAmountsDue.P, kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.extractAmountsDue.P)))))/product">product</span><span class="symbol">:</span> <span class="identifier">P</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset$extractAmountsDue(com.r3corda.contracts.asset.extractAmountsDue.P, kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.extractAmountsDue.P)))))/states">states</span><span class="symbol">:</span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="-obligation/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol"><</span><span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <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> <a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
<a name="com.r3corda.contracts.asset$extractAmountsDue(com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.extractAmountsDue.P)), kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.extractAmountsDue.P)))))"></a>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">extractAmountsDue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$extractAmountsDue(com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.extractAmountsDue.P)), kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.extractAmountsDue.P)))))/product">product</span><span class="symbol">:</span> <a href="-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset$extractAmountsDue(com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.extractAmountsDue.P)), kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.extractAmountsDue.P)))))/states">states</span><span class="symbol">:</span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="-obligation/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol"><</span><span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <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> <a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
<p>Convert a list of settlement states into total from each obligor to a beneficiary.</p>
|
||||
<strong>Return</strong><br/>
|
||||
a map of obligor/beneficiary pairs to the balance due.<br/>
|
||||
<p><strong>Return</strong><br/>
|
||||
a map of obligor/beneficiary pairs to the balance due.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -14,7 +14,7 @@
|
||||
<td>
|
||||
<a href="-cash/index.html">Cash</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Cash</span> <span class="symbol">:</span> <a href="-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code><p>A cash transaction may split and merge money represented by a set of (issuer, depositRef) pairs, across multiple
|
||||
<code><span class="keyword">class </span><span class="identifier">Cash</span> <span class="symbol">:</span> <a href="../com.r3corda.core.contracts.clauses/-clause-verifier/index.html"><span class="identifier">ClauseVerifier</span></a></code><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>
|
||||
@ -24,26 +24,19 @@ the same transaction.</p>
|
||||
<td>
|
||||
<a href="-fungible-asset/index.html">FungibleAsset</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">FungibleAsset</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../com.r3corda.core.contracts/-contract/index.html"><span class="identifier">Contract</span></a></code><p>Superclass for contracts representing assets which are fungible, countable and issued by a specific party. States
|
||||
contain assets which are equivalent (such as cash of the same currency), so records of their existence can
|
||||
be merged or split as needed where the issuer is the same. For instance, dollars issued by the Fed are fungible and
|
||||
countable (in cents), barrels of West Texas crude are fungible and countable (oil from two small containers
|
||||
can be poured into one large container), shares of the same class in a specific company are fungible and
|
||||
countable, and so on.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-fungible-asset-state/index.html">FungibleAssetState</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">FungibleAssetState</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">, </span><span class="identifier">I</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../com.r3corda.core.contracts/-ownable-state/index.html"><span class="identifier">OwnableState</span></a></code><p>Common elements of cash contract states.</p>
|
||||
<code><span class="keyword">interface </span><span class="identifier">FungibleAsset</span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../com.r3corda.core.contracts/-ownable-state/index.html"><span class="identifier">OwnableState</span></a></code><p>Interface for contract states representing assets which are fungible, countable and issued by a
|
||||
specific party. States contain assets which are equivalent (such as cash of the same currency),
|
||||
so records of their existence can be merged or split as needed where the issuer is the same. For
|
||||
instance, dollars issued by the Fed are fungible and countable (in cents), barrels of West Texas
|
||||
crude are fungible and countable (oil from two small containers can be poured into one large
|
||||
container), shares of the same class in a specific company are fungible and countable, and so on.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-obligation/index.html">Obligation</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Obligation</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../com.r3corda.core.contracts/-contract/index.html"><span class="identifier">Contract</span></a></code><p>An obligation contract commits the obligor to delivering a specified amount of a fungible asset (for example the
|
||||
<code><span class="keyword">class </span><span class="identifier">Obligation</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="../com.r3corda.core.contracts.clauses/-clause-verifier/index.html"><span class="identifier">ClauseVerifier</span></a></code><p>An obligation contract commits the obligor to delivering a specified amount of a fungible asset (for example the
|
||||
<a href="-cash/index.html">Cash</a> contract) at a specified future point in time. Settlement transactions may split and merge contracts across
|
||||
multiple input and output states. The goal of this design is to handle amounts owed, and these contracts are expected
|
||||
to be netted/merged, with settlement only for any remainder amount.</p>
|
||||
@ -113,7 +106,7 @@ to be netted/merged, with settlement only for any remainder amount.</p>
|
||||
<td>
|
||||
<a href="-o-b-l-i-g-a-t-i-o-n_-d-e-f.html">OBLIGATION_DEF</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><a href="../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">OBLIGATION_DEF</span><span class="symbol">: </span><a href="-obligation/-state-template/index.html"><span class="identifier">StateTemplate</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code></td>
|
||||
<code><span class="keyword">val </span><a href="../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">OBLIGATION_DEF</span><span class="symbol">: </span><a href="-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
@ -145,8 +138,7 @@ which we have no cash evaluate to null (not present in map), not 0.</p>
|
||||
<td>
|
||||
<a href="at.html">at</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <a href="-obligation/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">.</span><span class="identifier">at</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$at(com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.at.T)), java.time.Instant)/dueBefore">dueBefore</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><span class="symbol">)</span><span class="symbol">: </span><a href="-obligation/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <a href="-obligation/-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">.</span><span class="identifier">at</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$at(com.r3corda.contracts.asset.Obligation.IssuanceDefinition((com.r3corda.contracts.asset.at.T)), java.time.Instant)/dueBefore">dueBefore</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><span class="symbol">)</span><span class="symbol">: </span><a href="-obligation/-issuance-definition/index.html"><span class="identifier">IssuanceDefinition</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
<code><span class="keyword">infix</span> <span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <a href="-obligation/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">.</span><span class="identifier">at</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$at(com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.at.T)), java.time.Instant)/dueBefore">dueBefore</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><span class="symbol">)</span><span class="symbol">: </span><a href="-obligation/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
@ -158,7 +150,7 @@ which we have no cash evaluate to null (not present in map), not 0.</p>
|
||||
<td>
|
||||
<a href="extract-amounts-due.html">extractAmountsDue</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">extractAmountsDue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$extractAmountsDue(com.r3corda.contracts.asset.extractAmountsDue.P, kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.extractAmountsDue.P)))))/product">product</span><span class="symbol">:</span> <span class="identifier">P</span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset$extractAmountsDue(com.r3corda.contracts.asset.extractAmountsDue.P, kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.extractAmountsDue.P)))))/states">states</span><span class="symbol">:</span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="-obligation/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol"><</span><span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <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> <a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span></code><p>Convert a list of settlement states into total from each obligor to a beneficiary.</p>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">extractAmountsDue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$extractAmountsDue(com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.extractAmountsDue.P)), kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.extractAmountsDue.P)))))/product">product</span><span class="symbol">:</span> <a href="-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.asset$extractAmountsDue(com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.extractAmountsDue.P)), kotlin.collections.Iterable((com.r3corda.contracts.asset.Obligation.State((com.r3corda.contracts.asset.extractAmountsDue.P)))))/states">states</span><span class="symbol">:</span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="-obligation/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol"><</span><span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <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> <a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span></code><p>Convert a list of settlement states into total from each obligor to a beneficiary.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -181,7 +173,7 @@ which we have no cash evaluate to null (not present in map), not 0.</p>
|
||||
<td>
|
||||
<a href="net-amounts-due.html">netAmountsDue</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">netAmountsDue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$netAmountsDue(kotlin.collections.Map((((java.security.PublicKey, java.security.PublicKey)), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.netAmountsDue.P)))))/balances">balances</span><span class="symbol">:</span> <span class="identifier">Map</span><span class="symbol"><</span><span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <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> <a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol"><</span><span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <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> <a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span></code><p>Net off the amounts due between parties.</p>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">netAmountsDue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$netAmountsDue(kotlin.collections.Map((((java.security.PublicKey, )), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.netAmountsDue.P)))))/balances">balances</span><span class="symbol">:</span> <span class="identifier">Map</span><span class="symbol"><</span><span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <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> <a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol"><</span><span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <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> <a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span></code><p>Net off the amounts due between parties.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@ -202,7 +194,7 @@ which we have no cash evaluate to null (not present in map), not 0.</p>
|
||||
<td>
|
||||
<a href="sum-amounts-due.html">sumAmountsDue</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">sumAmountsDue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$sumAmountsDue(kotlin.collections.Map((((java.security.PublicKey, java.security.PublicKey)), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.sumAmountsDue.P)))))/balances">balances</span><span class="symbol">:</span> <span class="identifier">Map</span><span class="symbol"><</span><span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <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> <a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</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><span class="symbol">,</span> <span class="identifier">Long</span><span class="symbol">></span></code><p>Calculate the total balance movement for each party in the transaction, based off a summary of balances between
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">sumAmountsDue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$sumAmountsDue(kotlin.collections.Map((((java.security.PublicKey, )), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.sumAmountsDue.P)))))/balances">balances</span><span class="symbol">:</span> <span class="identifier">Map</span><span class="symbol"><</span><span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <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> <a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</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><span class="symbol">,</span> <span class="identifier">Long</span><span class="symbol">></span></code><p>Calculate the total balance movement for each party in the transaction, based off a summary of balances between
|
||||
each obligor and beneficiary.</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
@ -42,23 +42,6 @@ different currencies).</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="sum-fungible.html">sumFungible</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumFungible</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>Sums the asset states in the list, throwing an exception if there are none, or if any of the asset
|
||||
states cannot be added together (i.e. are different tokens).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="sum-fungible-by.html">sumFungibleBy</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumFungibleBy</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$sumFungibleBy(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), java.security.PublicKey)/owner">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><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>Sums the asset states in the list belonging to a single owner, throwing an exception
|
||||
if there are none, or if any of the asset states cannot be added together (i.e. are
|
||||
different tokens).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="sum-fungible-or-null.html">sumFungibleOrNull</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumFungibleOrNull</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code><p>Sums the asset states in the list, returning null if there are none.</p>
|
||||
@ -75,21 +58,21 @@ different tokens).</p>
|
||||
<td>
|
||||
<a href="sum-obligations.html">sumObligations</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumObligations</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>Sums the obligation states in the list, throwing an exception if there are none. All state objects in the list are presumed to be nettable.</p>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumObligations</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span></code><p>Sums the obligation states in the list, throwing an exception if there are none. All state objects in the list are presumed to be nettable.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="sum-obligations-or-null.html">sumObligationsOrNull</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumObligationsOrNull</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">?</span></code><p>Sums the obligation states in the list, returning null if there are none.</p>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumObligationsOrNull</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">?</span></code><p>Sums the obligation states in the list, returning null if there are none.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="sum-obligations-or-zero.html">sumObligationsOrZero</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumObligationsOrZero</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$sumObligationsOrZero(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), com.r3corda.contracts.asset.sumObligationsOrZero.P)/product">product</span><span class="symbol">:</span> <span class="identifier">P</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><p>Sums the obligation states in the list, returning zero of the given product if there are none.</p>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumObligationsOrZero</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$sumObligationsOrZero(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.sumObligationsOrZero.P)))))/issuanceDef">issuanceDef</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span></code><p>Sums the obligation states in the list, returning zero of the given product if there are none.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
<br/>
|
||||
<h1>sumObligationsOrNull</h1>
|
||||
<a name="com.r3corda.contracts.asset$sumObligationsOrNull(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)))"></a>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumObligationsOrNull</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">?</span></code><br/>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumObligationsOrNull</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span><span class="symbol">?</span></code><br/>
|
||||
<p>Sums the obligation states in the list, returning null if there are none.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
@ -7,8 +7,8 @@
|
||||
<a href="../index.html">com.r3corda.contracts.asset</a> / <a href="index.html">kotlin.collections.Iterable</a> / <a href=".">sumObligationsOrZero</a><br/>
|
||||
<br/>
|
||||
<h1>sumObligationsOrZero</h1>
|
||||
<a name="com.r3corda.contracts.asset$sumObligationsOrZero(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), com.r3corda.contracts.asset.sumObligationsOrZero.P)"></a>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumObligationsOrZero</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$sumObligationsOrZero(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), com.r3corda.contracts.asset.sumObligationsOrZero.P)/product">product</span><span class="symbol">:</span> <span class="identifier">P</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
<a name="com.r3corda.contracts.asset$sumObligationsOrZero(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.sumObligationsOrZero.P)))))"></a>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumObligationsOrZero</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$sumObligationsOrZero(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)), com.r3corda.core.contracts.Issued((com.r3corda.contracts.asset.Obligation.Terms((com.r3corda.contracts.asset.sumObligationsOrZero.P)))))/issuanceDef">issuanceDef</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
<p>Sums the obligation states in the list, returning zero of the given product if there are none.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
<br/>
|
||||
<h1>sumObligations</h1>
|
||||
<a name="com.r3corda.contracts.asset$sumObligations(kotlin.collections.Iterable((com.r3corda.core.contracts.ContractState)))"></a>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumObligations</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">Iterable</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">></span><span class="symbol">.</span><span class="identifier">sumObligations</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
<p>Sums the obligation states in the list, throwing an exception if there are none. All state objects in the list are presumed to be nettable.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
@ -7,8 +7,8 @@
|
||||
<a href="index.html">com.r3corda.contracts.asset</a> / <a href=".">netAmountsDue</a><br/>
|
||||
<br/>
|
||||
<h1>netAmountsDue</h1>
|
||||
<a name="com.r3corda.contracts.asset$netAmountsDue(kotlin.collections.Map((((java.security.PublicKey, java.security.PublicKey)), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.netAmountsDue.P)))))"></a>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">netAmountsDue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$netAmountsDue(kotlin.collections.Map((((java.security.PublicKey, java.security.PublicKey)), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.netAmountsDue.P)))))/balances">balances</span><span class="symbol">:</span> <span class="identifier">Map</span><span class="symbol"><</span><span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <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> <a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol"><</span><span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <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> <a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
<a name="com.r3corda.contracts.asset$netAmountsDue(kotlin.collections.Map((((java.security.PublicKey, )), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.netAmountsDue.P)))))"></a>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">netAmountsDue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$netAmountsDue(kotlin.collections.Map((((java.security.PublicKey, )), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.netAmountsDue.P)))))/balances">balances</span><span class="symbol">:</span> <span class="identifier">Map</span><span class="symbol"><</span><span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <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> <a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</span><span class="symbol"><</span><span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <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> <a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
<p>Net off the amounts due between parties.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
@ -7,8 +7,8 @@
|
||||
<a href="index.html">com.r3corda.contracts.asset</a> / <a href=".">sumAmountsDue</a><br/>
|
||||
<br/>
|
||||
<h1>sumAmountsDue</h1>
|
||||
<a name="com.r3corda.contracts.asset$sumAmountsDue(kotlin.collections.Map((((java.security.PublicKey, java.security.PublicKey)), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.sumAmountsDue.P)))))"></a>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">sumAmountsDue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$sumAmountsDue(kotlin.collections.Map((((java.security.PublicKey, java.security.PublicKey)), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.sumAmountsDue.P)))))/balances">balances</span><span class="symbol">:</span> <span class="identifier">Map</span><span class="symbol"><</span><span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <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> <a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</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><span class="symbol">,</span> <span class="identifier">Long</span><span class="symbol">></span></code><br/>
|
||||
<a name="com.r3corda.contracts.asset$sumAmountsDue(kotlin.collections.Map((((java.security.PublicKey, )), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.sumAmountsDue.P)))))"></a>
|
||||
<code><span class="keyword">fun </span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="identifier">sumAmountsDue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.asset$sumAmountsDue(kotlin.collections.Map((((java.security.PublicKey, )), com.r3corda.core.contracts.Amount((com.r3corda.contracts.asset.sumAmountsDue.P)))))/balances">balances</span><span class="symbol">:</span> <span class="identifier">Map</span><span class="symbol"><</span><span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <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> <a href="../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Map</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><span class="symbol">,</span> <span class="identifier">Long</span><span class="symbol">></span></code><br/>
|
||||
<p>Calculate the total balance movement for each party in the transaction, based off a summary of balances between
|
||||
each obligor and beneficiary.</p>
|
||||
<h3>Parameters</h3>
|
||||
|
||||
@ -17,8 +17,8 @@ the central bank, well ... thatd be a different story altogether.</p>
|
||||
<p>The service hub needs to provide at least a key management service and a storage service.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<strong>Return</strong><br/>
|
||||
a wallet object that represents the generated states (it will NOT be the full wallet from the service hub).<br/>
|
||||
<p><strong>Return</strong><br/>
|
||||
a wallet object that represents the generated states (it will NOT be the full wallet from the service hub).</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../../../index.html">com.r3corda.contracts</a> / <a href="../../index.html">CommercialPaper</a> / <a href="../index.html">Commands</a> / <a href="index.html">Issue</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Issue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.Commands.Issue$<init>(com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span></code><br/>
|
||||
<code><span class="identifier">Issue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.Commands.Issue$<init>(com.r3corda.core.crypto.Party, kotlin.Long)/notary">notary</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.Commands.Issue$<init>(com.r3corda.core.crypto.Party, kotlin.Long)/nonce">nonce</span><span class="symbol">:</span> <span class="identifier">Long</span> <span class="symbol">=</span> random63BitValue()<span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../../../index.html">com.r3corda.contracts</a> / <a href="../../index.html">CommercialPaper</a> / <a href="../index.html">Commands</a> / <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> <span class="symbol">:</span> <a href="../index.html"><span class="identifier">Commands</span></a></code><br/>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Issue</span> <span class="symbol">:</span> <a href="../../../../com.r3corda.core.contracts/-issue-command/index.html"><span class="identifier">IssueCommand</span></a><span class="symbol">, </span><a href="../index.html"><span class="identifier">Commands</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Constructors</h3>
|
||||
@ -17,7 +17,7 @@
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">Issue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.Commands.Issue$<init>(com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span></code></td>
|
||||
<code><span class="identifier">Issue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.Commands.Issue$<init>(com.r3corda.core.crypto.Party, kotlin.Long)/notary">notary</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.Commands.Issue$<init>(com.r3corda.core.crypto.Party, kotlin.Long)/nonce">nonce</span><span class="symbol">:</span> <span class="identifier">Long</span> <span class="symbol">=</span> random63BitValue()<span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@ -26,6 +26,12 @@
|
||||
<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>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="notary.html">notary</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">notary</span><span class="symbol">: </span><a href="../../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a></code></td>
|
||||
|
||||
@ -17,7 +17,7 @@
|
||||
<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> <span class="symbol">:</span> <span class="identifier">Commands</span></code></td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Issue</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-issue-command/index.html"><span class="identifier">IssueCommand</span></a><span class="symbol">, </span><span class="identifier">Commands</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
@ -40,7 +40,7 @@
|
||||
<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> <span class="symbol">:</span> <span class="identifier">Commands</span></code></td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Issue</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-issue-command/index.html"><span class="identifier">IssueCommand</span></a><span class="symbol">, </span><span class="identifier">Commands</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
@ -63,6 +63,12 @@
|
||||
<code><span class="keyword">val </span><span class="identifier">participants</span><span class="symbol">: </span><span class="identifier">List</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><span class="symbol">></span></code><p>A <emph>participant</emph> is any party that is able to consume this state in a valid transaction.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="token.html">token</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">token</span><span class="symbol">: </span><a href="../../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Functions</h3>
|
||||
@ -105,12 +111,6 @@
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">withOwner</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper.State$withOwner(java.security.PublicKey)/newOwner">newOwner</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><span class="symbol">)</span><span class="symbol">: </span><span class="identifier"><ERROR CLASS></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="without-owner.html">withoutOwner</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">withoutOwner</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">State</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Extension Functions</h3>
|
||||
|
||||
@ -19,7 +19,7 @@ they possess, since someone consumed that state during the notary change process
|
||||
list should just contain the owner.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<strong>Getter</strong><br/>
|
||||
<p><strong>Getter</strong><br/>
|
||||
<p>A <emph>participant</emph> is any party that is able to consume this state in a valid transaction.</p>
|
||||
<p>The list of participants is required for certain types of transactions. For example, when changing the notary
|
||||
for this state (<a href="../../../com.r3corda.core.contracts/-transaction-type/-notary-change/index.html">TransactionType.NotaryChange</a>), every participants has to be involved and approve the transaction
|
||||
@ -27,7 +27,7 @@ so that they receive the updated state, and dont end up in a situation where the
|
||||
they possess, since someone consumed that state during the notary change process.</p>
|
||||
<p>The participants list should normally be derived from the contents of the state. E.g. for <a href="../../../com.r3corda.contracts.asset/-cash/index.html">Cash</a> the participants
|
||||
list should just contain the owner.</p>
|
||||
<br/>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,8 +7,8 @@
|
||||
<a href="../index.html">com.r3corda.contracts</a> / <a href="index.html">CommercialPaper</a> / <a href=".">generateIssue</a><br/>
|
||||
<br/>
|
||||
<h1>generateIssue</h1>
|
||||
<a name="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.time.Instant, com.r3corda.core.crypto.Party)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.time.Instant, com.r3corda.core.crypto.Party)/faceValue">faceValue</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.time.Instant, com.r3corda.core.crypto.Party)/maturityDate">maturityDate</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><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.time.Instant, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a></code><br/>
|
||||
<a name="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.time.Instant, com.r3corda.core.crypto.Party)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.time.Instant, com.r3corda.core.crypto.Party)/issuance">issuance</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.time.Instant, com.r3corda.core.crypto.Party)/faceValue">faceValue</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.time.Instant, com.r3corda.core.crypto.Party)/maturityDate">maturityDate</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><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.time.Instant, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a></code><br/>
|
||||
<p>Returns a transaction that issues commercial paper, owned by the issuing parties key. Does not update
|
||||
an existing transaction because you arent able to issue multiple pieces of CP in a single transaction
|
||||
at the moment: this restriction is not fundamental and may be lifted later.</p>
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../index.html">com.r3corda.contracts</a> / <a href=".">CommercialPaper</a><br/>
|
||||
<br/>
|
||||
<h1>CommercialPaper</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">CommercialPaper</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-contract/index.html"><span class="identifier">Contract</span></a></code><br/>
|
||||
<code><span class="keyword">class </span><span class="identifier">CommercialPaper</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts.clauses/-clause-verifier/index.html"><span class="identifier">ClauseVerifier</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<h3>Types</h3>
|
||||
@ -15,6 +15,12 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-clauses/index.html">Clauses</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Clauses</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-commands/index.html">Commands</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a></code></td>
|
||||
@ -25,6 +31,12 @@
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">State</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-ownable-state/index.html"><span class="identifier">OwnableState</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-terms/index.html">Terms</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Terms</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Constructors</h3>
|
||||
@ -43,6 +55,12 @@
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="clauses.html">clauses</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">clauses</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts.clauses/-single-clause.html"><span class="identifier">SingleClause</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="legal-contract-reference.html">legalContractReference</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">legalContractReference</span><span class="symbol">: </span><a href="../../com.r3corda.core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><p>Unparsed reference to the natural language contract that this code is supposed to express (usually a hash of
|
||||
@ -56,9 +74,15 @@ the contracts contents).</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="extract-commands.html">extractCommands</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">extractCommands</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$extractCommands(com.r3corda.core.contracts.TransactionForContract)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-authenticated-object/index.html"><span class="identifier">AuthenticatedObject</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a><span class="symbol">></span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="generate-issue.html">generateIssue</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.time.Instant, com.r3corda.core.crypto.Party)/faceValue">faceValue</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.time.Instant, com.r3corda.core.crypto.Party)/maturityDate">maturityDate</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><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.time.Instant, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a></code><p>Returns a transaction that issues commercial paper, owned by the issuing parties key. Does not update
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateIssue</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.time.Instant, com.r3corda.core.crypto.Party)/issuance">issuance</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-party-and-reference/index.html"><span class="identifier">PartyAndReference</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.time.Instant, com.r3corda.core.crypto.Party)/faceValue">faceValue</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-amount/index.html"><span class="identifier">Amount</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.time.Instant, com.r3corda.core.crypto.Party)/maturityDate">maturityDate</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><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$generateIssue(com.r3corda.core.contracts.PartyAndReference, com.r3corda.core.contracts.Amount((com.r3corda.core.contracts.Issued((java.util.Currency)))), java.time.Instant, com.r3corda.core.crypto.Party)/notary">notary</span><span class="symbol">:</span> <a href="../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">)</span><span class="symbol">: </span><a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a></code><p>Returns a transaction that issues commercial paper, owned by the issuing parties key. Does not update
|
||||
an existing transaction because you arent able to issue multiple pieces of CP in a single transaction
|
||||
at the moment: this restriction is not fundamental and may be lifted later.</p>
|
||||
</td>
|
||||
@ -79,11 +103,16 @@ to redeem the paper. We must therefore send enough money to the key that owns th
|
||||
value, and then ensure the paper is removed from the ledger.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="verify.html">verify</a></td>
|
||||
<a href="../../com.r3corda.core.contracts.clauses/-clause-verifier/verify.html">verify</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">verify</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.CommercialPaper$verify(com.r3corda.core.contracts.TransactionForContract)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>Takes an object that represents a state transition, and ensures the inputs/outputs/commands make sense.
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">verify</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.core.contracts.clauses.ClauseVerifier$verify(com.r3corda.core.contracts.TransactionForContract)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>Takes an object that represents a state transition, and ensures the inputs/outputs/commands make sense.
|
||||
Must throw an exception if theres a problem that should prevent state transition. Takes a single object
|
||||
rather than an argument so that additional data can be added without breaking binary compatibility with
|
||||
existing contract code.</p>
|
||||
|
||||
@ -7,9 +7,6 @@
|
||||
<a href="../index.html">com.r3corda.contracts</a> / <a href="index.html">FixedRate</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">FixedRate</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.FixedRate$<init>(com.r3corda.contracts.Rate)/otherRate">otherRate</span><span class="symbol">:</span> <a href="../-rate/index.html"><span class="identifier">Rate</span></a><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
<code><span class="identifier">FixedRate</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.FixedRate$<init>(com.r3corda.contracts.RatioUnit)/ratioUnit">ratioUnit</span><span class="symbol">:</span> <a href="../-ratio-unit/index.html"><span class="identifier">RatioUnit</span></a><span class="symbol">)</span></code><br/>
|
||||
<p>A very basic subclass to represent a fixed rate.</p>
|
||||
<br/>
|
||||
|
||||
@ -10,10 +10,10 @@
|
||||
<a name="com.r3corda.contracts.FixedRate$hashCode()"></a>
|
||||
<code><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">Int</span></code><br/>
|
||||
Overrides <a href="../-rate/hash-code.html">Rate.hashCode</a><br/>
|
||||
<strong>Returns</strong><br/>
|
||||
<p><strong>Returns</strong><br/>
|
||||
the hash code of the ratioUnit or zero if the ratioUnit is null, as is the case for floating rate fixings
|
||||
that have not yet happened. Yet-to-be fixed floating rates need to be equal such that schedules can be tested
|
||||
for equality.<br/>
|
||||
for equality.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -18,7 +18,7 @@
|
||||
<td>
|
||||
<a href="-init-.html"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">FixedRate</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.FixedRate$<init>(com.r3corda.contracts.Rate)/otherRate">otherRate</span><span class="symbol">:</span> <a href="../-rate/index.html"><span class="identifier">Rate</span></a><span class="symbol">)</span></code><code><span class="identifier">FixedRate</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.FixedRate$<init>(com.r3corda.contracts.RatioUnit)/ratioUnit">ratioUnit</span><span class="symbol">:</span> <a href="../-ratio-unit/index.html"><span class="identifier">RatioUnit</span></a><span class="symbol">)</span></code><p>A very basic subclass to represent a fixed rate.</p>
|
||||
<code><span class="identifier">FixedRate</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.FixedRate$<init>(com.r3corda.contracts.RatioUnit)/ratioUnit">ratioUnit</span><span class="symbol">:</span> <a href="../-ratio-unit/index.html"><span class="identifier">RatioUnit</span></a><span class="symbol">)</span></code><p>A very basic subclass to represent a fixed rate.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -55,11 +55,16 @@
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">isPositive</span><span class="symbol">(</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Boolean</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="to-string.html">toString</a></td>
|
||||
<a href="../-rate/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>
|
||||
<code><span class="keyword">open</span> <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>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
@ -49,6 +49,12 @@
|
||||
<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">Int</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../-rate/to-string.html">toString</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <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>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
|
||||
@ -10,8 +10,8 @@
|
||||
<a name="com.r3corda.contracts.InterestRateSwap.Calculation$nextFixingDate()"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">nextFixingDate</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><span class="symbol">?</span></code><br/>
|
||||
<p>Gets the date of the next fixing.</p>
|
||||
<strong>Return</strong><br/>
|
||||
LocalDate or null if no more fixings.<br/>
|
||||
<p><strong>Return</strong><br/>
|
||||
LocalDate or null if no more fixings.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
14
docs/build/html/api/com.r3corda.contracts/-interest-rate-swap/-commands/-refix/-init-.html
vendored
Normal file
14
docs/build/html/api/com.r3corda.contracts/-interest-rate-swap/-commands/-refix/-init-.html
vendored
Normal file
@ -0,0 +1,14 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>InterestRateSwap.Commands.Refix.<init> - </title>
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts</a> / <a href="../../index.html">InterestRateSwap</a> / <a href="../index.html">Commands</a> / <a href="index.html">Refix</a> / <a href="."><init></a><br/>
|
||||
<br/>
|
||||
<h1><init></h1>
|
||||
<code><span class="identifier">Refix</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap.Commands.Refix$<init>(com.r3corda.core.contracts.Fix)/fix">fix</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.contracts/-fix/index.html"><span class="identifier">Fix</span></a><span class="symbol">)</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
15
docs/build/html/api/com.r3corda.contracts/-interest-rate-swap/-commands/-refix/fix.html
vendored
Normal file
15
docs/build/html/api/com.r3corda.contracts/-interest-rate-swap/-commands/-refix/fix.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>InterestRateSwap.Commands.Refix.fix - </title>
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts</a> / <a href="../../index.html">InterestRateSwap</a> / <a href="../index.html">Commands</a> / <a href="index.html">Refix</a> / <a href=".">fix</a><br/>
|
||||
<br/>
|
||||
<h1>fix</h1>
|
||||
<a name="com.r3corda.contracts.InterestRateSwap.Commands.Refix$fix"></a>
|
||||
<code><span class="keyword">val </span><span class="identifier">fix</span><span class="symbol">: </span><a href="../../../../com.r3corda.core.contracts/-fix/index.html"><span class="identifier">Fix</span></a></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
36
docs/build/html/api/com.r3corda.contracts/-interest-rate-swap/-commands/-refix/index.html
vendored
Normal file
36
docs/build/html/api/com.r3corda.contracts/-interest-rate-swap/-commands/-refix/index.html
vendored
Normal file
@ -0,0 +1,36 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>InterestRateSwap.Commands.Refix - </title>
|
||||
<link rel="stylesheet" href="../../../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../../../index.html">com.r3corda.contracts</a> / <a href="../../index.html">InterestRateSwap</a> / <a href="../index.html">Commands</a> / <a href=".">Refix</a><br/>
|
||||
<br/>
|
||||
<h1>Refix</h1>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Refix</span> <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"><init></a></td>
|
||||
<td>
|
||||
<code><span class="identifier">Refix</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap.Commands.Refix$<init>(com.r3corda.core.contracts.Fix)/fix">fix</span><span class="symbol">:</span> <a href="../../../../com.r3corda.core.contracts/-fix/index.html"><span class="identifier">Fix</span></a><span class="symbol">)</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Properties</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="fix.html">fix</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">fix</span><span class="symbol">: </span><a href="../../../../com.r3corda.core.contracts/-fix/index.html"><span class="identifier">Fix</span></a></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -21,12 +21,6 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-fix/index.html">Fix</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Fix</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-type-only-command-data/index.html"><span class="identifier">TypeOnlyCommandData</span></a><span class="symbol">, </span><span class="identifier">Commands</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-mature/index.html">Mature</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Mature</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-type-only-command-data/index.html"><span class="identifier">TypeOnlyCommandData</span></a><span class="symbol">, </span><span class="identifier">Commands</span></code></td>
|
||||
@ -37,6 +31,12 @@
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Pay</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-type-only-command-data/index.html"><span class="identifier">TypeOnlyCommandData</span></a><span class="symbol">, </span><span class="identifier">Commands</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-refix/index.html">Refix</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Refix</span> <span class="symbol">:</span> <span class="identifier">Commands</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
@ -50,12 +50,6 @@
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-fix/index.html">Fix</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Fix</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-type-only-command-data/index.html"><span class="identifier">TypeOnlyCommandData</span></a><span class="symbol">, </span><span class="identifier">Commands</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-mature/index.html">Mature</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Mature</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-type-only-command-data/index.html"><span class="identifier">TypeOnlyCommandData</span></a><span class="symbol">, </span><span class="identifier">Commands</span></code></td>
|
||||
@ -66,6 +60,12 @@
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Pay</span> <span class="symbol">:</span> <a href="../../../com.r3corda.core.contracts/-type-only-command-data/index.html"><span class="identifier">TypeOnlyCommandData</span></a><span class="symbol">, </span><span class="identifier">Commands</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-refix/index.html">Refix</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">data</span> <span class="keyword">class </span><span class="identifier">Refix</span> <span class="symbol">:</span> <span class="identifier">Commands</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
|
||||
@ -16,8 +16,8 @@ This can be used to implement deadlines for payment or processing of financial i
|
||||
<p>The state has no reference to its own StateRef, so supply that for use as input to any ProtocolLogic constructed.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<strong>Return</strong><br/>
|
||||
null if there is no activity to schedule.<br/>
|
||||
<p><strong>Return</strong><br/>
|
||||
null if there is no activity to schedule.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -19,7 +19,7 @@ they possess, since someone consumed that state during the notary change process
|
||||
list should just contain the owner.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
<strong>Getter</strong><br/>
|
||||
<p><strong>Getter</strong><br/>
|
||||
<p>A <emph>participant</emph> is any party that is able to consume this state in a valid transaction.</p>
|
||||
<p>The list of participants is required for certain types of transactions. For example, when changing the notary
|
||||
for this state (<a href="../../../com.r3corda.core.contracts/-transaction-type/-notary-change/index.html">TransactionType.NotaryChange</a>), every participants has to be involved and approve the transaction
|
||||
@ -27,7 +27,7 @@ so that they receive the updated state, and dont end up in a situation where the
|
||||
they possess, since someone consumed that state during the notary change process.</p>
|
||||
<p>The participants list should normally be derived from the contents of the state. E.g. for <a href="#">Cash</a> the participants
|
||||
list should just contain the owner.</p>
|
||||
<br/>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -11,9 +11,9 @@
|
||||
<code><span class="keyword">val </span><span class="identifier">parties</span><span class="symbol">: </span><span class="identifier">Array</span><span class="symbol"><</span><a href="../../../com.r3corda.core.crypto/-party/index.html"><span class="identifier">Party</span></a><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../../../com.r3corda.core.contracts/-deal-state/parties.html">DealState.parties</a><br/>
|
||||
<p>Exposes the Parties involved in a generic way</p>
|
||||
<strong>Getter</strong><br/>
|
||||
<p><strong>Getter</strong><br/>
|
||||
<p>Exposes the Parties involved in a generic way</p>
|
||||
<br/>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,8 +7,8 @@
|
||||
<a href="../index.html">com.r3corda.contracts</a> / <a href="index.html">InterestRateSwap</a> / <a href=".">generateFix</a><br/>
|
||||
<br/>
|
||||
<h1>generateFix</h1>
|
||||
<a name="com.r3corda.contracts.InterestRateSwap$generateFix(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.InterestRateSwap.State)), ((java.time.LocalDate, com.r3corda.contracts.Rate)))"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateFix</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$generateFix(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.InterestRateSwap.State)), ((java.time.LocalDate, com.r3corda.contracts.Rate)))/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$generateFix(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.InterestRateSwap.State)), ((java.time.LocalDate, com.r3corda.contracts.Rate)))/irs">irs</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$generateFix(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.InterestRateSwap.State)), ((java.time.LocalDate, com.r3corda.contracts.Rate)))/fixing">fixing</span><span class="symbol">:</span> <span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <a href="../-rate/index.html"><span class="identifier">Rate</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
<a name="com.r3corda.contracts.InterestRateSwap$generateFix(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.InterestRateSwap.State)), com.r3corda.core.contracts.Fix)"></a>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateFix</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$generateFix(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.InterestRateSwap.State)), com.r3corda.core.contracts.Fix)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$generateFix(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.InterestRateSwap.State)), com.r3corda.core.contracts.Fix)/irs">irs</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$generateFix(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.InterestRateSwap.State)), com.r3corda.core.contracts.Fix)/fixing">fixing</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-fix/index.html"><span class="identifier">Fix</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
<a href="../index.html">com.r3corda.contracts</a> / <a href=".">InterestRateSwap</a><br/>
|
||||
<br/>
|
||||
<h1>InterestRateSwap</h1>
|
||||
<code><span class="keyword">class </span><span class="identifier">InterestRateSwap</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-contract/index.html"><span class="identifier">Contract</span></a></code><br/>
|
||||
<code><span class="keyword">class </span><span class="identifier">InterestRateSwap</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts.clauses/-clause-verifier/index.html"><span class="identifier">ClauseVerifier</span></a></code><br/>
|
||||
<p>The Interest Rate Swap class. For a quick overview of what an IRS is, see here - http://www.pimco.co.uk/EN/Education/Pages/InterestRateSwapsBasics1-08.aspx (no endorsement).
|
||||
This contract has 4 significant data classes within it, the "Common", "Calculation", "FixedLeg" and "FloatingLeg".
|
||||
It also has 4 commands, "Agree", "Fix", "Pay" and "Mature".
|
||||
@ -29,6 +29,12 @@ copy / update for each transition).</p>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-clause/index.html">Clause</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Clause</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-commands/index.html">Commands</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">interface </span><span class="identifier">Commands</span> <span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a></code></td>
|
||||
@ -88,6 +94,12 @@ This is just a representation of a vanilla Fixed vs Floating (same currency) IRS
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="clauses.html">clauses</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">clauses</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts.clauses/-single-clause.html"><span class="identifier">SingleClause</span></a><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="legal-contract-reference.html">legalContractReference</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">legalContractReference</span><span class="symbol">: </span><a href="../../com.r3corda.core.crypto/-secure-hash/index.html"><span class="identifier">SecureHash</span></a></code><p>Unparsed reference to the natural language contract that this code is supposed to express (usually a hash of
|
||||
@ -101,27 +113,9 @@ the contracts contents).</p>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="check-leg-amounts.html">checkLegAmounts</a></td>
|
||||
<a href="extract-commands.html">extractCommands</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">checkLegAmounts</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$checkLegAmounts(kotlin.Array((com.r3corda.contracts.InterestRateSwap.CommonLeg)))/legs">legs</span><span class="symbol">:</span> <span class="identifier">Array</span><span class="symbol"><</span><a href="-common-leg/index.html"><span class="identifier">CommonLeg</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="check-leg-dates.html">checkLegDates</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">checkLegDates</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$checkLegDates(kotlin.Array((com.r3corda.contracts.InterestRateSwap.CommonLeg)))/legs">legs</span><span class="symbol">:</span> <span class="identifier">Array</span><span class="symbol"><</span><a href="-common-leg/index.html"><span class="identifier">CommonLeg</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="check-rates.html">checkRates</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">checkRates</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$checkRates(kotlin.Array((com.r3corda.contracts.InterestRateSwap.CommonLeg)))/legs">legs</span><span class="symbol">:</span> <span class="identifier">Array</span><span class="symbol"><</span><a href="-common-leg/index.html"><span class="identifier">CommonLeg</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Boolean</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="check-schedules.html">checkSchedules</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">checkSchedules</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$checkSchedules(kotlin.Array((com.r3corda.contracts.InterestRateSwap.CommonLeg)))/legs">legs</span><span class="symbol">:</span> <span class="identifier">Array</span><span class="symbol"><</span><a href="-common-leg/index.html"><span class="identifier">CommonLeg</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Boolean</span></code></td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">extractCommands</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$extractCommands(com.r3corda.core.contracts.TransactionForContract)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Collection</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-authenticated-object/index.html"><span class="identifier">AuthenticatedObject</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a><span class="symbol">></span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
@ -135,20 +129,21 @@ Note: The day count, interest rate calculation etc are not finished yet, but the
|
||||
<td>
|
||||
<a href="generate-fix.html">generateFix</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateFix</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$generateFix(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.InterestRateSwap.State)), ((java.time.LocalDate, com.r3corda.contracts.Rate)))/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$generateFix(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.InterestRateSwap.State)), ((java.time.LocalDate, com.r3corda.contracts.Rate)))/irs">irs</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$generateFix(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.InterestRateSwap.State)), ((java.time.LocalDate, com.r3corda.contracts.Rate)))/fixing">fixing</span><span class="symbol">:</span> <span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <a href="../-rate/index.html"><span class="identifier">Rate</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">generateFix</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$generateFix(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.InterestRateSwap.State)), com.r3corda.core.contracts.Fix)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-builder/index.html"><span class="identifier">TransactionBuilder</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$generateFix(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.InterestRateSwap.State)), com.r3corda.core.contracts.Fix)/irs">irs</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-state-and-ref/index.html"><span class="identifier">StateAndRef</span></a><span class="symbol"><</span><a href="-state/index.html"><span class="identifier">State</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$generateFix(com.r3corda.core.contracts.TransactionBuilder, com.r3corda.core.contracts.StateAndRef((com.r3corda.contracts.InterestRateSwap.State)), com.r3corda.core.contracts.Fix)/fixing">fixing</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-fix/index.html"><span class="identifier">Fix</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inherited Functions</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="get-floating-leg-payments-differences.html">getFloatingLegPaymentsDifferences</a></td>
|
||||
<a href="../../com.r3corda.core.contracts.clauses/-clause-verifier/verify.html">verify</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">getFloatingLegPaymentsDifferences</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$getFloatingLegPaymentsDifferences(kotlin.collections.Map((java.time.LocalDate, com.r3corda.contracts.Event)), kotlin.collections.Map((java.time.LocalDate, com.r3corda.contracts.Event)))/payments1">payments1</span><span class="symbol">:</span> <span class="identifier">Map</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><span class="symbol">,</span> <a href="../-event/index.html"><span class="identifier">Event</span></a><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$getFloatingLegPaymentsDifferences(kotlin.collections.Map((java.time.LocalDate, com.r3corda.contracts.Event)), kotlin.collections.Map((java.time.LocalDate, com.r3corda.contracts.Event)))/payments2">payments2</span><span class="symbol">:</span> <span class="identifier">Map</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><span class="symbol">,</span> <a href="../-event/index.html"><span class="identifier">Event</span></a><span class="symbol">></span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><span class="identifier"><ERROR CLASS></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><span class="symbol">,</span> <span class="identifier"><ERROR CLASS></span><span class="symbol"><</span><a href="../-floating-rate-payment-event/index.html"><span class="identifier">FloatingRatePaymentEvent</span></a><span class="symbol">,</span> <a href="../-floating-rate-payment-event/index.html"><span class="identifier">FloatingRatePaymentEvent</span></a><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span></code><p>Compares two schedules of Floating Leg Payments, returns the difference (i.e. omissions in either leg or changes to the values).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="verify.html">verify</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">fun </span><span class="identifier">verify</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.contracts.InterestRateSwap$verify(com.r3corda.core.contracts.TransactionForContract)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>verify() with some examples of what needs to be checked.</p>
|
||||
<code><span class="keyword">open</span> <span class="keyword">fun </span><span class="identifier">verify</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.core.contracts.clauses.ClauseVerifier$verify(com.r3corda.core.contracts.TransactionForContract)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Unit</span></code><p>Takes an object that represents a state transition, and ensures the inputs/outputs/commands make sense.
|
||||
Must throw an exception if theres a problem that should prevent state transition. Takes a single object
|
||||
rather than an argument so that additional data can be added without breaking binary compatibility with
|
||||
existing contract code.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
||||
@ -9,6 +9,7 @@
|
||||
<h1>toString</h1>
|
||||
<a name="com.r3corda.contracts.PercentageRatioUnit$toString()"></a>
|
||||
<code><span class="keyword">open</span> <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"><ERROR CLASS></span></code><br/>
|
||||
Overrides <a href="../-ratio-unit/to-string.html">RatioUnit.toString</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -9,10 +9,10 @@
|
||||
<h1>hashCode</h1>
|
||||
<a name="com.r3corda.contracts.Rate$hashCode()"></a>
|
||||
<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">Int</span></code><br/>
|
||||
<strong>Returns</strong><br/>
|
||||
<p><strong>Returns</strong><br/>
|
||||
the hash code of the ratioUnit or zero if the ratioUnit is null, as is the case for floating rate fixings
|
||||
that have not yet happened. Yet-to-be fixed floating rates need to be equal such that schedules can be tested
|
||||
for equality.<br/>
|
||||
for equality.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -49,6 +49,12 @@
|
||||
<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">Int</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="to-string.html">toString</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <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>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
|
||||
15
docs/build/html/api/com.r3corda.contracts/-rate/to-string.html
vendored
Normal file
15
docs/build/html/api/com.r3corda.contracts/-rate/to-string.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>Rate.toString - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts</a> / <a href="index.html">Rate</a> / <a href=".">toString</a><br/>
|
||||
<br/>
|
||||
<h1>toString</h1>
|
||||
<a name="com.r3corda.contracts.Rate$toString()"></a>
|
||||
<code><span class="keyword">open</span> <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><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -49,6 +49,12 @@
|
||||
<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">Int</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="to-string.html">toString</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <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>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
|
||||
15
docs/build/html/api/com.r3corda.contracts/-ratio-unit/to-string.html
vendored
Normal file
15
docs/build/html/api/com.r3corda.contracts/-ratio-unit/to-string.html
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<title>RatioUnit.toString - </title>
|
||||
<link rel="stylesheet" href="../../style.css">
|
||||
</HEAD>
|
||||
<BODY>
|
||||
<a href="../index.html">com.r3corda.contracts</a> / <a href="index.html">RatioUnit</a> / <a href=".">toString</a><br/>
|
||||
<br/>
|
||||
<h1>toString</h1>
|
||||
<a name="com.r3corda.contracts.RatioUnit$toString()"></a>
|
||||
<code><span class="keyword">open</span> <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><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
</HTML>
|
||||
@ -9,6 +9,7 @@
|
||||
<h1>toString</h1>
|
||||
<a name="com.r3corda.contracts.ReferenceRate$toString()"></a>
|
||||
<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><br/>
|
||||
Overrides <a href="../-rate/to-string.html">Rate.toString</a><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -14,7 +14,13 @@
|
||||
<td>
|
||||
<a href="-commercial-paper/index.html">CommercialPaper</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">CommercialPaper</span> <span class="symbol">:</span> <a href="../com.r3corda.core.contracts/-contract/index.html"><span class="identifier">Contract</span></a></code></td>
|
||||
<code><span class="keyword">class </span><span class="identifier">CommercialPaper</span> <span class="symbol">:</span> <a href="../com.r3corda.core.contracts.clauses/-clause-verifier/index.html"><span class="identifier">ClauseVerifier</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-commercial-paper-legacy/index.html">CommercialPaperLegacy</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">CommercialPaperLegacy</span> <span class="symbol">:</span> <a href="../com.r3corda.core.contracts/-contract/index.html"><span class="identifier">Contract</span></a></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
@ -57,7 +63,7 @@ If the rate is null returns a zero payment. // TODO: Is this the desired behavio
|
||||
<td>
|
||||
<a href="-interest-rate-swap/index.html">InterestRateSwap</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">InterestRateSwap</span> <span class="symbol">:</span> <a href="../com.r3corda.core.contracts/-contract/index.html"><span class="identifier">Contract</span></a></code><p>The Interest Rate Swap class. For a quick overview of what an IRS is, see here - http://www.pimco.co.uk/EN/Education/Pages/InterestRateSwapsBasics1-08.aspx (no endorsement).
|
||||
<code><span class="keyword">class </span><span class="identifier">InterestRateSwap</span> <span class="symbol">:</span> <a href="../com.r3corda.core.contracts.clauses/-clause-verifier/index.html"><span class="identifier">ClauseVerifier</span></a></code><p>The Interest Rate Swap class. For a quick overview of what an IRS is, see here - http://www.pimco.co.uk/EN/Education/Pages/InterestRateSwapsBasics1-08.aspx (no endorsement).
|
||||
This contract has 4 significant data classes within it, the "Common", "Calculation", "FixedLeg" and "FloatingLeg".
|
||||
It also has 4 commands, "Agree", "Fix", "Pay" and "Mature".
|
||||
Currently, we are not interested (excuse pun) in valuing the swap, calculating the PVs, DFs and all that good stuff (soon though).
|
||||
@ -141,6 +147,14 @@ e.g. LIBOR 6M as of 17 March 2016. Hence it requires a source (name) and a value
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-c-p_-l-e-g-a-c-y_-p-r-o-g-r-a-m_-i-d.html">CP_LEGACY_PROGRAM_ID</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">val </span><span class="identifier">CP_LEGACY_PROGRAM_ID</span><span class="symbol">: </span><a href="-commercial-paper-legacy/index.html"><span class="identifier">CommercialPaperLegacy</span></a></code><p>Legacy version of <a href="-commercial-paper/index.html">CommercialPaper</a> that includes the full verification logic itself, rather than breaking it
|
||||
into clauses. This is here just as an example for the contract tutorial.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="-c-p_-p-r-o-g-r-a-m_-i-d.html">CP_PROGRAM_ID</a></td>
|
||||
<td>
|
||||
<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><p>This is an ultra-trivial implementation of commercial paper, which is essentially a simpler version of a corporate
|
||||
|
||||
@ -70,5 +70,47 @@ existing contract code.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../com.r3corda.contracts.asset/-cash/index.html">Cash</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Cash</span> <span class="symbol">:</span> <span class="identifier">ClauseVerifier</span></code><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>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../com.r3corda.contracts/-commercial-paper/index.html">CommercialPaper</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">CommercialPaper</span> <span class="symbol">:</span> <span class="identifier">ClauseVerifier</span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../com.r3corda.contracts/-interest-rate-swap/index.html">InterestRateSwap</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">InterestRateSwap</span> <span class="symbol">:</span> <span class="identifier">ClauseVerifier</span></code><p>The Interest Rate Swap class. For a quick overview of what an IRS is, see here - http://www.pimco.co.uk/EN/Education/Pages/InterestRateSwapsBasics1-08.aspx (no endorsement).
|
||||
This contract has 4 significant data classes within it, the "Common", "Calculation", "FixedLeg" and "FloatingLeg".
|
||||
It also has 4 commands, "Agree", "Fix", "Pay" and "Mature".
|
||||
Currently, we are not interested (excuse pun) in valuing the swap, calculating the PVs, DFs and all that good stuff (soon though).
|
||||
This is just a representation of a vanilla Fixed vs Floating (same currency) IRS in the R3 prototype model.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../com.r3corda.contracts.asset/-obligation/index.html">Obligation</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Obligation</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">ClauseVerifier</span></code><p>An obligation contract commits the obligor to delivering a specified amount of a fungible asset (for example the
|
||||
<a href="../../com.r3corda.contracts.asset/-cash/index.html">Cash</a> contract) at a specified future point in time. Settlement transactions may split and merge contracts across
|
||||
multiple input and output states. The goal of this design is to handle amounts owed, and these contracts are expected
|
||||
to be netted/merged, with settlement only for any remainder amount.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
|
||||
@ -8,7 +8,7 @@
|
||||
<br/>
|
||||
<h1>extractGroups</h1>
|
||||
<a name="com.r3corda.core.contracts.clauses.GroupClauseVerifier$extractGroups(com.r3corda.core.contracts.TransactionForContract)"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">extractGroups</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.core.contracts.clauses.GroupClauseVerifier$extractGroups(com.r3corda.core.contracts.TransactionForContract)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-transaction-for-contract/-in-out-group/index.html"><span class="identifier">InOutGroup</span></a><span class="symbol"><</span><span class="keyword">out</span> <span class="identifier">S</span><span class="symbol">,</span> <span class="identifier">T</span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">extractGroups</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.core.contracts.clauses.GroupClauseVerifier$extractGroups(com.r3corda.core.contracts.TransactionForContract)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-transaction-for-contract/-in-out-group/index.html"><span class="identifier">InOutGroup</span></a><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">,</span> <span class="identifier">T</span><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -34,7 +34,7 @@
|
||||
<td>
|
||||
<a href="required-commands.html">requiredCommands</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">requiredCommands</span><span class="symbol">: </span><span class="identifier">Set</span><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html"><span class="identifier">Class</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a><span class="symbol">></span><span class="symbol">></span></code><p>Classes for commands which must ALL be present in transaction for this clause to be triggered</p>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">requiredCommands</span><span class="symbol">: </span><span class="identifier">Set</span><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html"><span class="identifier">Class</span></a><span class="symbol"><</span><span class="keyword">out</span> <a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a><span class="symbol">></span><span class="symbol">></span></code><p>Classes for commands which must ALL be present in transaction for this clause to be triggered</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -46,7 +46,7 @@
|
||||
<td>
|
||||
<a href="extract-groups.html">extractGroups</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">extractGroups</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.core.contracts.clauses.GroupClauseVerifier$extractGroups(com.r3corda.core.contracts.TransactionForContract)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-transaction-for-contract/-in-out-group/index.html"><span class="identifier">InOutGroup</span></a><span class="symbol"><</span><span class="keyword">out</span> <span class="identifier">S</span><span class="symbol">,</span> <span class="identifier">T</span><span class="symbol">></span><span class="symbol">></span></code></td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">extractGroups</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.core.contracts.clauses.GroupClauseVerifier$extractGroups(com.r3corda.core.contracts.TransactionForContract)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">List</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-transaction-for-contract/-in-out-group/index.html"><span class="identifier">InOutGroup</span></a><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">,</span> <span class="identifier">T</span><span class="symbol">></span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
@ -59,5 +59,35 @@ if any matched.</p>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../com.r3corda.contracts.asset/-cash/-clauses/-group/index.html">Group</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Group</span> <span class="symbol">:</span> <span class="identifier">GroupClauseVerifier</span><span class="symbol"><</span><a href="../../com.r3corda.contracts.asset/-cash/-state/index.html"><span class="identifier">State</span></a><span class="symbol">,</span> <a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Currency.html"><span class="identifier">Currency</span></a><span class="symbol">></span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../com.r3corda.contracts.asset/-obligation/-clauses/-group/index.html">Group</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Group</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">GroupClauseVerifier</span><span class="symbol"><</span><a href="../../com.r3corda.contracts.asset/-obligation/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">,</span> <a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../../com.r3corda.contracts.asset/-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span></code><p>Parent clause for clauses that operate on grouped states (those which are fungible).</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../com.r3corda.contracts/-commercial-paper/-clauses/-group/index.html">Group</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Group</span> <span class="symbol">:</span> <span class="identifier">GroupClauseVerifier</span><span class="symbol"><</span><a href="../../com.r3corda.contracts/-commercial-paper/-state/index.html"><span class="identifier">State</span></a><span class="symbol">,</span> <a href="../../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../../com.r3corda.contracts/-commercial-paper/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol">></span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../../com.r3corda.contracts/-interest-rate-swap/-clause/-group/index.html">Group</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Group</span> <span class="symbol">:</span> <span class="identifier">GroupClauseVerifier</span><span class="symbol"><</span><a href="../../com.r3corda.contracts/-interest-rate-swap/-state/index.html"><span class="identifier">State</span></a><span class="symbol">,</span> <span class="identifier">String</span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
|
||||
@ -8,12 +8,12 @@
|
||||
<br/>
|
||||
<h1>requiredCommands</h1>
|
||||
<a name="com.r3corda.core.contracts.clauses.GroupClauseVerifier$requiredCommands"></a>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">requiredCommands</span><span class="symbol">: </span><span class="identifier">Set</span><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html"><span class="identifier">Class</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
<code><span class="keyword">open</span> <span class="keyword">val </span><span class="identifier">requiredCommands</span><span class="symbol">: </span><span class="identifier">Set</span><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html"><span class="identifier">Class</span></a><span class="symbol"><</span><span class="keyword">out</span> <a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../-clause/required-commands.html">Clause.requiredCommands</a><br/>
|
||||
<p>Classes for commands which must ALL be present in transaction for this clause to be triggered</p>
|
||||
<strong>Getter</strong><br/>
|
||||
<p><strong>Getter</strong><br/>
|
||||
<p>Classes for commands which must ALL be present in transaction for this clause to be triggered</p>
|
||||
<br/>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -13,11 +13,11 @@ Overrides <a href="../-single-verify/verify.html">SingleVerify.verify</a><br/>
|
||||
<p>Verify the transaction matches the conditions from this clause. For example, a "no zero amount output" clause
|
||||
would check each of the output states that it applies to, looking for a zero amount, and throw IllegalStateException
|
||||
if any matched.</p>
|
||||
<strong>Return</strong><br/>
|
||||
<p><strong>Return</strong><br/>
|
||||
the set of commands that are consumed IF this clause is matched, and cannot be used to match a
|
||||
later clause. This would normally be all commands matching "requiredCommands" for this clause, but some
|
||||
verify() functions may do further filtering on possible matches, and return a subset. This may also include
|
||||
commands that were not required (for example the Exit command for fungible assets is optional).<br/>
|
||||
commands that were not required (for example the Exit command for fungible assets is optional).</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -36,5 +36,73 @@
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h3>Inheritors</h3>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.clause/-abstract-conserve-amount/index.html">AbstractConserveAmount</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">AbstractConserveAmount</span><span class="symbol"><</span><span class="identifier">S</span> <span class="symbol">:</span> <a href="../com.r3corda.contracts.asset/-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier">T</span> <span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">GroupClause</span><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">,</span> <a href="../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">></span></code><p>Standardised clause for checking input/output balances of fungible assets. Requires that a
|
||||
Move command is provided, and errors if absent. Must be the last clause under a grouping clause;
|
||||
errors on no-match, ends on match.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts/-commercial-paper/-clauses/-abstract-group-clause/index.html">AbstractGroupClause</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">AbstractGroupClause</span> <span class="symbol">:</span> <span class="identifier">GroupClause</span><span class="symbol"><</span><a href="../com.r3corda.contracts/-commercial-paper/-state/index.html"><span class="identifier">State</span></a><span class="symbol">,</span> <a href="../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../com.r3corda.contracts/-commercial-paper/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol">></span><span class="symbol">></span></code></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts/-interest-rate-swap/-clause/-abstract-i-r-s-clause/index.html">AbstractIRSClause</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">AbstractIRSClause</span> <span class="symbol">:</span> <span class="identifier">GroupClause</span><span class="symbol"><</span><a href="../com.r3corda.contracts/-interest-rate-swap/-state/index.html"><span class="identifier">State</span></a><span class="symbol">,</span> <span class="identifier">String</span><span class="symbol">></span></code><p>Common superclass for IRS contract clauses, which defines behaviour on match/no-match, and provides
|
||||
helper functions for the clauses.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.clause/-abstract-issue/index.html">AbstractIssue</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">class </span><span class="identifier">AbstractIssue</span><span class="symbol"><</span><span class="identifier">S</span> <span class="symbol">:</span> <a href="../com.r3corda.core.contracts/-contract-state/index.html"><span class="identifier">ContractState</span></a><span class="symbol">, </span><span class="identifier">T</span> <span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">GroupClause</span><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">,</span> <a href="../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">></span></code><p>Standard issue clause for contracts that issue fungible assets.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.clause/-no-zero-sized-outputs/index.html">NoZeroSizedOutputs</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">open</span> <span class="keyword">class </span><span class="identifier">NoZeroSizedOutputs</span><span class="symbol"><</span><span class="identifier">S</span> <span class="symbol">:</span> <a href="../com.r3corda.contracts.asset/-fungible-asset/index.html"><span class="identifier">FungibleAsset</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier">T</span> <span class="symbol">:</span> <span class="identifier">Any</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">GroupClause</span><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">,</span> <a href="../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><span class="identifier">T</span><span class="symbol">></span><span class="symbol">></span></code><p>Clause for fungible asset contracts, which enforces that no output state should have
|
||||
a balance of zero.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.asset/-obligation/-clauses/-set-lifecycle/index.html">SetLifecycle</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">SetLifecycle</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">GroupClause</span><span class="symbol"><</span><a href="../com.r3corda.contracts.asset/-obligation/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">,</span> <a href="../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../com.r3corda.contracts.asset/-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span></code><p>Obligation-specific clause for changing the lifecycle of one or more states.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.asset/-obligation/-clauses/-settle/index.html">Settle</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">Settle</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <span class="identifier">GroupClause</span><span class="symbol"><</span><a href="../com.r3corda.contracts.asset/-obligation/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">,</span> <a href="../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../com.r3corda.contracts.asset/-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span></code><p>Obligation-specific clause for settling an outstanding obligation by witnessing
|
||||
change of ownership of other states to fulfil</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="../com.r3corda.contracts.asset/-obligation/-clauses/-verify-lifecycle/index.html">VerifyLifecycle</a></td>
|
||||
<td>
|
||||
<code><span class="keyword">class </span><span class="identifier">VerifyLifecycle</span><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span> <span class="symbol">:</span> <a href="-single-clause.html"><span class="identifier">SingleClause</span></a><span class="symbol">, </span><span class="identifier">GroupClause</span><span class="symbol"><</span><a href="../com.r3corda.contracts.asset/-obligation/-state/index.html"><span class="identifier">State</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">,</span> <a href="../com.r3corda.core.contracts/-issued/index.html"><span class="identifier">Issued</span></a><span class="symbol"><</span><a href="../com.r3corda.contracts.asset/-obligation/-terms/index.html"><span class="identifier">Terms</span></a><span class="symbol"><</span><span class="identifier">P</span><span class="symbol">></span><span class="symbol">></span><span class="symbol">></span></code><p>Obligation-specific clause for verifying that all states are in
|
||||
normal lifecycle. In a group clause set, this must be run after
|
||||
any lifecycle change clause, which is the only clause that involve
|
||||
non-standard lifecycle states on input/output.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</BODY>
|
||||
</HTML>
|
||||
|
||||
@ -9,9 +9,9 @@
|
||||
<h1>verify</h1>
|
||||
<a name="com.r3corda.core.contracts.clauses.GroupVerify$verify(com.r3corda.core.contracts.TransactionForContract, kotlin.collections.List((com.r3corda.core.contracts.clauses.GroupVerify.S)), kotlin.collections.List((com.r3corda.core.contracts.clauses.GroupVerify.S)), kotlin.collections.Collection((com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.core.contracts.CommandData)))), com.r3corda.core.contracts.clauses.GroupVerify.T)"></a>
|
||||
<code><span class="keyword">abstract</span> <span class="keyword">fun </span><span class="identifier">verify</span><span class="symbol">(</span><span class="identifier" id="com.r3corda.core.contracts.clauses.GroupVerify$verify(com.r3corda.core.contracts.TransactionForContract, kotlin.collections.List((com.r3corda.core.contracts.clauses.GroupVerify.S)), kotlin.collections.List((com.r3corda.core.contracts.clauses.GroupVerify.S)), kotlin.collections.Collection((com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.core.contracts.CommandData)))), com.r3corda.core.contracts.clauses.GroupVerify.T)/tx">tx</span><span class="symbol">:</span> <a href="../../com.r3corda.core.contracts/-transaction-for-contract/index.html"><span class="identifier">TransactionForContract</span></a><span class="symbol">, </span><span class="identifier" id="com.r3corda.core.contracts.clauses.GroupVerify$verify(com.r3corda.core.contracts.TransactionForContract, kotlin.collections.List((com.r3corda.core.contracts.clauses.GroupVerify.S)), kotlin.collections.List((com.r3corda.core.contracts.clauses.GroupVerify.S)), kotlin.collections.Collection((com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.core.contracts.CommandData)))), com.r3corda.core.contracts.clauses.GroupVerify.T)/inputs">inputs</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.core.contracts.clauses.GroupVerify$verify(com.r3corda.core.contracts.TransactionForContract, kotlin.collections.List((com.r3corda.core.contracts.clauses.GroupVerify.S)), kotlin.collections.List((com.r3corda.core.contracts.clauses.GroupVerify.S)), kotlin.collections.Collection((com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.core.contracts.CommandData)))), com.r3corda.core.contracts.clauses.GroupVerify.T)/outputs">outputs</span><span class="symbol">:</span> <span class="identifier">List</span><span class="symbol"><</span><span class="identifier">S</span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.core.contracts.clauses.GroupVerify$verify(com.r3corda.core.contracts.TransactionForContract, kotlin.collections.List((com.r3corda.core.contracts.clauses.GroupVerify.S)), kotlin.collections.List((com.r3corda.core.contracts.clauses.GroupVerify.S)), kotlin.collections.Collection((com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.core.contracts.CommandData)))), com.r3corda.core.contracts.clauses.GroupVerify.T)/commands">commands</span><span class="symbol">:</span> <span class="identifier">Collection</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-authenticated-object/index.html"><span class="identifier">AuthenticatedObject</span></a><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a><span class="symbol">></span><span class="symbol">></span><span class="symbol">, </span><span class="identifier" id="com.r3corda.core.contracts.clauses.GroupVerify$verify(com.r3corda.core.contracts.TransactionForContract, kotlin.collections.List((com.r3corda.core.contracts.clauses.GroupVerify.S)), kotlin.collections.List((com.r3corda.core.contracts.clauses.GroupVerify.S)), kotlin.collections.Collection((com.r3corda.core.contracts.AuthenticatedObject((com.r3corda.core.contracts.CommandData)))), com.r3corda.core.contracts.clauses.GroupVerify.T)/token">token</span><span class="symbol">:</span> <span class="identifier">T</span><span class="symbol">)</span><span class="symbol">: </span><span class="identifier">Set</span><span class="symbol"><</span><a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a><span class="symbol">></span></code><br/>
|
||||
<strong>Return</strong><br/>
|
||||
<p><strong>Return</strong><br/>
|
||||
the set of commands that are consumed IF this clause is matched, and cannot be used to match a
|
||||
later clause.<br/>
|
||||
later clause.</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -11,9 +11,9 @@
|
||||
<code><span class="keyword">val </span><span class="identifier">ifMatched</span><span class="symbol">: </span><a href="../-match-behaviour/index.html"><span class="identifier">MatchBehaviour</span></a></code><br/>
|
||||
Overrides <a href="../-clause/if-matched.html">Clause.ifMatched</a><br/>
|
||||
<p>Behaviour if this clause is not matches</p>
|
||||
<strong>Getter</strong><br/>
|
||||
<p><strong>Getter</strong><br/>
|
||||
<p>Behaviour if this clause is not matches</p>
|
||||
<br/>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -11,9 +11,9 @@
|
||||
<code><span class="keyword">val </span><span class="identifier">ifNotMatched</span><span class="symbol">: </span><a href="../-match-behaviour/index.html"><span class="identifier">MatchBehaviour</span></a></code><br/>
|
||||
Overrides <a href="../-clause/if-not-matched.html">Clause.ifNotMatched</a><br/>
|
||||
<p>Behaviour if this clause is matched</p>
|
||||
<strong>Getter</strong><br/>
|
||||
<p><strong>Getter</strong><br/>
|
||||
<p>Behaviour if this clause is matched</p>
|
||||
<br/>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -11,9 +11,9 @@
|
||||
<code><span class="keyword">val </span><span class="identifier">requiredCommands</span><span class="symbol">: </span><span class="identifier">Set</span><span class="symbol"><</span><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Class.html"><span class="identifier">Class</span></a><span class="symbol"><</span><span class="keyword">out</span> <a href="../../com.r3corda.core.contracts/-command-data.html"><span class="identifier">CommandData</span></a><span class="symbol">></span><span class="symbol">></span></code><br/>
|
||||
Overrides <a href="../-clause/required-commands.html">Clause.requiredCommands</a><br/>
|
||||
<p>Classes for commands which must ALL be present in transaction for this clause to be triggered</p>
|
||||
<strong>Getter</strong><br/>
|
||||
<p><strong>Getter</strong><br/>
|
||||
<p>Classes for commands which must ALL be present in transaction for this clause to be triggered</p>
|
||||
<br/>
|
||||
</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
@ -13,11 +13,11 @@ Overrides <a href="../-single-verify/verify.html">SingleVerify.verify</a><br/>
|
||||
<p>Verify the transaction matches the conditions from this clause. For example, a "no zero amount output" clause
|
||||
would check each of the output states that it applies to, looking for a zero amount, and throw IllegalStateException
|
||||
if any matched.</p>
|
||||
<strong>Return</strong><br/>
|
||||
<p><strong>Return</strong><br/>
|
||||
the set of commands that are consumed IF this clause is matched, and cannot be used to match a
|
||||
later clause. This would normally be all commands matching "requiredCommands" for this clause, but some
|
||||
verify() functions may do further filtering on possible matches, and return a subset. This may also include
|
||||
commands that were not required (for example the Exit command for fungible assets is optional).<br/>
|
||||
commands that were not required (for example the Exit command for fungible assets is optional).</p>
|
||||
<br/>
|
||||
<br/>
|
||||
</BODY>
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user