net.sf.basedb.core.data
Class ClientData

java.lang.Object
  net.sf.basedb.core.data.BasicData
      net.sf.basedb.core.data.OwnedData
          net.sf.basedb.core.data.SharedData
              net.sf.basedb.core.data.CommonData
                  net.sf.basedb.core.data.ClientData

All Implemented Interfaces:

IdentifiableData, NameableData, OwnableData, RegisteredData, RemovableData, ShareableData

public class ClientData
extends CommonData
implements RegisteredData

This class holds information about a client.

Version:

2.0

Author:

enell

See Also:

Client, Developer documentation: Client, session and settings

Hibernate: class

table="`Clients`" lazy="false"

Field Summary

private Set<ContextData>	contexts
private Set<ClientDefaultSettingData>	defaultSettings
private Date	entryDate
private String	externalId
private Set<HelpData>	helpTexts
static int	MAX_EXTERNAL_ID_LENGTH The maximum length of the external ID that can be stored in the database.
private Set<SessionData>	sessions
private Set<UserClientSettingData>	userSettings

Fields inherited from interface net.sf.basedb.core.data.NameableData

MAX_DESCRIPTION_LENGTH, MAX_NAME_LENGTH

Constructor Summary

ClientData()

Method Summary

(package private) Set<ContextData>	getContexts() This is the inverse end.
(package private) Set<ClientDefaultSettingData>	getDefaultSettings() This is the inverse end.
Date	getEntryDate() Get the date this item was added to the database.
String	getExternalId() Get the external id for this Client item.
(package private) Set<HelpData>	getHelpTexts() This is the inverse end.
(package private) Set<SessionData>	getSessions() This is the invers end.
(package private) Set<UserClientSettingData>	getUserSettings() This is the inverse end.
(package private) void	setContexts(Set<ContextData> contexts)
(package private) void	setDefaultSettings(Set<ClientDefaultSettingData> defaultSettings)
void	setEntryDate(Date entryDate)
void	setExternalId(String externalId)
(package private) void	setHelpTexts(Set<HelpData> helpTexts)
(package private) void	setSessions(Set<SessionData> sessions)
(package private) void	setUserSettings(Set<UserClientSettingData> userSettings)

Methods inherited from class net.sf.basedb.core.data.CommonData

getDescription, getName, isRemoved, setDescription, setName, setRemoved

Methods inherited from class net.sf.basedb.core.data.SharedData

getItemKey, getProjectKey, setItemKey, setProjectKey

Methods inherited from class net.sf.basedb.core.data.OwnedData

getOwner, setOwner

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

Methods inherited from interface net.sf.basedb.core.data.OwnableData

getOwner, setOwner

Field Detail

entryDate

private Date entryDate

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

helpTexts

private Set<HelpData> helpTexts

sessions

private Set<SessionData> sessions

userSettings

private Set<UserClientSettingData> userSettings

defaultSettings

private Set<ClientDefaultSettingData> defaultSettings

contexts

private Set<ContextData> contexts

Constructor Detail

ClientData

public ClientData()

Method Detail

getEntryDate

public Date getEntryDate()

Description copied from interface: RegisteredData

Get the date this item was added to the database. The value is generated at creation time and can't be modified later.

Specified by:

getEntryDate in interface RegisteredData

setEntryDate

public void setEntryDate(Date entryDate)

getExternalId

public String getExternalId()

Get the external id for this Client item.

Hibernate: property

column="`external_id`" type="string" length="255" not-null="true" unique="true"

setExternalId

public void setExternalId(String externalId)

getHelpTexts

Set<HelpData> getHelpTexts()

This is the inverse end.

See Also:

HelpData.getClient()

Hibernate: set

lazy="true" inverse="true" cascade="delete"

Hibernate: collection-key

column="`client_id`"

Hibernate: collection-one-to-many

class="net.sf.basedb.core.data.HelpData"

setHelpTexts

void setHelpTexts(Set<HelpData> helpTexts)

getSessions

Set<SessionData> getSessions()

This is the invers end.

See Also:

SessionData.getClient()

Hibernate: set

lazy="true" inverse="true" cascade="delete"

Hibernate: collection-key

column="`client_id`"

Hibernate: collection-one-to-many

class="net.sf.basedb.core.data.SessionData"

setSessions

void setSessions(Set<SessionData> sessions)

getUserSettings

Set<UserClientSettingData> getUserSettings()

This is the inverse end.

See Also:

UserClientSettingData.getClient()

Hibernate: set

lazy="true" inverse="true" cascade="delete"

Hibernate: collection-key

column="`client_id`"

Hibernate: collection-one-to-many

class="net.sf.basedb.core.data.UserClientSettingData"

setUserSettings

void setUserSettings(Set<UserClientSettingData> userSettings)

getDefaultSettings

Set<ClientDefaultSettingData> getDefaultSettings()

This is the inverse end.

See Also:

ClientDefaultSettingData.getClient()

Hibernate: set

lazy="true" inverse="true" cascade="delete"

Hibernate: collection-key

column="`client_id`"

Hibernate: collection-one-to-many

class="net.sf.basedb.core.data.ClientDefaultSettingData"

setDefaultSettings

void setDefaultSettings(Set<ClientDefaultSettingData> defaultSettings)

getContexts

Set<ContextData> getContexts()

This is the inverse end.

See Also:

ContextData.getClient()

Hibernate: set

lazy="true" inverse="true" cascade="delete"

Hibernate: collection-key

column="`client_id`"

Hibernate: collection-one-to-many

class="net.sf.basedb.core.data.ContextData"

setContexts

void setContexts(Set<ContextData> contexts)