Package org.calypsonet.terminal.calypso.card

Interface FileHeader

  • public interface FileHeader
    Calypso EF metadata.
    Since:
    1.0.0

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      byte[] getAccessConditions()
      Gets a reference to the access conditions.
      java.lang.Byte getDfStatus()
      Gets the DF status.
      ElementaryFile.Type getEfType()
      Gets the Elementary File type.
      byte[] getKeyIndexes()
      Gets a reference to the keys indexes.
      short getLid()
      Gets the associated LID.
      int getRecordSize()
      Gets the size of a record : For a Counter file, the record size is the original size of the record #1.
      Extra bytes (rest of the division of the file size by 3) aren't accessible.
      int getRecordsNumber()
      Gets the number of records : For a Counter file, the number of records is always 1.
      Extra bytes (rest of the division of the file size by 3) aren't accessible.
      java.lang.Short getSharedReference()
      Gets the non-zero unique identifier of the shared data when the file data is shared.

    • Method Detail

      • getLid

        short getLid()
        Gets the associated LID.
        Returns:
        The LID.
        Since:
        1.0.0

      • getDfStatus

        java.lang.Byte getDfStatus()
        Gets the DF status.
        Returns:
        Null if the status is not available (e.g. when the FileHeader is created following the response to a "Get Data" command with the GetDataTag.EF_LIST tag).
        Since:
        1.0.0

      • getEfType

        ElementaryFile.Type getEfType()
        Gets the Elementary File type.
        Returns:
        A not null file type.
        Since:
        1.0.0

      • getRecordsNumber

        int getRecordsNumber()
        Gets the number of records :
        • For a Counter file, the number of records is always 1.
          Extra bytes (rest of the division of the file size by 3) aren't accessible.
        • For a Binary file, the number of records is always 1.
        Returns:
        The number of records.
        Since:
        1.0.0

      • getRecordSize

        int getRecordSize()
        Gets the size of a record :
        • For a Counter file, the record size is the original size of the record #1.
          Extra bytes (rest of the division of the file size by 3) aren't accessible.
        • For a Binary file, the size of the record is corresponding to the file size.
        Returns:
        The size of a record.
        Since:
        1.0.0

      • getAccessConditions

        byte[] getAccessConditions()
        Gets a reference to the access conditions.
        Returns:
        An empty array if the access conditions are not available (e.g. when the FileHeader is created following the response to a "Get Data" command with the GetDataTag.EF_LIST tag).
        Since:
        1.0.0

      • getKeyIndexes

        byte[] getKeyIndexes()
        Gets a reference to the keys indexes.
        Returns:
        An empty array if the key indexes are not available (e.g. when the FileHeader is created following the response to a "Get Data" command with the GetDataTag.EF_LIST tag).
        Since:
        1.0.0

      • getSharedReference

        java.lang.Short getSharedReference()
        Gets the non-zero unique identifier of the shared data when the file data is shared.
        Returns:
        Zero if the file data is not shared or null if the information is not available (e.g. when the FileHeader is created following the response to a "Get Data" command with the GetDataTag.EF_LIST tag).
        Since:
        1.0.0