2.17.2: 2011-06-17

net.sf.basedb.core.data
Class HelpData

java.lang.Object
  extended by net.sf.basedb.core.data.BasicData
      extended by 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, Session and client overview
Last modified
$Date: 2009-04-06 14:52:39 +0200 (Mon, 06 Apr 2009) $
Hibernate: class
table="`HelpTexts`" lazy="false"

Field 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

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
Constructor Detail

HelpData

public HelpData()
Method Detail

getName

public String getName()
Description copied from interface: NameableData
Get the name of the item.

Specified by:
getName in interface NameableData
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 the MAX_NAME_LENGTH constant.

Specified by:
setName in interface NameableData
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 interface NameableData
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 the MAX_DESCRIPTION_LENGTH constant.

Specified by:
setDescription in interface NameableData
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="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 this Help item.

Hibernate: property
type="string"
Hibernate: column
name="`external_id`" length="255" not-null="true" unique-key="uniquehelp"

setExternalId

public void setExternalId(String externalId)

2.17.2: 2011-06-17