Package net.sf.basedb.core.data
Class HelpData
- java.lang.Object
-
- net.sf.basedb.core.data.BasicData
-
- net.sf.basedb.core.data.HelpData
-
- All Implemented Interfaces:
IdentifiableData
,NameableData
public class HelpData extends BasicData implements NameableData
This class holds information about an help item.- Version:
- 2.0
- Author:
- enell
- See Also:
Help
, Developer documentation: Client, session and settings- Last modified
- $Date: 2014-06-10 13:27:02 +0200 (ti, 10 jun 2014) $
- Hibernate: class
- table="`HelpTexts`" lazy="false"
-
-
Field Summary
Fields Modifier and Type Field Description 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
Constructors Constructor Description HelpData()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ClientData
getClient()
Get the client for this help text.String
getDescription()
Get the description for the item.String
getExternalId()
Get the external id for thisHelp
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
-
name
private String name
-
description
private String description
-
client
private ClientData client
-
MAX_EXTERNAL_ID_LENGTH
public static final int MAX_EXTERNAL_ID_LENGTH
The maximum length of the external ID that can be stored in the database.- See Also:
setExternalId(String)
, Constant Field Values
-
externalId
private String externalId
-
-
Method Detail
-
getName
public String getName()
Description copied from interface:NameableData
Get the name of the item.- Specified by:
getName
in interfaceNameableData
- Returns:
- A
String
with the name of the item
-
setName
public void setName(String name)
Description copied from interface:NameableData
Set the name of the item. The name cannot be null and mustn't be longer than the value specified by theMAX_NAME_LENGTH
constant.- Specified by:
setName
in interfaceNameableData
- Parameters:
name
- The new name for the item
-
getDescription
public String getDescription()
Description copied from interface:NameableData
Get the description for the item.- Specified by:
getDescription
in interfaceNameableData
- Returns:
- A
String
with a description of the item
-
setDescription
public void setDescription(String description)
Description copied from interface:NameableData
Set the description for the item. The description can be null but mustn't be longer than the value specified by theMAX_DESCRIPTION_LENGTH
constant.- Specified by:
setDescription
in interfaceNameableData
- Parameters:
description
- The new description for the item
-
getClient
public ClientData getClient()
Get the client for this help text.- Hibernate: column
- name="`client_id`" not-null="true" unique-key="Help_uniquehelp"
- Hibernate: many-to-one
- outer-join="false" update="false"
-
setClient
public void setClient(ClientData client)
-
getExternalId
public String getExternalId()
Get the external id for thisHelp
item.- Hibernate: property
- type="string"
- Hibernate: column
- name="`external_id`" length="255" not-null="true" unique-key="Help_uniquehelp"
-
setExternalId
public void setExternalId(String externalId)
-
-