com.hpe.adm.nga.sdk.model

Class EntityModel

java.lang.Object

com.hpe.adm.nga.sdk.model.EntityModel

All Implemented Interfaces:

Entity

Direct Known Subclasses:

ErrorModel

public class EntityModel
extends Object
implements Entity

This class hold the EntityModel objects and server as an entity data holder entities. The EntityModel class has two states - clean and dirty. When creating a new entity from scratch then each addition will be considered dirty and will be sent to the server when creating or updating. When the entity has been returned from the server then the initial state will be considered clean. Each change after that (for example by using a method set*) will make the entity "dirty" and will be sent to the server when used for updates Note - the id field is always considered a dirty field since it needs to be added

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EntityModel.EntityState Represents the state of the entity.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_LOCK_STAMP_FIELD_NAME Field that keeps track if the entity has changed on the server vs what is being sent from the client If it's contained in the entity model, it should always be sent back to the server (always dirty) This prevents users to overwrite other people's changes from their client side cached entity
static String	ID_FIELD_NAME ID field, should always be sent to the server (always dirty)

Constructor Summary

Constructors

Constructor and Description
EntityModel() Creates a new EntityModel object All fields set after using this constructor will be considered "dirty"
EntityModel(Set<FieldModel> values) Creates a new EntityModel object with given field models Use this when create entity model with mass of fields.
EntityModel(Set<FieldModel> values, EntityModel.EntityState entityState) Creates a new EntityModel object with given field models Use this when create entity model with mass of fields.
EntityModel(String key, String value) Creates a new EntityModel object with solo string field The entity will be considered dirty and thus these fields will be updated

Method Summary

Modifier and Type	Method and Description
String	getId() Returns the ID of the entity.
String	getType() Returns the type of the entity.
FieldModel	getValue(String key) getter of single field
Set<FieldModel>	getValues() getter of entity value
void	removeValue(String key) Remove a value from completely, different from setting the value to null
EntityModel	setValue(FieldModel fieldModel) setter of single field, update if field exists
EntityModel	setValues(Set<FieldModel> values) setter of new entity value, all old fields are cleared
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ID_FIELD_NAME

public static final String ID_FIELD_NAME

ID field, should always be sent to the server (always dirty)

See Also:

Constant Field Values

CLIENT_LOCK_STAMP_FIELD_NAME

public static final String CLIENT_LOCK_STAMP_FIELD_NAME

Field that keeps track if the entity has changed on the server vs what is being sent from the client If it's contained in the entity model, it should always be sent back to the server (always dirty) This prevents users to overwrite other people's changes from their client side cached entity

See Also:

Constant Field Values

Constructor Detail

EntityModel

public EntityModel()

Creates a new EntityModel object All fields set after using this constructor will be considered "dirty"

EntityModel

public EntityModel(Set<FieldModel> values)

Creates a new EntityModel object with given field models Use this when create entity model with mass of fields. By using this constructor these fields will be considered to be the "dirty slate" of the entity. In other words these fields as well as those set afterwards will be considered in any updates

Parameters:

values - - a collection of field models

EntityModel

public EntityModel(Set<FieldModel> values,
                   EntityModel.EntityState entityState)

Creates a new EntityModel object with given field models Use this when create entity model with mass of fields.

Parameters:

values - - a collection of field models

entityState - The initial state of the entity when constructing. Once these fields have been initialised the entity is considered to be dirty

EntityModel

public EntityModel(String key,
                   String value)

Creates a new EntityModel object with solo string field The entity will be considered dirty and thus these fields will be updated

Parameters:

value - - a collection of field models

key - The key to the model

Method Detail

getValues

public Set<FieldModel> getValues()

getter of entity value

Returns:

a collection of field models

getValue

public FieldModel getValue(String key)

getter of single field

Parameters:

key - the fieldName

Returns:

the field of specified field name

removeValue

public void removeValue(String key)

Remove a value from completely, different from setting the value to null

Parameters:

key - the fieldName

setValues

public EntityModel setValues(Set<FieldModel> values)

setter of new entity value, all old fields are cleared

Parameters:

values - - a collection of field models

Returns:

EntityModel with the field models set as a values

setValue

public EntityModel setValue(FieldModel fieldModel)

setter of single field, update if field exists

Parameters:

fieldModel - the single field to update

Returns:

EntityModel with the field model set as a value

getType

public final String getType()

Description copied from interface: Entity

Returns the type of the entity. All entities that are returned from the server have a type. If a type has not been set this will return null

Specified by:

getType in interface Entity

Returns:

the type of the entity or null if not set

getId

public final String getId()

Description copied from interface: Entity

Returns the ID of the entity. Most (if not all) entities have an ID. However it is possible for the entity to not have an ID even when returned from the server. If the ID has not been set this will return null

Specified by:

getId in interface Entity

Returns:

the ID of the entity or null if not set

toString

public String toString()

Overrides:

toString in class Object