Package org.silverpeas.web.variables

Class VariableUIEntity

java.lang.Object

org.silverpeas.core.web.util.SelectableUIEntity<Variable>

org.silverpeas.web.variables.VariableUIEntity

public class VariableUIEntity
extends SelectableUIEntity<Variable>

Method Summary

Modifier and Type	Method	Description
static SilverpeasList<VariableUIEntity>	convertList(SilverpeasList<Variable> values, Set<String> selectedIds)
String	getId()	Gets the unique identifier of te item into the UI list.
Date	getRefEndDate()	Gets the end date of the reference value's period.
Date	getRefStartDate()	Gets the start date of the reference value's period.
VariableScheduledValue	getRefVariableValue()	Gets the value in the underlying variable to use as reference for comparison operation.

Methods inherited from class org.silverpeas.core.web.util.SelectableUIEntity

convert, getData, getUserByIdFromCache, isSelected, setSelected

Methods inherited from class java.lang.Object

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

Method Detail

getId

public String getId()

Description copied from class: SelectableUIEntity

Gets the unique identifier of te item into the UI list.

Specified by:

getId in class SelectableUIEntity<Variable>

Returns:

a unique identifier as string.

convertList

public static SilverpeasList<VariableUIEntity> convertList(SilverpeasList<Variable> values,
                                                           Set<String> selectedIds)

getRefVariableValue

public VariableScheduledValue getRefVariableValue()

Gets the value in the underlying variable to use as reference for comparison operation.

Returns:

a variable's value.

getRefStartDate

public Date getRefStartDate()

Gets the start date of the reference value's period.

Returns:

the date at which the reference value starts to be valid (to be used).

getRefEndDate

public Date getRefEndDate()

Gets the end date of the reference value's period.

Returns:

the date at which the reference value ends to be valid (to be used).