FileViewProvider.FCP

java.lang.Object
- org.simalliance.openmobileapi.FileViewProvider.FCP

Enclosing class:

FileViewProvider
```
public class FileViewProvider.FCP
extends java.lang.Object
```
File Control Parameter contain information of a selected file. FCPs are returned after a file select operation.
Note: This class is based on ISO/IEC 7816-4 FCP returned by the SELECT command as specified in ISO/IEC 7816-4 in chapter 5.3.3 (File control information) in table 12 (File control parameter data objects).

Field Summary

Fields
Modifier and Type	Field and Description
`static byte`	`FCPTAG_FCP_TEMPLATE` FCP template TLV tag.
`static byte`	`FCPTAG_FILE_DESCRIPTOR` FCP file descriptor TLV tag.
`static byte`	`FCPTAG_FILE_ID` FCP file ID TLV tag.
`static byte`	`FCPTAG_FILE_SIZE` FCP file size TLV tag.
`static byte`	`FCPTAG_LCS` FCP Life Cycle Status TLV tag.
`static byte`	`FCPTAG_SFI` FCP ShortFileIdentifier TLV tag.
`static byte`	`FCPTAG_TOTAL_FILE_SIZE` FCP total file size TLV tag.
`static int`	`FILESTRUCTURE_CYCLIC` EF structure: Cyclic structure, fixed size.
`static int`	`FILESTRUCTURE_LINEAR_FIXED` EF structure: Linear structure, fixed size.
`static int`	`FILESTRUCTURE_LINEAR_VARIABLE` EF structure: Linear structure, variable size.
`static int`	`FILESTRUCTURE_NO_EF` EF structure: No information given.
`static int`	`FILESTRUCTURE_TRANSPARENT` EF structure: Transparent structure.
`static byte`	`FILETYPE_DF` File type = DF.
`static byte`	`FILETYPE_EF` File type = EF.
`static int`	`LCS_CREATION_STATE` Life Cycle Status: Creation state.
`static int`	`LCS_INITIALISATION_STATE` Life Cycle Status: Initialization state.
`static int`	`LCS_NO_INFORMATION_GIVEN` Life Cycle Status: No information given.
`static int`	`LCS_OPERATIONAL_STATE_ACTIVATED` Life Cycle Status: Operational state (activated).
`static int`	`LCS_OPERATIONAL_STATE_DEACTIVATED` Life Cycle Status: Operational state (deactivated).
`static int`	`LCS_TERMINATION_STATE` Life Cycle Status: Termination state.

Constructor Summary

Constructors
Constructor and Description

FileViewProvider.FCP(byte[] rawTlvData)
Initializes a new instance of the FCP class.

Constructors
Constructor and Description
`FileViewProvider.FCP(byte[] rawTlvData)` Initializes a new instance of the FCP class.

Method Summary

Methods
Modifier and Type	Method and Description
`byte[]`	`getFCP()` Returns the complete FCP as byte array.
`int`	`getFID()` Returns the file identifier of the selected file.
`int`	`getFileSize()` Returns the file size of the selected file (Number of data bytes in the file, excluding structural information).
`int`	`getFileStructure()` Returns the structure type of the selected EF.
`int`	`getFileType()` Returns the file type of the currently selected file.
`int`	`getLCS()` Returns the life cycle state of the currently selected file.
`int`	`getMaxRecordSize()` Returns the maximum record size in case of a record based EF.
`int`	`getNumberOfRecords()` Returns the number of records stored in the EF in case of a record based EF.
`int`	`getSFI()` Returns the short file identifier of the selected EF file.
`int`	`getTotalFileSize()` Returns the total file size of the selected file (Number of data bytes in the file, including structural information if any).

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FCPTAG_FCP_TEMPLATE
```
public static final byte FCPTAG_FCP_TEMPLATE
```
    FCP template TLV tag.
    
    See Also:
    Constant Field Values
  - FCPTAG_FILE_SIZE
```
public static final byte FCPTAG_FILE_SIZE
```
    FCP file size TLV tag.
    
    See Also:
    Constant Field Values
  - FCPTAG_TOTAL_FILE_SIZE
```
public static final byte FCPTAG_TOTAL_FILE_SIZE
```
    FCP total file size TLV tag.
    
    See Also:
    Constant Field Values
  - FCPTAG_FILE_DESCRIPTOR
```
public static final byte FCPTAG_FILE_DESCRIPTOR
```
    FCP file descriptor TLV tag.
    
    See Also:
    Constant Field Values
  - FCPTAG_FILE_ID
```
public static final byte FCPTAG_FILE_ID
```
    FCP file ID TLV tag.
    
    See Also:
    Constant Field Values
  - FCPTAG_SFI
