com.hederahashgraph.api.proto.java.TokenRelationshipOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hedera-protobuf-java-api Show documentation
Hedera Protobuf Java API
There is a newer version: 0.57.1
Show newest version
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: basic_types.proto

package com.hederahashgraph.api.proto.java;

public interface TokenRelationshipOrBuilder extends
    // @@protoc_insertion_point(interface_extends:proto.TokenRelationship)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    **
   * The ID of the token
   * 
   *
   * .proto.TokenID tokenId = 1;
   * @return Whether the tokenId field is set.
   */
  boolean hasTokenId();
  /**
   *    **
   * The ID of the token
   * 
   *
   * .proto.TokenID tokenId = 1;
   * @return The tokenId.
   */
  com.hederahashgraph.api.proto.java.TokenID getTokenId();
  /**
   *    **
   * The ID of the token
   * 
   *
   * .proto.TokenID tokenId = 1;
   */
  com.hederahashgraph.api.proto.java.TokenIDOrBuilder getTokenIdOrBuilder();

  /**
   *    **
   * The Symbol of the token
   * 
   *
   * string symbol = 2;
   * @return The symbol.
   */
  java.lang.String getSymbol();
  /**
   *    **
   * The Symbol of the token
   * 
   *
   * string symbol = 2;
   * @return The bytes for symbol.
   */
  com.google.protobuf.ByteString
      getSymbolBytes();

  /**
   *    **
   * For token of type FUNGIBLE_COMMON - the balance that the Account holds in the smallest
   * denomination. For token of type NON_FUNGIBLE_UNIQUE - the number of NFTs held by the account
   * 
   *
   * uint64 balance = 3;
   * @return The balance.
   */
  long getBalance();

  /**
   *    **
   * The KYC status of the account (KycNotApplicable, Granted or Revoked). If the token does not
   * have KYC key, KycNotApplicable is returned
   * 
   *
   * .proto.TokenKycStatus kycStatus = 4;
   * @return The enum numeric value on the wire for kycStatus.
   */
  int getKycStatusValue();
  /**
   *    **
   * The KYC status of the account (KycNotApplicable, Granted or Revoked). If the token does not
   * have KYC key, KycNotApplicable is returned
   * 
   *
   * .proto.TokenKycStatus kycStatus = 4;
   * @return The kycStatus.
   */
  com.hederahashgraph.api.proto.java.TokenKycStatus getKycStatus();

  /**
   *    **
   * The Freeze status of the account (FreezeNotApplicable, Frozen or Unfrozen). If the token does
   * not have Freeze key, FreezeNotApplicable is returned
   * 
   *
   * .proto.TokenFreezeStatus freezeStatus = 5;
   * @return The enum numeric value on the wire for freezeStatus.
   */
  int getFreezeStatusValue();
  /**
   *    **
   * The Freeze status of the account (FreezeNotApplicable, Frozen or Unfrozen). If the token does
   * not have Freeze key, FreezeNotApplicable is returned
   * 
   *
   * .proto.TokenFreezeStatus freezeStatus = 5;
   * @return The freezeStatus.
   */
  com.hederahashgraph.api.proto.java.TokenFreezeStatus getFreezeStatus();

  /**
   *    **
   * Tokens divide into <tt>10<sup>decimals</sup></tt> pieces
   * 
   *
   * uint32 decimals = 6;
   * @return The decimals.
   */
  int getDecimals();

  /**
   *    **
   * Specifies if the relationship is created implicitly. False : explicitly associated, True :
   * implicitly associated.
   * 
   *
   * bool automatic_association = 7;
   * @return The automaticAssociation.
   */
  boolean getAutomaticAssociation();
}