com.wialon.item

Class Item

java.lang.Object

com.wialon.core.EventProvider

com.wialon.item.Item

Direct Known Subclasses:

ItemIcon, Resource, User

public abstract class Item
extends EventProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Item.accessFlag ACL flags constants
static class	Item.dataFlag Data flags constants
static class	Item.events Events
static class	Item.ItemType
static class	Item.logMessageAction Log message action constants
static class	Item.measureUnitsFlag Measure units flags constants
static class	Item.measureUnitsType Measure units types constants
static interface	Item.UpdateItemProperty

Field Summary

Fields

Modifier and Type	Field and Description
protected Item.ItemType	itemType

Constructor Summary

Constructors

Constructor and Description
Item()

Method Summary

Methods

Modifier and Type	Method and Description
void	addLogRecord(java.lang.String action, java.lang.String newValue, java.lang.String oldValue, ResponseHandler callback) Add item log record
void	fireItemPropertyEvent(java.lang.Enum event, java.lang.Object oldData, java.lang.Object newData)
java.lang.Long	getAccountId() This item billing account ID
ItemProperties	getAdminFieldsPlugin()
java.lang.Long	getCreatorId() This item user-creator ID
ItemProperties	getCustomFieldsPlugin()
java.lang.String	getCustomProperty(java.lang.String propName, java.lang.String defaultVal) Get custom property
java.lang.Long	getDataFlags() Current item data flags, e.g.
java.lang.Long	getId() Get item id
Item.ItemType	getItemType() Get item type
java.lang.Integer	getMeasureUnits() Get item measure units
java.lang.String	getName() Get item name
protected ResponseHandler	getOnUpdatePropertiesCallback(ResponseHandler callback)
java.lang.Long	getUserAccess() Current user access level to this item
void	handleMessage(Message message) Handle new message from server for this item.
protected void	onUpdateProperties(java.lang.String result, ResponseHandler callback) Handle result of some remote properties update method
void	registerItemPropertyHandler(java.lang.String propName, Item.UpdateItemProperty function) Register item property handler of given name
void	setDataFlags(java.lang.Long dataFlags)
void	updateCustomProperty(java.lang.String propName, java.lang.String propValue, ResponseHandler callback) Update custom property, require ACL bit Item.accessFlag.editOther over item
boolean	updateItemData(java.lang.String key, com.google.gson.JsonElement data)
void	updateMeasureUnits(int type, int flags, ResponseHandler callback) Update measure units used in item
void	updateName(java.lang.String name, ResponseHandler callback) Update item name, require ACL bit Item.accessFlag.editName over item

Methods inherited from class com.wialon.core.EventProvider

addListener, clearListeners, fireEvent, removeListener, removeListeners

Methods inherited from class java.lang.Object

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

Field Detail

itemType

protected Item.ItemType itemType

Constructor Detail

Item

public Item()

Method Detail

getCustomFieldsPlugin

public ItemProperties getCustomFieldsPlugin()

getAdminFieldsPlugin

public ItemProperties getAdminFieldsPlugin()

registerItemPropertyHandler

public void registerItemPropertyHandler(java.lang.String propName,
                               Item.UpdateItemProperty function)

Register item property handler of given name

Parameters:

propName - Property name

function - function

getItemType

public Item.ItemType getItemType()

Get item type

Returns:

Item type

getName

public java.lang.String getName()

Get item name

Returns:

Item name

getMeasureUnits

public java.lang.Integer getMeasureUnits()

Get item measure units

Returns:

Item name

getId

public java.lang.Long getId()

Get item id

Returns:

Item id

getAccountId

public java.lang.Long getAccountId()

This item billing account ID

Returns:

Item account id

getCreatorId

public java.lang.Long getCreatorId()

This item user-creator ID

Returns:

Item creator id

getDataFlags

public java.lang.Long getDataFlags()

Current item data flags, e.g. which properties are actual

Returns:

Item data flags

getUserAccess

public java.lang.Long getUserAccess()

Current user access level to this item

Returns:

User access level

getCustomProperty

public java.lang.String getCustomProperty(java.lang.String propName,
                                 java.lang.String defaultVal)

Get custom property

Parameters:

propName - property name

defaultVal - default value if property not defined

Returns:

public property value

setDataFlags

public void setDataFlags(java.lang.Long dataFlags)

handleMessage

public void handleMessage(Message message)

Handle new message from server for this item.

Parameters:

message - Message data

updateCustomProperty

public void updateCustomProperty(java.lang.String propName,
                        java.lang.String propValue,
                        ResponseHandler callback)

Update custom property, require ACL bit Item.accessFlag.editOther over item

Parameters:

propName - property name

propValue - value property

callback - callback that will receive information about property update

updateMeasureUnits

public void updateMeasureUnits(int type,
                      int flags,
                      ResponseHandler callback)

Update measure units used in item

Parameters:

type - {Number} units of measure type, see wialon.item.measureUnitsType for possible types

flags - {Number} set or convert all item settings, see wialon.item.measureUnitsFlag for possible flags

callback - {Function?null} callback that will receive information about convertation: callback(code), zero code is success

updateName

public void updateName(java.lang.String name,
              ResponseHandler callback)

Update item name, require ACL bit Item.accessFlag.editName over item

Parameters:

name - new name value

callback - callback that will receive information about update

addLogRecord

public void addLogRecord(java.lang.String action,
                java.lang.String newValue,
                java.lang.String oldValue,
                ResponseHandler callback)

Add item log record

Parameters:

action - type of action (for unit described in Unit.logMessageAction)

newValue - log record action new value (can be empty)

oldValue - log record action old value (can be empty)

callback - callback that get result of server operation

onUpdateProperties

protected void onUpdateProperties(java.lang.String result,
                      ResponseHandler callback)

Handle result of some remote properties update method

Parameters:

result - properties data in form {pname1: pvalue1, pname2: pvalue2}

callback - user-defined callback

fireItemPropertyEvent

public void fireItemPropertyEvent(java.lang.Enum event,
                         java.lang.Object oldData,
                         java.lang.Object newData)

getOnUpdatePropertiesCallback

protected ResponseHandler getOnUpdatePropertiesCallback(ResponseHandler callback)

updateItemData

public boolean updateItemData(java.lang.String key,
                     com.google.gson.JsonElement data)