public class VariableAttributes
extends java.lang.Object
Modifier and Type | Class and Description |
---|---|
static class |
VariableAttributes.Source
Variable source.
|
Modifier | Constructor and Description |
---|---|
protected |
VariableAttributes(com.uc4.util.XMLDocument doc) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getDateFormat()
Returns the output format of a date.
|
java.lang.String |
getHostType()
Returns the host type.
|
DateTime |
getMaximumDate()
Returns the maximum date or
null if not set. |
int |
getMaximumLength()
Returns the maximum number of characters for the first value in variable.
|
java.math.BigDecimal |
getMaximumNumber()
Returns the maximum number.
|
Time |
getMaximumTime()
Returns the maximum time or
null if not set. |
DateTime |
getMaximumTimestamp()
Returns the maximum timestamp or
null if not set. |
DateTime |
getMinimumDate()
Returns the minimum date or
null if not set. |
java.math.BigDecimal |
getMinimumNumber()
Returns the minimum number.
|
Time |
getMinimumTime()
Returns the minimum time or
null if not set. |
DateTime |
getMinimumTimestamp()
Returns the minimum timestamp or
null if not set. |
java.lang.String |
getNumberFormat()
Returns the number format for variable values with the type number.
|
int |
getSortColumn()
Returns the column for sorting.
|
VariableAttributes.Source |
getSource()
Returns the source of this variable.
|
java.lang.String |
getSourceLabel()
Returns the label source of this variable.
|
java.lang.String |
getTimeFormat()
Returns the output format of a time.
|
java.lang.String |
getTimestampFormat()
Returns the output format of timestamps.
|
ValidityKeywordType |
getValidityKeywordType()
Returns the type of the validity keyword.
|
boolean |
isCheckMaxDate()
Returns
true if maximum value is checked. |
boolean |
isCheckMaxLength()
Returns
true if maximum length of characters is checked. |
boolean |
isCheckMaxNumber()
Returns
true if maximum value is checked. |
boolean |
isCheckMaxTime()
Returns
true if maximum value is checked. |
boolean |
isCheckMaxTimestamp()
Returns
true if maximum value is checked. |
boolean |
isCheckMinDate()
Returns
true if minimum value is checked. |
boolean |
isCheckMinNumber()
Returns
true if minimum value is checked. |
boolean |
isCheckMinTime()
Returns
true if minimum value is checked. |
boolean |
isCheckMinTimestamp()
Returns
true if minimum value is checked. |
boolean |
isDataTypeCharacter()
Returns
true if the value type is character. |
boolean |
isDataTypeDate()
Returns
true if the value type is date. |
boolean |
isDataTypeNumber()
Returns
true if the value type is number. |
boolean |
isDataTypeTime()
Returns
true if the value type is time. |
boolean |
isDataTypeTimeStamp()
Returns
true if the value type is time stamp. |
boolean |
isNotFoundError()
Returns
true if an error should
occur when the key is not found. |
boolean |
isNotFoundInitial()
Returns
true if the inital value will be
returned when the key is not found. |
boolean |
isReadOnly()
Returns
true if the variable attributes cannot be modified. |
boolean |
isSortOrderAscending() |
boolean |
isSortOrderDescending() |
boolean |
isUppercase()
Returns
true if the checkbox for upper case is set. |
boolean |
isVariableNotShareable()
Returns
true if the variable is can not be shared. |
boolean |
isVariableReadOnly()
Returns
true if the variable can be accessed from other clients in "reading" mode. |
boolean |
isVariableReferenceable()
Returns
true if the variable is referenceable form other clients. |
void |
setDataTypeCharacter()
Sets the value type to character.
|
void |
setDataTypeDate()
Sets the value type to date.
|
void |
setDataTypeNumber()
Sets the value type to number.
|
void |
setDataTypeTime()
Sets the value type to time.
|
void |
setDataTypeTimeStamp()
Sets the value type to time stamp.
|
void |
setNotFoundError()
Set the variable to return an error if the key is not found.
|
void |
setNotFoundInitial()
Set the variable to return initial values if
the key is not found.
|
void |
setOutputFormatCharacter(java.lang.Integer max,
boolean upperCase)
Sets the output format parameters for the type character.
|
void |
setOutputFormatDate(DateTime min,
DateTime max,
java.lang.String format)
Sets the output format for the datatype date.
|
void |
setOutputFormatNumber(java.math.BigDecimal min,
java.math.BigDecimal max,
java.lang.String format)
Sets the output format parameters for the type number.
|
void |
setOutputFormatTime(Time min,
Time max,
java.lang.String format)
Sets the output format for the datatype time.
|
void |
setOutputFormatTimestamp(DateTime min,
DateTime max,
java.lang.String format)
Sets the output format for the datatype timestamp.
|
void |
setSortColumn(int column)
Sets the column for sorting.
|
void |
setSortOrder(boolean ascending)
Sets the sort order.
|
void |
setValidityKeywordType(ValidityKeywordType validityKeywordType)
Sets the type of the validity keyword.
|
void |
setVariableNotShareable()
Sets the variable type to "Not shareable".
|
void |
setVariableReadOnly()
Sets the variable type to read only.
|
void |
setVariableReferenceable()
Sets the variable type to referenceable.
|
protected void |
store(com.uc4.util.XMLDocument doc,
org.w3c.dom.Element request,
ConnectionAttributes sessionInfo) |
public java.lang.String getSourceLabel()
public boolean isReadOnly()
true
if the variable attributes cannot be modified.
The attributes of referenceable Variables can only be changed in the system client.public VariableAttributes.Source getSource()
public boolean isNotFoundError()
true
if an error should
occur when the key is not found.public void setNotFoundError()
public void setNotFoundInitial()
public boolean isNotFoundInitial()
true
if the inital value will be
returned when the key is not found.public void setDataTypeCharacter()
public boolean isDataTypeCharacter()
true
if the value type is character.true
if characterpublic void setDataTypeNumber()
Valid range: 0 to 2147483647All values are checked for the correct value type when the object is saved.
public void setDataTypeDate()
Format: yymmddAll values are checked for the correct value type when the object is saved.
public void setDataTypeTime()
Format: hhmmssAll values are checked for the correct value type when the object is saved.
public boolean isDataTypeNumber()
true
if the value type is number.
All values are checked for the correct value type when the object is saved.true
if numberpublic boolean isDataTypeTime()
true
if the value type is time.
All values are checked for the correct value type when the object is saved.true
if time is selected as type of the valuespublic boolean isDataTypeDate()
true
if the value type is date.
All values are checked for the correct value type when the object is saved.true
if date is selected as type of the valuespublic void setDataTypeTimeStamp()
Format: YYYY-MM-DD [hh:mm:ss]All values are checked for the correct value type when the object is saved.
public boolean isDataTypeTimeStamp()
true
if the value type is time stamp.true
if time stamp.public ValidityKeywordType getValidityKeywordType()
public void setValidityKeywordType(ValidityKeywordType validityKeywordType)
validityKeywordType
- validity keyword typepublic void setVariableNotShareable()
public boolean isVariableNotShareable()
true
if the variable is can not be shared.
The Variable can only be accessed in the system client.
Variables of the same name which are stored in a different client,
however, are not connected to the Variable in the system client.true
if the variable is can not be sharedpublic void setVariableReadOnly()
public boolean isVariableReadOnly()
true
if the variable can be accessed from other clients in "reading" mode.
This is only supported in client 0.true
if the variable is read onlypublic void setVariableReferenceable()
public boolean isVariableReferenceable()
true
if the variable is referenceable form other clients.
This is only supported in client 0.true
if the variable is referenceablepublic void setOutputFormatCharacter(java.lang.Integer max, boolean upperCase)
max
- Maximum length, integer between 1 and 1024, null
is allowed in order to set no valueupperCase
- if true the value is converted to upper casepublic void setOutputFormatNumber(java.math.BigDecimal min, java.math.BigDecimal max, java.lang.String format)
min
- Minimum value, null
is allowed in order to set no valuemax
- Maximum value, null
is allowed in order to set no valueformat
- Format string, can be one of: "0.00","+0.00","-0.00","0","-0","+0","0000000000000000"public void setOutputFormatTimestamp(DateTime min, DateTime max, java.lang.String format)
min
- Minimum value, null
is allowed in order to set no valuemax
- Maximum value, null
is allowed in order to set no valueformat
- Output format of the timestamp, allowed values are "yyyy-mm-dd hh:mm:ss" or "yyyymmddhh24miss"public void setOutputFormatDate(DateTime min, DateTime max, java.lang.String format)
min
- Minimum value, null
is allowed in order to set no valuemax
- Maximum value, null
is allowed in order to set no valueformat
- Output format, one of:
"dd-mon-yyyy","dd-mon-rr","mm-dd-yyyy","yyyymmdd","mmddrr","ddmmrr","mm-dd-rr","mm/dd/rr","yyyy-mm-dd"public void setOutputFormatTime(Time min, Time max, java.lang.String format)
min
- Minimum time, null
is allowed in order to set no valuemax
- Maximum time, null
is allowed in order to set no valueformat
- Output format, allowed value: "hhmmss", "hhmmss", "hh:mm:ss", "hhmm", "hh:mm", "mmss", "mm:ss"public int getMaximumLength()
public java.lang.String getNumberFormat()
null
is never returnedpublic java.math.BigDecimal getMinimumNumber()
public java.math.BigDecimal getMaximumNumber()
public boolean isUppercase()
true
if the checkbox for upper case is set.public java.lang.String getTimestampFormat()
public java.lang.String getTimeFormat()
public java.lang.String getDateFormat()
public DateTime getMinimumTimestamp()
null
if not set.public DateTime getMaximumTimestamp()
null
if not set.public Time getMinimumTime()
null
if not set.public Time getMaximumTime()
null
if not set.public DateTime getMinimumDate()
null
if not set.public DateTime getMaximumDate()
null
if not set.public void setSortColumn(int column)
column
- Column indexpublic int getSortColumn()
public void setSortOrder(boolean ascending)
ascending
- true for ascending sort order, false for descending order.public boolean isSortOrderAscending()
public boolean isSortOrderDescending()
public boolean isCheckMaxLength()
true
if maximum length of characters is checked.public boolean isCheckMinNumber()
true
if minimum value is checked.public boolean isCheckMaxNumber()
true
if maximum value is checked.public boolean isCheckMinTime()
true
if minimum value is checked.public boolean isCheckMaxTime()
true
if maximum value is checked.public boolean isCheckMinDate()
true
if minimum value is checked.public boolean isCheckMaxDate()
true
if maximum value is checked.public boolean isCheckMinTimestamp()
true
if minimum value is checked.public boolean isCheckMaxTimestamp()
true
if maximum value is checked.public java.lang.String getHostType()
protected void store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)