Package com.highdeal.allowance.tool

Class AllowanceBlob

java.lang.Object
com.highdeal.allowance.tool.AllowanceBlob
public class AllowanceBlob extends Object

This Java class allows you to interpret the binary representation of an allowance in a provider contract and stored in the back-end database system. You implement this class to understand and view the content of the ALLO_DATA column of the ALLO table in SAP CC Core Database.

Consult the Core Database Reference for more information about customer master data stored in the SAP CC back-end database for each service provider. See the ALLO table.

  • Method Details

    • getVersion

      public short getVersion()
      Gets the version used to serialize the allowance blob in the back-end database system. The version number is a zero or positive number.
      Returns:
      The version used to serialize the allowance blob in the database

    • getAllowanceParentId

      public long getAllowanceParentId()
      Gets the unique identifier of the charge activation that created the allowance.
      Returns:
      The unique identifier of the charge activation that created the allowance

    • getAllowanceParentContractId

      public String getAllowanceParentContractId()
      Gets the identifier of the charging contract that created the allowance (Only available from the version 3).
      Returns:
      The identifier of the charging contract that created the allowance

    • getAllowanceShareId

      public String getAllowanceShareId()
      Gets the identifier of the share group of the allowance, or null if the allowance is not shared (Only available from the version 3).
      Returns:
      The identifier of the share group of the allowance, or null if the allowance is not shared

    • getChargingContractItemExternalId

      public String getChargingContractItemExternalId()
      Gets the external identifier of the charging contract item that creates this allowance.
      Returns:
      The external identifier of the charging contract item that creates this allowance

    • getAllowanceCurrencyCode

      public String getAllowanceCurrencyCode()
      Gets the currency code of the allowance.
      Returns:
      The code of the Currency defined in the allowance

    • getAllowanceAccountId

      public String getAllowanceAccountId()
      Gets the identifier of the account in the subscriber account that is assigned to the allowance.
      Returns:
      The identifier of the account that is assigned to the allowance

    • getAllowanceAccountType

      public AccountType getAllowanceAccountType()
      Gets the type of the account that is assigned to the allowance.
      Returns:
      The type of the account that is assigned to the allowance

    • getAllowanceParameterList

      public List<AllowanceBlob.AllowanceParameter> getAllowanceParameterList()
      Gets the list of the parameters defined the allowance.
      Returns:
      The list of the parameters of the allowance

    • create

      public static final AllowanceBlob create(String hexadecimalValue) throws IllegalArgumentException
      Creates an AllowanceBlob object from a hexadecimal string.

      The hexadecimal string must contain only digits or characters from 'A' to 'F', in lower case or upper case. It may start with the prefix '0x'.

      Parameters:
      hexadecimalValue - The hexadecimal string from which the allowance information must be extracted
      Returns:
      An AllowanceBlob object which contains the data extracted from the specified hexadecimal string
      Throws:
      IllegalArgumentException - if the specified hexadecimal string is invalid

    • create

      public static final AllowanceBlob create(byte[] allowanceBlob) throws IllegalArgumentException
      Creates an AllowanceBlob object from a byte array.
      Parameters:
      allowanceBlob - The byte array from which the allowance information must be extracted
      Returns:
      An AllowanceBlob object which contains the data extracted from the specified byte array
      Throws:
      IllegalArgumentException - if the specified byte array is invalid