P
- the product the obligation is for payment of.public static class Obligation.State<P> implements FungibleAsset<T>, NettableState<N,T>
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.
Constructor and Description |
---|
State(Obligation.Lifecycle lifecycle,
AbstractParty obligor,
Obligation.Terms<P> template,
long quantity,
AbstractParty beneficiary)
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.
|
Modifier and Type | Method and Description |
---|---|
Obligation.Lifecycle |
component1() |
AbstractParty |
component2()
Where the debt originates from
|
Obligation.Terms<P> |
component3() |
long |
component4() |
AbstractParty |
component5()
The public key of the entity the contract pays to
|
Obligation.State<P> |
copy(Obligation.Lifecycle lifecycle,
AbstractParty obligor,
Obligation.Terms<P> template,
long quantity,
AbstractParty beneficiary)
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.
|
boolean |
equals(java.lang.Object p) |
Amount<net.corda.core.contracts.Issued> |
getAmount()
Amount represents a positive quantity of some issued product which can be cash, tokens, assets, or generally
anything else that's quantifiable with integer quantities. See
class Issued and class Amount for more details. |
AbstractParty |
getBeneficiary()
The public key of the entity the contract pays to
|
BilateralNetState<P> |
getBilateralNetState()
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.
|
java.time.Instant |
getDueBefore() |
java.util.Collection<java.security.PublicKey> |
getExitKeys()
There must be an ExitCommand signed by these keys to destroy the amount. While all states require their
owner to sign, some (i.e. cash) also require the issuer.
|
Obligation.Lifecycle |
getLifecycle() |
MultilateralNetState<P> |
getMultilateralNetState()
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.
|
AbstractParty |
getObligor()
Where the debt originates from
|
AbstractParty |
getOwner()
There must be a MoveCommand signed by this key to claim the amount.
|
java.util.List<net.corda.core.identity.AbstractParty> |
getParticipants() |
long |
getQuantity() |
Obligation.Terms<P> |
getTemplate() |
int |
hashCode() |
Obligation.State<P> |
net(Obligation.State<P> other)
Perform bilateral netting of this state with another state. The two states must be compatible (as in
bilateralNetState objects are equal).
|
void |
setLifecycle(Obligation.Lifecycle p) |
java.lang.String |
toString() |
CommandAndState |
withNewOwner(AbstractParty newOwner)
Copies the underlying data structure, replacing the owner field with this new value and leaving the rest alone.
|
Obligation.State<P> |
withNewOwnerAndAmount(Amount<net.corda.core.contracts.Issued> newAmount,
AbstractParty newOwner)
Copies the underlying data structure, replacing the amount and owner fields with the new values and leaving the
rest (exitKeys) alone.
|
getAmount, getExitKeys, withNewOwnerAndAmount
getAmount
getOwner, withNewOwner
getParticipants
getBilateralNetState, net
getMultilateralNetState
public State(Obligation.Lifecycle lifecycle, AbstractParty obligor, Obligation.Terms<P> template, long quantity, AbstractParty beneficiary)
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.
obligor
- Where the debt originates from (obligor)beneficiary
- The public key of the entity the contract pays topublic Amount<net.corda.core.contracts.Issued> getAmount()
Amount represents a positive quantity of some issued product which can be cash, tokens, assets, or generally
anything else that's quantifiable with integer quantities. See class Issued
and class Amount
for more details.
class Issued
,
class Amount
public java.util.Collection<java.security.PublicKey> getExitKeys()
There must be an ExitCommand signed by these keys to destroy the amount. While all states require their owner to sign, some (i.e. cash) also require the issuer.
public java.time.Instant getDueBefore()
public java.util.List<net.corda.core.identity.AbstractParty> getParticipants()
public AbstractParty getOwner()
There must be a MoveCommand signed by this key to claim the amount.
public Obligation.State<P> withNewOwnerAndAmount(Amount<net.corda.core.contracts.Issued> newAmount, AbstractParty newOwner)
Copies the underlying data structure, replacing the amount and owner fields with the new values and leaving the rest (exitKeys) alone.
public java.lang.String toString()
public BilateralNetState<P> getBilateralNetState()
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.
public MultilateralNetState<P> getMultilateralNetState()
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.
public Obligation.State<P> net(Obligation.State<P> other)
Perform bilateral netting of this state with another state. The two states must be compatible (as in bilateralNetState objects are equal).
public CommandAndState withNewOwner(AbstractParty newOwner)
Copies the underlying data structure, replacing the owner field with this new value and leaving the rest alone.
public Obligation.Lifecycle getLifecycle()
public void setLifecycle(Obligation.Lifecycle p)
public AbstractParty getObligor()
Where the debt originates from
(obligor)
public Obligation.Terms<P> getTemplate()
public long getQuantity()
public AbstractParty getBeneficiary()
The public key of the entity the contract pays to
public Obligation.Lifecycle component1()
public AbstractParty component2()
Where the debt originates from
(obligor)
public Obligation.Terms<P> component3()
public long component4()
public AbstractParty component5()
The public key of the entity the contract pays to
public Obligation.State<P> copy(Obligation.Lifecycle lifecycle, AbstractParty obligor, Obligation.Terms<P> template, long quantity, AbstractParty beneficiary)
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.
public int hashCode()
public boolean equals(java.lang.Object p)