```
public static final byte FCPTAG_SFI
```
    FCP ShortFileIdentifier TLV tag.
    
    See Also:
    Constant Field Values
  - FCPTAG_LCS
```
public static final byte FCPTAG_LCS
```
    FCP Life Cycle Status TLV tag.
    
    See Also:
    Constant Field Values
  - FILETYPE_DF
```
public static final byte FILETYPE_DF
```
    File type = DF.
    
    See Also:
    Constant Field Values
  - FILETYPE_EF
```
public static final byte FILETYPE_EF
```
    File type = EF.
    
    See Also:
    Constant Field Values
  - FILESTRUCTURE_NO_EF
```
public static final int FILESTRUCTURE_NO_EF
```
    EF structure: No information given.
    
    See Also:
    Constant Field Values
  - FILESTRUCTURE_TRANSPARENT
```
public static final int FILESTRUCTURE_TRANSPARENT
```
    EF structure: Transparent structure.
    
    See Also:
    Constant Field Values
  - FILESTRUCTURE_LINEAR_FIXED
```
public static final int FILESTRUCTURE_LINEAR_FIXED
```
    EF structure: Linear structure, fixed size.
    
    See Also:
    Constant Field Values
  - FILESTRUCTURE_LINEAR_VARIABLE
```
public static final int FILESTRUCTURE_LINEAR_VARIABLE
```
    EF structure: Linear structure, variable size.
    
    See Also:
    Constant Field Values
  - FILESTRUCTURE_CYCLIC
```
public static final int FILESTRUCTURE_CYCLIC
```
    EF structure: Cyclic structure, fixed size.
    
    See Also:
    Constant Field Values
  - LCS_NO_INFORMATION_GIVEN
```
public static final int LCS_NO_INFORMATION_GIVEN
```
    Life Cycle Status: No information given.
    
    See Also:
    Constant Field Values
  - LCS_CREATION_STATE
```
public static final int LCS_CREATION_STATE
```
    Life Cycle Status: Creation state.
    
    See Also:
    Constant Field Values
  - LCS_INITIALISATION_STATE
```
public static final int LCS_INITIALISATION_STATE
```
    Life Cycle Status: Initialization state.
    
    See Also:
    Constant Field Values
  - LCS_OPERATIONAL_STATE_ACTIVATED
```
public static final int LCS_OPERATIONAL_STATE_ACTIVATED
```
    Life Cycle Status: Operational state (activated).
    
    See Also:
    Constant Field Values
  - LCS_OPERATIONAL_STATE_DEACTIVATED
```
public static final int LCS_OPERATIONAL_STATE_DEACTIVATED
```
    Life Cycle Status: Operational state (deactivated).
    
    See Also:
    Constant Field Values
  - LCS_TERMINATION_STATE
```
public static final int LCS_TERMINATION_STATE
```
    Life Cycle Status: Termination state.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - FileViewProvider.FCP
```
public FileViewProvider.FCP(byte[] rawTlvData)
                     throws java.lang.IllegalArgumentException
```
    Initializes a new instance of the FCP class.
    
    Parameters:
    rawTlvData - The data to be used in the initialization.
    
    Throws:
    
    java.lang.IllegalArgumentException - if the specified rawTlvData does not contain valid FCP data.
- Method Detail
  - getFCP
```
public byte[] getFCP()
```
    Returns the complete FCP as byte array.
    Note: This method is based on the FCP control parameter as specified in ISO/IEC 7816-4 in chapter 5.3.3 (File control information) in table 12 (File control parameter data objects).
    
    Returns:
    The complete FCP as byte array.
  - getFileSize
```
public int getFileSize()
```
    Returns the file size of the selected file (Number of data bytes in the file, excluding structural information).
    Note: This method is based on the FCP control parameter as specified in ISO/IEC 7816-4 in chapter 5.3.3 (File control information) in table 12 (File control parameter data objects).
    Returns:
    The file size depending on the file type:
    
    DF/MF: the total file size represents the sum of the file sizes of all the EFs and DFs contained in this DF plus the amount of available memory in this DF. The size of the structural information of the selected DF itself is not included.
    
    EF: the total file size represents the allocated memory for the content and the structural information (if any) of this EF.
    
    INFO_NOT_AVAILABLE if the information is not available.
  - getTotalFileSize
```
public int getTotalFileSize()
```
    Returns the total file size of the selected file (Number of data bytes in the file, including structural information if any).
    Note: This method is based on the FCP control parameter as specified in ISO/IEC 7816-4 in chapter 5.3.3 (File control information) in table 12 (File control parameter data objects).
    Returns:
    The total file size depending on the file type:
    
    DF/MF: the total file size represents the sum of the file sizes of all the EFs and DFs contained in this DF plus the amount of available memory in this DF. The size of the structural information of the selected DF itself is not included.
    
    EF: the total file size represents the allocated memory for the content and the structural information (if any) of this EF.
    
    INFO_NOT_AVAILABLE if the information is not available.
  - getFID
