LifeCARDObjectHandler (SEHR Core)

java.lang.Object
- org.ifeth.sehr.core.handler.LifeCARDObjectHandler

```
public class LifeCARDObjectHandler
extends java.lang.Object
```
The core object handler of a LifeCARD.
There are some methods like to check the card ID, get some values, to store and retrieve the LifeCARDObject by XML files.

Constructor Summary

Constructors
Constructor and Description
`LifeCARDObjectHandler(SEHRConfigurationObject sco)` Default constructor.
`LifeCARDObjectHandler(SEHRConfigurationObject sco, LifeCardItem lifeCardItem)` Constructor to work with given item object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static LifeCardItem`	`buildLifeCardItemFromLcMain(org.ifeth.sehr.intrasec.entities.LcMain lcMain, javax.persistence.EntityManager em, boolean isJTA)` Builds a LifeCardItem object from a given entity without a physical card assignment.
`static java.lang.String`	`buildNumber(LifeCardItem lc, java.lang.String cc, java.lang.Integer zid, java.lang.Integer cid, java.lang.Integer patid)` Build the card number and store it to the given card item.
`static void`	`CardItemToJSONFile(LifeCardItem lc, java.io.File outFile)` Write out the LifeCARD item object to a JSON formatted file.
`static boolean`	`checkCountryCode(LifeCardItem lifeCardItem)`
`static boolean`	`checkCountryCode(java.lang.String lcnumber)`
`static java.io.File[]`	`createLifeCARDImage(java.io.File fCardTemplate, LifeCardItem item, java.io.File fOut)` Creates a preview of the LifeCARD(R) as well as the overlay text for printing purposes.
`java.lang.Integer`	`getCenterID()`
`java.lang.String`	`getCountry()`
`java.lang.String`	`getHandlerLifeCardVersion()`
`LifeCardItem`	`getItem()` Get the item (card data object) we are currently processing.
`java.lang.Integer`	`getPatientID()`
`java.lang.Integer`	`getZoneID()`
`static boolean`	`isSyntaxC778(java.lang.String lcid)`
`static LifeCardItem`	`JSONFileToCardItem(java.io.File inFile)` Get LifeCARD item object from a JSON file.
`static java.util.Map<java.lang.Short,java.lang.String>`	`listIdentConstants()` List of identity papers for selection purposes.
`static java.util.Map<java.lang.Short,java.lang.String>`	`listStsConstants()` List of LcMain status values for selection purposes.
`static void`	`ObjectToXML(LifeCardItem lc, java.io.File xmlOutFile)`
`LifeCardItem`	`searchDirContext(SEHRDirectoryContext ctx, java.lang.String lcnr)` Search for entry at the given SEHRContext.
`void`	`setLifeCardItem(LifeCardItem lifeCardItem)` Set the item to work with.
`short`	`storeObject2DirContext(SEHRDirectoryContext ctx)` Store the LifeCARD reference object to the given SEHR provider context.
`static boolean`	`verifySerialCard(java.lang.String usbSerial, org.ifeth.sehr.intrasec.entities.LcCad lcCad)` Verify the serial of the card against the issued data set (LcCad).
`static LifeCardItem`	`XMLToObject(java.io.File xmlInFile)`

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

- Constructor Detail
  - LifeCARDObjectHandler
```
public LifeCARDObjectHandler(SEHRConfigurationObject sco)
```
    Default constructor.
    The SEHRConfigurationObject contains the current zone settings. Important parameters (values) are
    - Zone ID
    - Access to the SEHR LDAP service
    - The secrets to access OpenLDAP or AMQ hosts
    Parameters:
    
    sco -
  - LifeCARDObjectHandler
```
public LifeCARDObjectHandler(SEHRConfigurationObject sco,
                             LifeCardItem lifeCardItem)
```
    Constructor to work with given item object.
    
    Parameters:
    
    sco -
    
    lifeCardItem -
    
    See Also:
    
    LifeCARDObjectHandler(SEHRConfigurationObject sco)
- Method Detail
  - getItem
```
public LifeCardItem getItem()
```
    Get the item (card data object) we are currently processing.
    The item contains all printable and some not printable attributes.
    
    Returns:
    
    the lifeCardItem
  - setLifeCardItem
```
public void setLifeCardItem(LifeCardItem lifeCardItem)
```
    Set the item to work with.
    
    Parameters:
    
    lifeCardItem - The LifeCardItem to set
  - getHandlerLifeCardVersion
```
public java.lang.String getHandlerLifeCardVersion()
```
  - getZoneID
```
public java.lang.Integer getZoneID()
```
  - getCountry
```
public java.lang.String getCountry()
```
  - getCenterID
```
public java.lang.Integer getCenterID()
```
  - getPatientID
```
public java.lang.Integer getPatientID()
```
  - buildNumber
```
public static java.lang.String buildNumber(LifeCardItem lc,
                                           java.lang.String cc,
                                           java.lang.Integer zid,
                                           java.lang.Integer cid,
                                           java.lang.Integer patid)
                                    throws GenericSEHRException
```
    Build the card number and store it to the given card item.
    The card item does only contain the printed data on the card to reprint or to redistribute it. The item is part of the LcMain record to store the relation to the user (on the zone host) and usage status.
    
    Parameters:
    
    lc - The card item object (to place the number)
    
    cc - The country code (2-chars, e.g. DE)
    
    zid - The zone id
    
    cid - The center id
    
    patid - The patient id at the center, at the local EHR system
    
    Returns:
    
    Throws:
    
    GenericSEHRException
  - buildLifeCardItemFromLcMain
```
public static LifeCardItem buildLifeCardItemFromLcMain(org.ifeth.sehr.intrasec.entities.LcMain lcMain,
                                                       javax.persistence.EntityManager em,
                                                       boolean isJTA)
