com.spacecode.sdk.device.data

Class Inventory

java.lang.Object

com.spacecode.sdk.device.data.Inventory

public final class Inventory
extends java.lang.Object

Describe an inventory created after a scan operation. An inventory, when created, is always compared to the previous one, in order to define:

• Tags just added
• Tags already present
• Tags just removed

Inventory also have an initiating user and an access type (or none of both, if manually started).

Constructor Summary

Constructors

Constructor and Description
Inventory() Default constructor.
Inventory(int id, java.util.List<java.lang.String> tagsAdded, java.util.List<java.lang.String> tagsPresent, java.util.List<java.lang.String> tagsRemoved, java.lang.String initiatingUser, AccessType accessType, byte doorNumber, java.util.Date createdAt) Deprecated. Internal usage - Should not be used.
Inventory(Inventory copyInventory) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static Inventory	deserialize(java.lang.String serializedInventory) Create a new Inventory instance from a serialized one.
static Inventory	generateLastInventory(Inventory previousInventory, java.util.List<java.lang.String> tagsList) Create a new Inventory with the previous inventory Instance and a list of tag UIDs (generated during the last scan).
AccessType	getAccessType()
java.util.Date	getCreationDate()
byte	getDoorNumber() Get the number of the door which was closed before the inventory started
int	getId() Deprecated. Internal usage - Should not be used.
int	getNumberAdded() Quick way to get number of tags added, instead of getting a copied list to check its size().
int	getNumberPresent() Quick way to get number of tags present, instead of getting a copied list to check its size().
int	getNumberRemoved() Quick way to get number of tags removed, instead of getting a copied list to check its size().
int	getNumberTotal() Quick way to get number of tags total, instead of getting a copied list to check its size().
java.util.List<java.lang.String>	getTagsAdded()
java.util.List<java.lang.String>	getTagsAll()
java.util.List<java.lang.String>	getTagsPresent()
java.util.List<java.lang.String>	getTagsRemoved()
java.lang.String	getUsername()
java.lang.String	serialize() Serialize the current instance as XML and encode it with base64.
void	setAccessType(AccessType accessType) Save the last type of access (fingerprint, badge reader...) if the last scan was not manually started.
void	setDoorNumber(byte doorNumber) Set the number of the door which was closed before the inventory started
void	setInitiatingUserName(java.lang.String userName) Save the last granted user's name (user who opened one device door).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Inventory

public Inventory(Inventory copyInventory)

Copy constructor. Used for comparison purpose in the last inventory.

Parameters:

copyInventory - "current inventory" to be copied.

Inventory

public Inventory()

Default constructor. Initialize an empty Inventory

Inventory

@Deprecated
public Inventory(int id,
                    java.util.List<java.lang.String> tagsAdded,
                    java.util.List<java.lang.String> tagsPresent,
                    java.util.List<java.lang.String> tagsRemoved,
                    java.lang.String initiatingUser,
                    AccessType accessType,
                    byte doorNumber,
                    java.util.Date createdAt)

Deprecated. Internal usage - Should not be used.

Parameters:

tagsAdded - List of UID's for tags "added".

tagsPresent - List of UID's for tags "present".

tagsRemoved - List of UID's for tags "removed".

initiatingUser - Initiating user's name (empty if none [manual scan]).

accessType - Access type used by initiating user (if any). Value of AccessType enum.

createdAt - Creation date of the inventory.

Method Detail

getId

@Deprecated
public int getId()

Deprecated. Internal usage - Should not be used.

Returns:

Unique identifier of the Inventory.

getTagsAll

public java.util.List<java.lang.String> getTagsAll()

Returns:

A copy of "all tags" list. Used by client to display tags UID and count them.

getTagsPresent

public java.util.List<java.lang.String> getTagsPresent()

Returns:

A copy of "present tags" list. Used by client to display tags UID and count them.

getTagsAdded

public java.util.List<java.lang.String> getTagsAdded()

Returns:

A copy of "added tags" list. Used by client to display tags UID and count them.

getTagsRemoved

public java.util.List<java.lang.String> getTagsRemoved()

Returns:

A copy of "removed tags" list. Used by client to display tags UID and count them.

getCreationDate

public java.util.Date getCreationDate()

Returns:

(a deep copy of) Creation date of current Inventory instance

generateLastInventory

public static Inventory generateLastInventory(Inventory previousInventory,
                              java.util.List<java.lang.String> tagsList)

Create a new Inventory with the previous inventory Instance and a list of tag UIDs (generated during the last scan).

Parameters:

previousInventory - Device previous inventory (which was the "last inventory" before a new scan completed).

tagsList - List of tags UID scanned during this last scan operation.

Returns:

a new instance of Inventory, based on previousInventory comparison, using tagsList.

getNumberTotal

public int getNumberTotal()

Quick way to get number of tags total, instead of getting a copied list to check its size().

Returns:

size of tagsAll list.

getNumberAdded

public int getNumberAdded()

Quick way to get number of tags added, instead of getting a copied list to check its size().

Returns:

size of tagsAdded list.

getNumberRemoved

public int getNumberRemoved()

Quick way to get number of tags removed, instead of getting a copied list to check its size().

Returns:

size of tagsRemoved list.

getNumberPresent

public int getNumberPresent()

Quick way to get number of tags present, instead of getting a copied list to check its size().

Returns:

size of tagsPresent list.

setInitiatingUserName

public void setInitiatingUserName(java.lang.String userName)

Save the last granted user's name (user who opened one device door). Only used when the scan (and this inventory) was started by a door locking.

Parameters:

userName - Granted user's name.

getUsername

public java.lang.String getUsername()

Returns:

Username of the user considered as responsible for the scan. Or empty string if manual scan.

getAccessType

public AccessType getAccessType()

Returns:

AccessType enum value. "UNDEFINED" by default is the last scan was manual.

setAccessType

public void setAccessType(AccessType accessType)

Save the last type of access (fingerprint, badge reader...) if the last scan was not manually started.

Parameters:

accessType - Value of AccessType enum.

getDoorNumber

public byte getDoorNumber()

Get the number of the door which was closed before the inventory started

Returns:

Number of the door (0 for Master door, 1 for Slave door, -1 by default).

setDoorNumber

public void setDoorNumber(byte doorNumber)

Set the number of the door which was closed before the inventory started

Parameters:

doorNumber - Number of the door.

serialize

public java.lang.String serialize()

Serialize the current instance as XML and encode it with base64.

Returns:

The base64 encoded XML Inventory (or an empty string if any error occurred).

deserialize

public static Inventory deserialize(java.lang.String serializedInventory)

Create a new Inventory instance from a serialized one.

Parameters:

serializedInventory - Serialized Inventory.

Returns:

Inventory instance. Or null if the serialized data is invalid.