```
public int getFID()
```
    Returns the file identifier of the selected file.
    Note: This method is based on the FCP control parameter as specified in ISO/IEC 7816-4 in chapter 5.3.3 (File control information) in table 12 (File control parameter data objects).
    
    Returns:
    The file identifier of the selected file. INFO_NOT_AVAILABLE if the FID of the selected file is not available.
  - getSFI
```
public int getSFI()
```
    Returns the short file identifier of the selected EF file.
    Note: This method is based on the FCP control parameter as specified in ISO/IEC 7816-4 in chapter 5.3.3 (File control information) in table 12 (File control parameter data objects).
    
    Returns:
    The short file identifier of the selected file. INFO_NOT_AVAILABLE if selected file is not an EF or an SFI is not available.
  - getMaxRecordSize
```
public int getMaxRecordSize()
```
    Returns the maximum record size in case of a record based EF.
    Note: This method is based on the FCP control parameter as specified in ISO/IEC 7816-4 in chapter 5.3.3 (File control information) in table 12 (File control parameter data objects).
    
    Returns:
    The maximum record size in case of a record based EF. INFO_NOT_AVAILABLE if the currently selected file is not record based or the information can not be fetched.
  - getNumberOfRecords
```
public int getNumberOfRecords()
```
    Returns the number of records stored in the EF in case of a record based EF.
    Note: This method is based on the FCP control parameter as specified in ISO/IEC 7816-4 in chapter 5.3.3 (File control information) in table 12 (File control parameter data objects).
    
    Returns:
    The number of records stored in the EF in case of a record based EF. INFO_NOT_AVAILABLE if the currently selected file is not record based or the information can not be fetched.
  - getFileType
```
public int getFileType()
```
    Returns the file type of the currently selected file.
    Note: This method is based on the FCP control parameter as specified in ISO/IEC 7816-4 in chapter 5.3.3 (File control information) in table 12 (File control parameter data objects). The file type is based on the definition in table 14 (File descriptor byte).
    Returns:
    The file type:
    
    (0) DF
    
    (1) EF
    
    INFO_NOT_AVAILABLE if the information can not be fetched.
  - getFileStructure
```
public int getFileStructure()
```
    Returns the structure type of the selected EF.
    Note: This method is based on the FCP control parameter as specified in ISO/IEC 7816-4 in chapter 5.3.3 (File control information) in table 12 (File control parameter data objects). The file type is based on the definition in table 14 (File descriptor byte).
    Returns:
    The structure type of the selected file:
    
    (0) NO_EF
    
    (1) TRANSPARENT
    
    (2) LINEAR_FIXED
    
    (3) LINEAR_VARIABLE
    
    (4) CYCLIC
    
    INFO_NOT_AVAILABLE if the information can not be fetched.
  - getLCS
```
public int getLCS()
```
    Returns the life cycle state of the currently selected file.
    Note: This method is based on the FCP control parameter as specified in ISO/IEC 7816-4 in chapter 5.3.3 (File control information) in table 12 (File control parameter data objects). The LCS is based on the definition in table 13 (Life cycle status byte).
    Returns:
    Returns the life cycle state of the currently selected file.
    
    (0) NO_INFORMATION_GIVEN
    
    (1) CREATION_STATE
    
    (2) INITIALISATION_STATE
    
    (3) OPERATIONAL_STATE_ACTIVATED
    
    (4) OPERATIONAL_STATE_DEACTIVATED
    
    (5) TERMINATION_STATE
    
    INFO_NOT_AVAILABLE if the information can not be fetched.

Class FileViewProvider.FCP

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FCPTAG_FCP_TEMPLATE

FCPTAG_FILE_SIZE

FCPTAG_TOTAL_FILE_SIZE

FCPTAG_FILE_DESCRIPTOR

FCPTAG_FILE_ID

FCPTAG_SFI

FCPTAG_LCS

FILETYPE_DF

FILETYPE_EF

FILESTRUCTURE_NO_EF

FILESTRUCTURE_TRANSPARENT

FILESTRUCTURE_LINEAR_FIXED

FILESTRUCTURE_LINEAR_VARIABLE

FILESTRUCTURE_CYCLIC

LCS_NO_INFORMATION_GIVEN

LCS_CREATION_STATE

LCS_INITIALISATION_STATE

LCS_OPERATIONAL_STATE_ACTIVATED

LCS_OPERATIONAL_STATE_DEACTIVATED

LCS_TERMINATION_STATE

Constructor Detail

FileViewProvider.FCP

Method Detail

getFCP

getFileSize

getTotalFileSize

getFID

getSFI

getMaxRecordSize

getNumberOfRecords

getFileType

getFileStructure

getLCS