All Superinterfaces:: com.google.protobuf.MessageLiteOrBuilder

All Known Implementing Classes:: TokenRelation, TokenRelation.Builder

@Generated public interface TokenRelationOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

Method Summary

Modifier and Type

Method

Description

AccountID

getAccountId()

* An account identifier.

boolean

getAutomaticAssociation()

* A flag indicating that this token relationship was created using automatic association.

long

getBalance()

* The fungible token balance of this token relationship.

boolean

getFrozen()

* A flag indicating that this token relationship is frozen.

boolean

getKycGranted()

* A flag indicating that this token relationship has been granted KYC status.

TokenID

getNextToken()

* The Token ID of the next entry in the associated Account's "virtual double-linked list" of token relationships.

TokenID

getPreviousToken()

* The Token ID of the previous entry in the associated Account's "virtual double-linked list" of token relationships.

TokenID

getTokenId()

* A token identifier.

boolean

hasAccountId()

* An account identifier.

boolean

hasNextToken()

* The Token ID of the next entry in the associated Account's "virtual double-linked list" of token relationships.

boolean

hasPreviousToken()

* The Token ID of the previous entry in the associated Account's "virtual double-linked list" of token relationships.

boolean

hasTokenId()

* A token identifier.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType, isInitialized

Method Details

hasTokenId

boolean hasTokenId()
```
 *
 A token identifier.
 <p>
 This SHALL identify the token involved in this association.
 
```
.proto.TokenID token_id = 1;
Returns:

Whether the tokenId field is set.

getTokenId

TokenID getTokenId()

 *
 A token identifier.
 <p>
 This SHALL identify the token involved in this association.

.proto.TokenID token_id = 1;

Returns:: The tokenId.

hasAccountId

boolean hasAccountId()
```
 *
 An account identifier.
 <p>
 This SHALL identify the account involved in this association.
 
```
.proto.AccountID account_id = 2;
Returns:

Whether the accountId field is set.

getAccountId

AccountID getAccountId()

 *
 An account identifier.
 <p>
 This SHALL identify the account involved in this association.

.proto.AccountID account_id = 2;

Returns:: The accountId.

getBalance

long getBalance()

 *
 The fungible token balance of this token relationship.
 <p>
 This MUST be a whole number.

int64 balance = 3;

Returns:: The balance.

getFrozen

boolean getFrozen()

 *
 A flag indicating that this token relationship is frozen.
 <p>
 When a token relationship is frozen the associated account SHALL NOT be
 permitted to transfer to or from the associated balance.
 <p>
 This flag is associated with the Token value `freeze_key`, and any
 transaction to set this flag MUST be signed by that key. If the Token
 does not have a `freeze_key` set, then this flag SHALL NOT be set true
 for relationships between accounts and that token.

bool frozen = 4;

Returns:: The frozen.

getKycGranted

boolean getKycGranted()

 *
 A flag indicating that this token relationship has been granted KYC status.
 <p>
 If the token flag `accounts_kyc_granted_by_default` is set true, then
 this flag SHALL be set true for all accounts subsequently associated to
 that token. Otherwise this flag SHALL NOT be set until a transaction
 is submitted, and signed with the Token `kyc_key` to
 set the flag true.<br/>
 If the Token does not have a `kyc_key` set and the token flag
 `accounts_kyc_granted_by_default` is not set true, then this value MUST
 be false for all accounts subsequently associated to that token.
 <p>
 Typically a transaction to set this value to true is considered
 equivalent to asserting that the "Know Your Customer" (KYC) requirements
 have been met for this combination of account and token and the relevant
 records are available as required.

bool kyc_granted = 5;

Returns:: The kycGranted.

getAutomaticAssociation

boolean getAutomaticAssociation()

 *
 A flag indicating that this token relationship was created using
 automatic association.
 <p>
 If this is true then there MUST NOT exist a customer-signed transaction
 associating this account and token combination and the account
 `used_auto_associations` SHALL be incremented when this relationship
 is created.

bool automatic_association = 6;

Returns:: The automaticAssociation.

hasPreviousToken

boolean hasPreviousToken()

 *
 The Token ID of the previous entry in the associated Account's
 "virtual double-linked list" of token relationships.
 <p>
 This must be combined with the value of `account_id` to identify the
 actual `TokenRelation` referenced.

.proto.TokenID previous_token = 7;

Returns:: Whether the previousToken field is set.

getPreviousToken

TokenID getPreviousToken()

 *
 The Token ID of the previous entry in the associated Account's
 "virtual double-linked list" of token relationships.
 <p>
 This must be combined with the value of `account_id` to identify the
 actual `TokenRelation` referenced.

.proto.TokenID previous_token = 7;

Returns:: The previousToken.

hasNextToken

boolean hasNextToken()

 *
 The Token ID of the next entry in the associated Account's "virtual
 double-linked list" of token relationships.
 <p>
 This must be combined with the value of `account_id` to identify the
 actual `TokenRelation` referenced.

.proto.TokenID next_token = 8;

Returns:: Whether the nextToken field is set.

getNextToken

TokenID getNextToken()

 *
 The Token ID of the next entry in the associated Account's "virtual
 double-linked list" of token relationships.
 <p>
 This must be combined with the value of `account_id` to identify the
 actual `TokenRelation` referenced.