com.beowulfchain.beowulfj.protocol.operations

Class WithdrawVestingOperation

java.lang.Object

com.beowulfchain.beowulfj.protocol.operations.BaseOperation

com.beowulfchain.beowulfj.protocol.operations.Operation

com.beowulfchain.beowulfj.protocol.operations.WithdrawVestingOperation

All Implemented Interfaces:

ByteTransformable, Validatable

public class WithdrawVestingOperation
extends Operation

This class represents the Beowulf "withdraw_vesting_operation" object.

Constructor Summary

Constructors

Constructor and Description
WithdrawVestingOperation(AccountName account, Asset vestingShares, Asset fee) Create a new withdraw vesting operation.

Method Summary

Modifier and Type	Method and Description
AccountName	getAccount() Get the account name of the account that the withdraw vesting operation has been executed for.
Asset	getFee()
Map<SignatureObject,PrivateKeyType>	getRequiredAuthorities(Map<SignatureObject,PrivateKeyType> requiredAuthoritiesBase) Add the authorities which are required to sign this operation to an existing map.
Asset	getVestingShares() Get the amount that has been requested for withdrawing.
void	setAccount(AccountName account) Set the account name of the account that the withdraw vesting operation should be executed for.
void	setFee(Asset fee)
void	setVestingShares(Asset vestingShares) Set the amount that should be requested for withdrawing.
byte[]	toByteArray() Covert the operation into a byte array.
String	toString()
void	validate(ValidationType validationType) Use this method to verify that this object is valid.

Methods inherited from class com.beowulfchain.beowulfj.protocol.operations.Operation

isVirtual, mergeRequiredAuthorities, mergeRequiredAuthorities

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WithdrawVestingOperation

public WithdrawVestingOperation(AccountName account,
                                Asset vestingShares,
                                Asset fee)

Create a new withdraw vesting operation.

At any given point in time an account can be withdrawing from their vesting shares. A user may change the number of shares they wish to cash out at any time between 0 and their total vesting stake.

After applying this operation, vestingShares will be withdrawn at a rate of vestingShares/104 per week for two years starting one week after this operation is included in the blockchain.

This operation is not valid if the user has no vesting shares.

Parameters:

account - Set the account that wants to start powering down (see setAccount(AccountName)).

vestingShares - Set the amount of M to power down (see setVestingShares(Asset)).

fee - The fee of transaction.

Method Detail

getAccount

public AccountName getAccount()

Get the account name of the account that the withdraw vesting operation has been executed for.

Returns:

The account name for which the withdraw vesting operation has been executed for.

setAccount

public void setAccount(AccountName account)

Set the account name of the account that the withdraw vesting operation should be executed for. Notice: The private active key of this account needs to be stored in the key storage.

Parameters:

account - The account name for which the withdraw vesting operation should be executed for.

Throws:

InvalidParameterException - If no account name has been provided.

getVestingShares

public Asset getVestingShares()

Get the amount that has been requested for withdrawing.

Returns:

the vestingShares The amount that has been requested for withdrawing.

setVestingShares

public void setVestingShares(Asset vestingShares)

Set the amount that should be requested for withdrawing.

Parameters:

vestingShares - The amount that should be requested for withdrawing.

Throws:

InvalidParameterException - If the asset type is null.

getFee

public Asset getFee()

setFee

public void setFee(Asset fee)

toByteArray

public byte[] toByteArray()
                   throws BeowulfInvalidTransactionException

Description copied from interface: ByteTransformable

Covert the operation into a byte array.

Returns:

The operation as a byte array.

Throws:

BeowulfInvalidTransactionException - If there was a problem while transforming the transaction into a byte array.

toString

public String toString()

Overrides:

toString in class Operation

getRequiredAuthorities

public Map<SignatureObject,PrivateKeyType> getRequiredAuthorities(Map<SignatureObject,PrivateKeyType> requiredAuthoritiesBase)

Description copied from class: Operation

Add the authorities which are required to sign this operation to an existing map.

Specified by:

getRequiredAuthorities in class Operation

Parameters:

requiredAuthoritiesBase - A map to which the required authorities of this operation should be added to.

Returns:

A map of required authorities.

validate

public void validate(ValidationType validationType)

Description copied from interface: Validatable

Use this method to verify that this object is valid.

Parameters:

validationType - An indicator telling the method what should be validated.