Package de.elo.ix.client
Class KeywordC
java.lang.Object
de.elo.ix.client.KeywordC
- All Implemented Interfaces:
Serializable
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Root ID of standard keyword list.static final String
Root ID of user keyword list.static final String
Root ID of keyword list used for version numbers.static final String
Root ID of keyword list used for version comments.static final String
Root ID of keyword list used for workflows.protected int
Maximum length of keyword ID.protected int
Maximum length of a root keyword ID.protected int
Maximum length of keyword text.static final int
The maximum number of children per keyword.static final int
Maximum depth of a keyword tree.static final KeywordZ
The purpose of this constant object is to control the behavior ofcheckoutKeywords
.static final long
Return raw text incheckoutKeywords
.static final long
Return raw text incheckoutKeywords
.static final KeywordZ
The purpose of this constant object is to control the behavior ofcheckoutKeywords
.static final String
Placeholder for the value of the specified counter name.static final String
End of placeholder for counter name.static final String
Placeholder for current date.static final String
Placeholder for day of month (2 digits).static final String
Placeholder for month (2 digits).static final String
Placeholder for current user name.static final String
Placeholder for year (4 digits).static final String
Deprecated.static final String
Deprecated. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint
getLnId()
int
int
int
int
long
long
void
setKWID_STANDARD_LIST
(String KWID_STANDARD_LIST) void
setKWID_USER_LIST
(String KWID_USER_LIST) void
setKWID_VERSION
(String KWID_VERSION) void
setKWID_VERSION_COMMENT
(String KWID_VERSION_COMMENT) void
setKWID_WORKFLOW
(String KWID_WORKFLOW) void
setLnId
(int v) void
setLnRootId
(int v) void
setLnText
(int v) void
setMAX_CHILDREN
(int MAX_CHILDREN) void
setMAX_TREE_DEPTH
(int MAX_TREE_DEPTH) void
void
setMbPreCookedText
(long mbPreCookedText) void
setMbRawText
(long mbRawText) void
void
setPLACEHOLDER_COUNTER_BEGIN
(String PLACEHOLDER_COUNTER_BEGIN) void
setPLACEHOLDER_COUNTER_END
(String PLACEHOLDER_COUNTER_END) void
setPLACEHOLDER_DATE
(String PLACEHOLDER_DATE) void
setPLACEHOLDER_DAY
(String PLACEHOLDER_DAY) void
setPLACEHOLDER_MONTH
(String PLACEHOLDER_MONTH) void
setPLACEHOLDER_USER_NAME
(String PLACEHOLDER_USER_NAME) void
setPLACEHOLDER_YEAR
(String PLACEHOLDER_YEAR)
-
Field Details
-
KWID_STANDARD_LIST
Root ID of standard keyword list.- See Also:
-
KWID_VERSION
Root ID of keyword list used for version numbers.- See Also:
-
KWID_VERSION_COMMENT
Root ID of keyword list used for version comments.- See Also:
-
KWID_WORKFLOW
Root ID of keyword list used for workflows.- See Also:
-
KWID_USER_LIST
Root ID of user keyword list.- See Also:
-
PLACEHOLDER_DATE
Placeholder for current date. The format depends on the date formatUserProfileC.SORD_DATE_FORMAT
specified in the user or standard profile.- See Also:
-
PLACEHOLDER_YEAR
Placeholder for year (4 digits).- See Also:
-
PLACEHOLDER_MONTH
Placeholder for month (2 digits).- See Also:
-
PLACEHOLDER_DAY
Placeholder for day of month (2 digits).- See Also:
-
PLACEHOLDER_USER_NAME
Placeholder for current user name.- See Also:
-
PLACEHOLDER_COUNTER_BEGIN
Placeholder for the value of the specified counter name. The counter name follows the place holder and is suffixed with an extra "%". E. g.text=PLACEHOLDER_COUNTER_BEGIN + "myRecordCounter" + PLACEHOLDER_COUNTER_END + ". record"
is expanded totext="17. record"
assuming myRecordCounter has value 17.- See Also:
-
PLACEHOLDER_COUNTER_END
End of placeholder for counter name. -
mbRawText
public static final long mbRawTextReturn raw text incheckoutKeywords
. Placeholders are not substituted.- See Also:
-
mbPreCookedText
public static final long mbPreCookedTextReturn raw text incheckoutKeywords
. Placeholders except counters are substituted.- See Also:
-
mbEdit
The purpose of this constant object is to control the behavior ofcheckoutKeywords
. Supplying it,checkoutKeywords
will return the raw text (including placeholders) in the returned Keyword objects. Use this constant, if you want to read keywords into an editor. -
mbView
The purpose of this constant object is to control the behavior ofcheckoutKeywords
. Supplying it,checkoutKeywords
will return substituted placeholders in the text members of the returned Keyword objects. Use this constant, if you want to read keywords into a dialog that lets the user select one of it. -
MAX_CHILDREN
public static final int MAX_CHILDRENThe maximum number of children per keyword. This value is valid for all keyword lists except the user keyword list (KWID_USER_LIST
). The user keyword list might contain more children below a keyword node.- See Also:
-
MAX_TREE_DEPTH
public static final int MAX_TREE_DEPTHMaximum depth of a keyword tree. This value is valid for all keyword lists except the user keyword list (KWID_USER_LIST
). The user keyword list might contain a deeper tree.- See Also:
-
lnRootId
protected int lnRootIdMaximum length of a root keyword ID. If a new keyword list is checked in, the ID of the root keyword must not exceed this length. -
lnId
protected int lnIdMaximum length of keyword ID. -
lnText
protected int lnTextMaximum length of keyword text. -
SEPARATOR_ASPECTID_LINEKEY
Deprecated.Do no longer use this field.- Since:
- 21.00.000.004
- See Also:
-
SEPARATOR_GROUPID_FOR_ASPECTLINES
Deprecated.Do no longer use this field.- Since:
- 21.00.000.025
- See Also:
-
-
Constructor Details
-
KeywordC
public KeywordC()
-
-
Method Details
-
getKWID_STANDARD_LIST
-
setKWID_STANDARD_LIST
-
getKWID_USER_LIST
-
setKWID_USER_LIST
-
getKWID_VERSION
-
setKWID_VERSION
-
getKWID_VERSION_COMMENT
-
setKWID_VERSION_COMMENT
-
getKWID_WORKFLOW
-
setKWID_WORKFLOW
-
getMAX_CHILDREN
public int getMAX_CHILDREN() -
setMAX_CHILDREN
public void setMAX_CHILDREN(int MAX_CHILDREN) -
getMAX_TREE_DEPTH
public int getMAX_TREE_DEPTH() -
setMAX_TREE_DEPTH
public void setMAX_TREE_DEPTH(int MAX_TREE_DEPTH) -
getPLACEHOLDER_COUNTER_BEGIN
-
setPLACEHOLDER_COUNTER_BEGIN
-
getPLACEHOLDER_COUNTER_END
-
setPLACEHOLDER_COUNTER_END
-
getPLACEHOLDER_DATE
-
setPLACEHOLDER_DATE
-
getPLACEHOLDER_DAY
-
setPLACEHOLDER_DAY
-
getPLACEHOLDER_MONTH
-
setPLACEHOLDER_MONTH
-
getPLACEHOLDER_USER_NAME
-
setPLACEHOLDER_USER_NAME
-
getPLACEHOLDER_YEAR
-
setPLACEHOLDER_YEAR
-
getLnId
public int getLnId() -
setLnId
public void setLnId(int v) -
getLnRootId
public int getLnRootId() -
setLnRootId
public void setLnRootId(int v) -
getLnText
public int getLnText() -
setLnText
public void setLnText(int v) -
getMbEdit
-
setMbEdit
-
getMbPreCookedText
public long getMbPreCookedText() -
setMbPreCookedText
public void setMbPreCookedText(long mbPreCookedText) -
getMbRawText
public long getMbRawText() -
setMbRawText
public void setMbRawText(long mbRawText) -
getMbView
-
setMbView
-