oracle.webcenter.generalsettings.model

Class SkinSetting

java.lang.Object

oracle.webcenter.generalsettings.internal.model.GSPreferences

oracle.webcenter.generalsettings.model.SkinSetting

public class SkinSetting
extends oracle.webcenter.generalsettings.internal.model.GSPreferences

Provides an API for managing the skin preference value. The value of this preference is used within the skin-family element of trinidad-config.xml.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VALUE_DEFAULT The default skin.

Fields inherited from class oracle.webcenter.generalsettings.internal.model.GSPreferences

NULL_VALUE

Constructor Summary

Constructors

Constructor and Description
SkinSetting()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getDefaultSkin() Returns the default skin preference for the application.
static java.lang.String	getPreferredSkin() Returns the user's preferred skin value for the current user.
static java.lang.String	getPreferredSkin(java.lang.String username) Returns the user's preferred skin value for the given user.
static java.lang.String	getUserSkinPref() Returns the skin preference value for the current user.
static java.lang.String	getUserSkinPref(java.lang.String username) Return the skin preference value for the given user.
static void	setDefaultSkin(java.lang.String defaultSkin) Sets the default skin preference for the application.
static void	setPreferredSkin(java.lang.String preferredSkin) Deprecated. replaced by setUserSkinPref()
static void	setPreferredSkin(java.lang.String username, java.lang.String preferredSkin) Deprecated. replaced by setUserSkinPref()
static void	setUserSkinPref(java.lang.String preferredSkin) Sets the skin preference for the current authenticated user.
static void	setUserSkinPref(java.lang.String username, java.lang.String preferredSkin) Sets the skin preference for the username.

Methods inherited from class oracle.webcenter.generalsettings.internal.model.GSPreferences

getPreferred, getPreferred, getProvider, getSystemPref, getUserPref, getUserPref, log, setSystemPref, setUserPref

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_DEFAULT

public static final java.lang.String VALUE_DEFAULT

The default skin.

See Also:

Constant Field Values

Constructor Detail

SkinSetting

public SkinSetting()

Method Detail

getPreferredSkin

public static java.lang.String getPreferredSkin()

Returns the user's preferred skin value for the current user. If the preference does not exist, returns null.

Returns:

the user's preferred skin

getPreferredSkin

public static java.lang.String getPreferredSkin(java.lang.String username)

Returns the user's preferred skin value for the given user. If the preference does not exist, returns the default skin preference. If the default skin preference is not set, returns null.

Parameters:

username - the username to obtain the preference for. If null, obtains the preference for the current authenticated user

Returns:

the user's preferred skin

getUserSkinPref

public static java.lang.String getUserSkinPref()

Returns the skin preference value for the current user. If the user preference does not exist, returns null.

Returns:

the user's skin preference value. If the user preference does not exist, returns null

getUserSkinPref

public static java.lang.String getUserSkinPref(java.lang.String username)

Return the skin preference value for the given user. If the user preference does not exist, returns null.

Parameters:

username - the username to obtain the preference for. If null, obtains the preference for the current authenticated user

Returns:

the user's skin preference value. If the user preference does not exist, returns null

setPreferredSkin

public static void setPreferredSkin(java.lang.String username,
                                    java.lang.String preferredSkin)

Deprecated. replaced by setUserSkinPref()

setPreferredSkin

public static void setPreferredSkin(java.lang.String preferredSkin)

Deprecated. replaced by setUserSkinPref()

setUserSkinPref

public static void setUserSkinPref(java.lang.String preferredSkin)

Sets the skin preference for the current authenticated user.

Parameters:

preferredSkin - user's skin preference

setUserSkinPref

public static void setUserSkinPref(java.lang.String username,
                                   java.lang.String preferredSkin)

Sets the skin preference for the username.

Parameters:

username - the username to set the preference for. If null, sets the preference for the current authenticated user

preferredSkin - user's skin preference

getDefaultSkin

public static java.lang.String getDefaultSkin()

Returns the default skin preference for the application. If the preference does not exist, returns null.

Returns:

the application's default skin setting. If this preference is not set, returns null

setDefaultSkin

public static void setDefaultSkin(java.lang.String defaultSkin)

Sets the default skin preference for the application.

Parameters:

defaultSkin - the application default skin preference