|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object net.sf.basedb.core.data.BasicData net.sf.basedb.core.data.HelpData
public class HelpData
This class holds information about an help item.
Help
,
Session and client overviewField Summary | |
---|---|
private ClientData |
client
|
private String |
description
|
private String |
externalId
|
static int |
MAX_EXTERNAL_ID_LENGTH
The maximum length of the external ID that can be stored in the database. |
private String |
name
|
Fields inherited from interface net.sf.basedb.core.data.NameableData |
---|
MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH |
Constructor Summary | |
---|---|
HelpData()
|
Method Summary | |
---|---|
ClientData |
getClient()
Get the client for this help text. |
String |
getDescription()
Get the description for the item. |
String |
getExternalId()
Get the external id for this Help item. |
String |
getName()
Get the name of the item. |
void |
setClient(ClientData client)
|
void |
setDescription(String description)
Set the description for the item. |
void |
setExternalId(String externalId)
|
void |
setName(String name)
Set the name of the item. |
Methods inherited from class net.sf.basedb.core.data.BasicData |
---|
equals, getId, getVersion, hashCode, setId, setVersion, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface net.sf.basedb.core.data.IdentifiableData |
---|
getId, getVersion |
Field Detail |
---|
private String name
private String description
private ClientData client
public static final int MAX_EXTERNAL_ID_LENGTH
setExternalId(String)
,
Constant Field Valuesprivate String externalId
Constructor Detail |
---|
public HelpData()
Method Detail |
---|
public String getName()
NameableData
getName
in interface NameableData
String
with the name of the itempublic void setName(String name)
NameableData
MAX_NAME_LENGTH
constant.
setName
in interface NameableData
name
- The new name for the itempublic String getDescription()
NameableData
getDescription
in interface NameableData
String
with a description of the itempublic void setDescription(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 String getExternalId()
Help
item.
public void setExternalId(String externalId)
|
2.17.2: 2011-06-17 | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |