com.milestonesys.xpmobilesdk.communication

Class CommunicationItem

java.lang.Object

com.milestonesys.xpmobilesdk.communication.CommunicationItem

All Implemented Interfaces:

java.io.Serializable

public class CommunicationItem
extends java.lang.Object
implements java.io.Serializable

CommunicationItem class is used for the parsing of the items that are inside the tag from the Viking Protocol. For example you could see the GetAlarmDataSettings, GetAllViewsAndCameras, GetAccessRequestEvents commands from the Viking Protocol documentation.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CommunicationItem(java.lang.String _type, java.lang.String _name, java.lang.String _folder, java.util.UUID _id) Constructs new CommunicationItem object.

Method Summary

Modifier and Type	Method and Description
void	addItem(CommunicationItem _subItem) Adds new sub item to the current one.
void	addProperty(java.lang.String key, java.lang.String value) Adds new property of the item.
java.lang.String	getFolder()
java.util.UUID	getId()
java.util.List<CommunicationItem>	getItemsList()
java.lang.String	getName()
java.lang.String	getProperty(java.lang.String key) Returns specific property value by given key.
java.lang.String	getType()

Methods inherited from class java.lang.Object

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

Constructor Detail

CommunicationItem

public CommunicationItem(java.lang.String _type,
                         java.lang.String _name,
                         java.lang.String _folder,
                         java.util.UUID _id)

Constructs new CommunicationItem object.

Parameters:

_type - type of the item

_name - name of the item

_folder - folder of the item

_id - id of the item

Method Detail

getName

public java.lang.String getName()

Returns:

the name of the item.

getType

public java.lang.String getType()

Returns:

the type of the item.

getFolder

public java.lang.String getFolder()

Returns:

the folder of the item.

getId

public java.util.UUID getId()

Returns:

id of the item as UUID.

addProperty

public void addProperty(java.lang.String key,
                        java.lang.String value)

Adds new property of the item.

Parameters:

key - the key of the property.

value - the value of the property.

getProperty

public java.lang.String getProperty(java.lang.String key)

Returns specific property value by given key.

Parameters:

key - the key that will be used to get the current property value.

Returns:

the property value by given key.

addItem

public void addItem(CommunicationItem _subItem)

Adds new sub item to the current one.

Parameters:

_subItem - the sub item that will be added.

getItemsList

public java.util.List<CommunicationItem> getItemsList()

Returns:

all sub items of the current one.