Package de.elo.ix.client

Class Keyword

java.lang.Object

byps.BValueClass

de.elo.ix.client.ValueClass

de.elo.ix.client.Keyword

All Implemented Interfaces:

Serializable

public class Keyword
extends ValueClass
implements Serializable

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	add	Prefix the text of a child keyword with the text of this keyword.
protected Keyword[]	children	Child array.
protected String	displayValue	Only used in keywords for aspect lines with type = AspectLineC.TYPE_STATUS.
protected boolean	enabled	If true, this keyword can be used as a value for an index property.
protected String	id	Keyword ID.
protected boolean	raw	The function cookKeyword() must be called for this keyword in order to use it for an index property.
protected String	text	Keyword text.
protected String	textTranslationKey	Translation key for text.

Fields inherited from class byps.BValueClass

bypsClient, changedMembers, dbHelper, FLAG_SEALED, flags

Constructor Summary

Constructors

Constructor	Description
Keyword()
Keyword(boolean add, Keyword[] children, boolean enabled, String id, boolean raw, String text, String displayValue)
Keyword(Keyword rhs)

Method Summary

Modifier and Type	Method	Description
Keyword[]	getChildren()
String	getDisplayValue()
String	getId()
String	getText()
String	getTextTranslationKey()
boolean	isAdd()
boolean	isEnabled()
boolean	isRaw()
void	setAdd(boolean add)
void	setChildren(Keyword[] children)
void	setDisplayValue(String displayValue)
void	setEnabled(boolean enabled)
void	setId(String id)
void	setRaw(boolean raw)
void	setText(String text)
void	setTextTranslationKey(String textTranslationKey)
String	toString()

Methods inherited from class byps.BValueClass

getBypsClient, getChangedMembers, getDbHelper, isChangedMember, isSealed, seal, seal, setBypsClient, setChangedMember, setChangedMembers, setDbHelper

Methods inherited from class java.lang.Object

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

Field Details

add

protected boolean add

Prefix the text of a child keyword with the text of this keyword. This member is interpreted in cookKeywords. The following relationship exists between the members enabled, add, raw

Member relationships

condition	conclusion
add=true	enabled=false, raw=true
enabled=true	add=false, raw=any

See Also:

• IXServicePortIF_Stub.cookKeyword(...)

children

protected Keyword[] children

Child array.

enabled

protected boolean enabled

If true, this keyword can be used as a value for an index property. Otherwise its only purpose is to structure the keyword hierachy.

See Also:

• add

id

protected String id

Keyword ID. Consists of: groupid + orderid, orderid begins with a ".".

raw

protected boolean raw

The function cookKeyword() must be called for this keyword in order to use it for an index property. This is because it contains placeholders that must be substituted or one of the parent keywords should be added.

See Also:

• add

text

protected String text

Keyword text. This term is assigned to an index property. The member raw should be checked before this term is used. This text can be translated into reps. from the users language: set SessionOptionsC.TRANSLATE_TERM.

See Also:

• SessionOptionsC.TRANSLATE_TERMS
• raw

displayValue

protected String displayValue

Only used in keywords for aspect lines with type = AspectLineC.TYPE_STATUS. This field contains the translated text of the status value (field text) into user's language.

Since:

21.00.000.010

textTranslationKey

protected String textTranslationKey

Translation key for text.

Since:

21.03.000.011

Constructor Details

Keyword

public Keyword()

Keyword

public Keyword(boolean add,
 Keyword[] children,
 boolean enabled,
 String id,
 boolean raw,
 String text,
 String displayValue)

Keyword

public Keyword(Keyword rhs)

Method Details

isAdd

public boolean isAdd()

setAdd

public void setAdd(boolean add)

getChildren

public Keyword[] getChildren()

setChildren

public void setChildren(Keyword[] children)

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getId

public String getId()

setId

public void setId(String id)

isRaw

public boolean isRaw()

setRaw

public void setRaw(boolean raw)

getText

public String getText()

setText

public void setText(String text)

getDisplayValue

public String getDisplayValue()

setDisplayValue

public void setDisplayValue(String displayValue)

getTextTranslationKey

public String getTextTranslationKey()

setTextTranslationKey

public void setTextTranslationKey(String textTranslationKey)

toString

public String toString()

Overrides:

toString in class Object