lumis.portal.hierarquicalpropertybag
Class Property

java.lang.Object
  lumis.portal.hierarquicalpropertybag.Property

public class Property
extends Object

Object that represents a property of a Hierarquical Property Bag.

A property has a name, a value that may be a string or array of strings, and a flag that indicates whether the property is readOnly or not. A read only property may not be personalized.

Since:

4.2.0

Field Summary

static String

DEFAULT_TYPE

Constructor Summary

Property(String name, List<String> values)
Constructor given a name and string array value for the property.

Property(String name, String value)
Constructor given a name and single string value for the property.

Method Summary

String	getId() Returns the identifier of the property
String	getName() Returns the name of the property.
HierarquicalPropertyBag	getPropertyBag() Returns the parent property bag of the property.
String	getType() Returns the type of the property.
List<String>	getValues() Returns the list of values for the property.
boolean	isReadOnly() Returns the is readOnly property of the property.
void	setId(String id) Sets the identifier of the property.
void	setReadOnly(boolean readOnly) Sets the readOnly property.
void	setType(String type) Sets the type of the property.
void	setValue(String value) Sets the value of the property.
void	setValues(List<String> values) Set a array value to the property.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TYPE

public static final String DEFAULT_TYPE

See Also:

Constant Field Values

Constructor Detail

Property

public Property(String name,
                String value)

Constructor given a name and single string value for the property.

Parameters:

name - name of the property.

value - value of the property.

Since:

4.2.0

Property

public Property(String name,
                List<String> values)

Constructor given a name and string array value for the property.

Parameters:

name - name of the property.

values - list of strings that represent the value of the property.

Since:

4.2.0

Method Detail

getId

public String getId()

Returns the identifier of the property

Returns:

identifier of the property

Since:

4.2.0

setId

public void setId(String id)

Sets the identifier of the property.

Parameters:

id - the identifier of the property.

Since:

4.2.0

getType

public String getType()

Returns the type of the property.

Returns:

the property type.

Since:

4.2.0

setType

public void setType(String type)

Sets the type of the property.

Parameters:

type -

Since:

4.2.0

getName

public String getName()

Returns the name of the property.

Returns:

the name of the property.

Since:

4.2.0

isReadOnly

public boolean isReadOnly()

Returns the is readOnly property of the property.

Returns:

the is readOnly property.

Since:

4.2.0

setReadOnly

public void setReadOnly(boolean readOnly)

Sets the readOnly property.

Parameters:

readOnly - true if the property should be read only.

Since:

4.2.0

getValues

public List<String> getValues()

Returns the list of values for the property.

Returns:

the list of values.

Since:

4.2.0

setValue

public void setValue(String value)

Sets the value of the property.

The previous list of values is cleared before creating a new value list of one element that will contain the given value.

Parameters:

value - the value of the property.

Since:

4.2.0

setValues

public void setValues(List<String> values)

Set a array value to the property.

Parameters:

values - the array value to set.

Since:

4.2.0

getPropertyBag

public HierarquicalPropertyBag getPropertyBag()

Returns the parent property bag of the property.

Returns:

the parent property bag.

Since:

4.2.0