public class HelpData extends BasicData implements NameableData
Help
,
Developer documentation: Client, session and settingsModifier and Type | Field and Description |
---|---|
private ClientData |
client |
private java.lang.String |
description |
private java.lang.String |
externalId |
static int |
MAX_EXTERNAL_ID_LENGTH
The maximum length of the external ID that can be stored in the database.
|
private java.lang.String |
name |
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH
Constructor and Description |
---|
HelpData() |
Modifier and Type | Method and Description |
---|---|
ClientData |
getClient()
Get the client for this help text.
|
java.lang.String |
getDescription()
Get the description for the item.
|
java.lang.String |
getExternalId()
Get the external id for this
Help item. |
java.lang.String |
getName()
Get the name of the item.
|
void |
setClient(ClientData client) |
void |
setDescription(java.lang.String description)
Set the description for the item.
|
void |
setExternalId(java.lang.String externalId) |
void |
setName(java.lang.String name)
Set the name of the item.
|
equals, getId, getVersion, hashCode, setId, setVersion, toString
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
getId, getVersion
private java.lang.String name
private java.lang.String description
private ClientData client
public static final int MAX_EXTERNAL_ID_LENGTH
setExternalId(String)
,
Constant Field Valuesprivate java.lang.String externalId
public java.lang.String getName()
NameableData
getName
in interface NameableData
String
with the name of the itempublic void setName(java.lang.String name)
NameableData
MAX_NAME_LENGTH
constant.setName
in interface NameableData
name
- The new name for the itempublic java.lang.String getDescription()
NameableData
getDescription
in interface NameableData
String
with a description of the itempublic void setDescription(java.lang.String description)
NameableData
MAX_DESCRIPTION_LENGTH
constant.setDescription
in interface NameableData
description
- The new description for the itempublic ClientData getClient()
public void setClient(ClientData client)
public java.lang.String getExternalId()
Help
item.public void setExternalId(java.lang.String externalId)