```
    Builds a LifeCardItem object from a given entity without a physical card assignment.
    If an JPA instance is given ('em' parameter), the DB record of the entity will be updated to store the generated item.
    
    Parameters:
    
    lcMain - The DB record from which the item will be generated
    
    em - EntityManager (JPA of type RESOURCE_LOCAL or JTA) or 'null'
    
    isJTA - set to 'true' if used inside a container like GF.
    
    Returns:
  - XMLToObject
```
public static LifeCardItem XMLToObject(java.io.File xmlInFile)
                                throws GenericSEHRException
```
    Throws:
    
    GenericSEHRException
  - ObjectToXML
```
public static void ObjectToXML(LifeCardItem lc,
                               java.io.File xmlOutFile)
                        throws GenericSEHRException
```
    Throws:
    
    GenericSEHRException
  - isSyntaxC778
```
public static boolean isSyntaxC778(java.lang.String lcid)
```
  - checkCountryCode
```
public static boolean checkCountryCode(LifeCardItem lifeCardItem)
```
  - checkCountryCode
```
public static boolean checkCountryCode(java.lang.String lcnumber)
```
  - storeObject2DirContext
```
public short storeObject2DirContext(SEHRDirectoryContext ctx)
```
    Store the LifeCARD reference object to the given SEHR provider context.
    By default an LDAP context of a local, regional or global acting SEHR provider should be used. The IFETH context can be used if the patient wants a global usage by the non-profit organization IFETH.
    .
    
    Parameters:
    
    ctx -
    
    Returns:
    
    Status of the process (short value)
  - searchDirContext
```
public LifeCardItem searchDirContext(SEHRDirectoryContext ctx,
                                     java.lang.String lcnr)
```
    Search for entry at the given SEHRContext.
    Because SEHR is openSource there may be other and private networks. By decision of the project committee the IFETH institute runs a global service. So the directory service to search in depends on the configuration.
    
    Parameters:
    
    ctx - - SEHRDirectoryContext (interface)
    
    lcnr -
    
    Returns:
  - CardItemToJSONFile
```
public static void CardItemToJSONFile(LifeCardItem lc,
                                      java.io.File outFile)
                               throws GenericSEHRException
```
    Write out the LifeCARD item object to a JSON formatted file.
    Use this method to create a file on a card for identification (personalization).
    
    By SEHR convention there are two files on each card. The first one contains the same data printed on the card (.lifecard file) and the second file contains the LcCad entity (.serial) of the production to veriy the card against the chipset to identify recurrent abuse / misusage or just to verify the card againt the holder/context.
    
    Parameters:
    
    lc -
    
    outFile -
    
    Throws:
    
    GenericSEHRException
  - JSONFileToCardItem
```
public static LifeCardItem JSONFileToCardItem(java.io.File inFile)
                                       throws GenericSEHRException
```
    Get LifeCARD item object from a JSON file.
    Use this method to get the item of personalization/registration.
    
    By SEHR convention there are two files on each card. The first one contains the same data printed on the card (.lifecard file) and the second file contains the LcCad entity (.serial) of the production to veriy the card against the chipset to identify recurrent abuse / misusage or just to verify the card againt the holder/context.
    
    Parameters:
    
    inFile -
    
    Returns:
    
    LifeCardItem
    
    Throws:
    
    GenericSEHRException
  - verifySerialCard
```
public static boolean verifySerialCard(java.lang.String usbSerial,
                                       org.ifeth.sehr.intrasec.entities.LcCad lcCad)
```
    Verify the serial of the card against the issued data set (LcCad).
    To keep the integrity of a card reliable each card has to be registered. For such a registration a provider (issuer) of LifeCARDs is assigned to a SEHR zone using either the management tools of the zone (e.g. sehr-cas) or a self written application to manage the card serials, the patients and the personalization.
    
    Each application accessing cards should be able to verify a card using a library, e.g. usb4java based on libusb 1.0. The supported plattforms for usb4java are Supported platforms are Linux (x86 32/64 bit, ARM 32 bit), OS X (x86 32/64 bit) and Windows (x86 32/64 bit).
    
    Parameters:
    
    usbSerial -
    
    lcCad -
    
    Returns:
  - createLifeCARDImage
```
public static java.io.File[] createLifeCARDImage(java.io.File fCardTemplate,
                                                 LifeCardItem item,
                                                 java.io.File fOut)
                                          throws java.io.IOException
```
    Creates a preview of the LifeCARD(R) as well as the overlay text for printing purposes.
    
    Parameters:
    
    fCardTemplate - base path of the card template
    
    item -
    
    fOut - if 'null' file is stored at '/[temp dir]/lc-[number].png'
    
    Returns:
    
    File[] containing the preview and overlay printing of the card
    
    Throws:
    
    java.io.IOException
  - listIdentConstants
```
public static final java.util.Map<java.lang.Short,java.lang.String> listIdentConstants()
```
    List of identity papers for selection purposes.
    
    Returns:
  - listStsConstants
```
public static final java.util.Map<java.lang.Short,java.lang.String> listStsConstants()
```
    List of LcMain status values for selection purposes.
    
    Returns:

Class LifeCARDObjectHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

LifeCARDObjectHandler

LifeCARDObjectHandler

Method Detail

getItem

setLifeCardItem

getHandlerLifeCardVersion

getZoneID

getCountry

getCenterID

getPatientID

buildNumber

buildLifeCardItemFromLcMain

XMLToObject

ObjectToXML

isSyntaxC778

checkCountryCode

checkCountryCode

storeObject2DirContext

searchDirContext

CardItemToJSONFile

JSONFileToCardItem

verifySerialCard

createLifeCARDImage

listIdentConstants

listStsConstants