org.olat.user
Class HomePageConfig

java.lang.Object
  org.olat.user.HomePageConfig

All Implemented Interfaces:

OLATResourceable

public class HomePageConfig
extends java.lang.Object
implements OLATResourceable

Description:
The HomePageConfig class represents a configuration for a Homepage. It is persisted as an xml file in the ???. Loading and saving of configuration files is managed through the HomePageConfigManagerImpl.

A HomePageConfig has a class wide CURRENTVERSION, an integer denoting the most actual code version of the HomePageConfig. The attribute version is the version number of an instance.

CURRENTVERSION vs. version

• version == CURRENTVERSION
  an up to date HomePageConfig
• version < CURRENTVERSION
  demands for resolving version differences, as the loaded HomePageConfig may contain outdated configuration information

Initial Date: July 15, 2005

Author:

Alexander Schneider

Field Summary

static java.lang.String	KEY_ADDRESS Deprecated.
static java.lang.String	KEY_BIRTHDAY Deprecated.
static java.lang.String	KEY_EMAIL Deprecated.
static java.lang.String	KEY_GENDER Deprecated.
static java.lang.String	KEY_INSTITIUTIONALNAME Deprecated.
static java.lang.String	KEY_INSTITUTIONEMAIL Deprecated.
static java.lang.String	KEY_RESOURCEABLEID
static java.lang.String	KEY_TELMOBILE Deprecated.
static java.lang.String	KEY_TELOFFICE Deprecated.
static java.lang.String	KEY_TELPRIVATE Deprecated.
static java.lang.String	KEY_TEXTABOUTME
static java.lang.String	KEY_USERNAME

Constructor Summary

HomePageConfig()

Method Summary

java.lang.Long	getResourceableId()
java.lang.String	getResourceableTypeName()
java.lang.String	getTextAboutMe()
java.lang.String	getUserName()
int	getVersion()
boolean	hasResourceableId()
void	initDefaults() initialize with default values
boolean	isEnabled(java.lang.String propertyName) Check if the visibility of user property is enabled
void	resolveVersionIssues() resolve issues of changed configuration version.
void	setEnabled(java.lang.String propertyName, boolean enabled) Enable or disable the visibility of a user property
void	setResourceableId(java.lang.Long id)
void	setTextAboutMe(java.lang.String textAboutMe)
void	setUserName(java.lang.String userName)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_RESOURCEABLEID

public static final transient java.lang.String KEY_RESOURCEABLEID

See Also:

Constant Field Values

KEY_USERNAME

public static final transient java.lang.String KEY_USERNAME

See Also:

Constant Field Values

KEY_TEXTABOUTME

public static final transient java.lang.String KEY_TEXTABOUTME

See Also:

Constant Field Values

KEY_EMAIL

@Deprecated
public static final transient java.lang.String KEY_EMAIL

Deprecated.

See Also:

Constant Field Values

KEY_GENDER

@Deprecated
public static final transient java.lang.String KEY_GENDER

Deprecated.

See Also:

Constant Field Values

KEY_BIRTHDAY

@Deprecated
public static final transient java.lang.String KEY_BIRTHDAY

Deprecated.

See Also:

Constant Field Values

KEY_TELMOBILE

@Deprecated
public static final transient java.lang.String KEY_TELMOBILE

Deprecated.

See Also:

Constant Field Values

KEY_TELPRIVATE

@Deprecated
public static final transient java.lang.String KEY_TELPRIVATE

Deprecated.

See Also:

Constant Field Values

KEY_TELOFFICE

@Deprecated
public static final transient java.lang.String KEY_TELOFFICE

Deprecated.

See Also:

Constant Field Values

KEY_ADDRESS

@Deprecated
public static final transient java.lang.String KEY_ADDRESS

Deprecated.

See Also:

Constant Field Values

KEY_INSTITIUTIONALNAME

@Deprecated
public static final transient java.lang.String KEY_INSTITIUTIONALNAME

Deprecated.

See Also:

Constant Field Values

KEY_INSTITUTIONEMAIL

@Deprecated
public static final transient java.lang.String KEY_INSTITUTIONEMAIL

Deprecated.

See Also:

Constant Field Values

Constructor Detail

HomePageConfig

public HomePageConfig()

Method Detail

getVersion

public int getVersion()

Returns:

version of this loaded/created instance

initDefaults

public void initDefaults()

initialize with default values

resolveVersionIssues

public void resolveVersionIssues()

resolve issues of changed configuration version. Such as:

• add new default values
  >>add the them
• no longer exisiting key value pairs
  >>remove from configuration
• changing of value meanings/types
  >>convert the existing entries

setEnabled

public void setEnabled(java.lang.String propertyName,
                       boolean enabled)

Enable or disable the visibility of a user property

Parameters:

propertyName - The name of the user property

enabled - true: enable visibility; false, disable

isEnabled

public boolean isEnabled(java.lang.String propertyName)

Check if the visibility of user property is enabled

Parameters:

propertyName - The name of the user property

Returns:

true: enable visibility; false, disable

setResourceableId

public void setResourceableId(java.lang.Long id)

Parameters:

id -

getResourceableId

public java.lang.Long getResourceableId()

Specified by:

getResourceableId in interface OLATResourceable

Returns:

id

getResourceableTypeName

public java.lang.String getResourceableTypeName()

Specified by:

getResourceableTypeName in interface OLATResourceable

Returns:

typeName

setUserName

public void setUserName(java.lang.String userName)

Parameters:

userName -

getUserName

public java.lang.String getUserName()

Returns:

text about me

setTextAboutMe

public void setTextAboutMe(java.lang.String textAboutMe)

Parameters:

textAboutMe -

getTextAboutMe

public java.lang.String getTextAboutMe()

Returns:

text about me

hasResourceableId

public boolean hasResourceableId()

Returns:

boolean