com.sssw.fw.usermgr.api
Interface EbiUserPreferenceInfo

All Superinterfaces:

Cloneable, EbiElement, EbiFrameworkElement, Serializable

public interface EbiUserPreferenceInfo

extends EbiFrameworkElement

This class is used to pass component persistent data to/from database PortalComponents table.

Field Summary

static String

EL_PORTAL_USERPREF userpreference element type

Method Summary

String	getComponentClassName() Deprecated. Use EbiUserPreferenceInfo.getElementID()
String	getComponentInstanceID() Deprecated.
String	getElementID() Gets the Elements ID
String	getElementType() Gets the Elements Type
String	getPreferenceData() Gets the user prefernces.
String	getPreferenceUUID() Gets the UUID.
String	getUserCompStyleID() Deprecated.
String	getUserCompXML() Deprecated. Use EbiUserPreferenceInfo.getPreferenceData()
String	getUserUUID() Gets the User UUID.
void	setComponentClassName(String compClassName) Deprecated. Use EbiUserPreferenceInfo.setElementID(String)
void	setComponentInstanceID(String compInstanceID) Deprecated.
void	setElementID(String elementID) Sets the element id.
void	setElementType(String elementType) Sets the element type.
void	setPreferenceData(String prefData) sets the user prefernces.
void	setPreferenceUUID(String UUID) sets the UUID.
void	setUserCompStyleID(String styleID) Deprecated.
void	setUserCompXML(String userCompXML) Deprecated.
void	setUserUUID(String userIID) Sets the User UUID.

Methods implemented from interface com.sssw.fw.api.EbiFrameworkElement

getElementUUID, getLastModified, getLastModifiedBy, isEqualTo, isReadOnly, resetReadOnly, setLastModified, setLastModifiedBy, setReadOnly

Methods implemented from interface com.sssw.fw.api.EbiElement

getType

Field Detail

EL_PORTAL_USERPREF

public static final String EL_PORTAL_USERPREF

userpreference element type

Method Detail

getUserUUID

public String getUserUUID()

Gets the User UUID.

Returns:

a User UUID.

getPreferenceUUID

public String getPreferenceUUID()

Gets the UUID.

Returns:

a UUID.

setPreferenceUUID

public void setPreferenceUUID(String UUID)

sets the UUID.

getComponentClassName

public String getComponentClassName()

Deprecated. Use EbiUserPreferenceInfo.getElementID()

Gets the component class name.

Returns:

a component class name.

getElementID

public String getElementID()

Gets the Elements ID

Returns:

an element ID

getElementType

public String getElementType()

Gets the Elements Type

Returns:

an element Type

getComponentInstanceID

public String getComponentInstanceID()

Deprecated.

Gets the component instance ID. This method has been deprecated. In order to track a component's instance ID pass it in as part of teh element id. For example where element type is com.sssw.portal.api.EbiPortalComponentInfo.EL_PORTAL_COMPONENT you may want to have this component personalized by component and instance name. In that case use something line HelloWorld.MyInstance as the element id. Where HelloWorld is the component id and MyInstance is this particular component's instance.

Returns:

a component instance ID.

getUserCompStyleID

public String getUserCompStyleID()

Deprecated.

Gets the user preferred component style ID. This method has been deprecated. All specific personalization information should be stored in the PreferenceData. Usually as a xml document type that you have defined. For example your preference data may look like this: arial 12

Returns:

the user preferred component style ID.

getUserCompXML

public String getUserCompXML()

Deprecated. Use EbiUserPreferenceInfo.getPreferenceData()

Gets the user preferred component properties.

Returns:

the user preferred component properties.

getPreferenceData

public String getPreferenceData()

Gets the user prefernces. Usually as a xml document type that you have defined. For example your preference data may look like this: arial 12 The definition of your data is at your discretion and parsing is left up to you.

Returns:

the user preferrences.

setPreferenceData

public void setPreferenceData(String prefData)

sets the user prefernces. Usually as a xml document type that you have defined. For example your preference data may look like this: arial 12 The definition of your data is at your discretion and parsing is left up to you.

Parameters:

prefData - the user preferrences.

setUserUUID

public void setUserUUID(String userIID)

Sets the User UUID.

Parameters:

userIID - a User UUID.

setComponentClassName

public void setComponentClassName(String compClassName)

Deprecated. Use EbiUserPreferenceInfo.setElementID(String)

Sets the component class name. This method has been deprecated.

Parameters:

compClassName - a component class name

setElementID

public void setElementID(String elementID)

Sets the element id.

Parameters:

elementID -

setElementType

public void setElementType(String elementType)

Sets the element type. Example for component use com.sssw.portal.api.EbiPortalComponentInfo.EL_PORTAL_COMPONENT You may also use your own custom element types which will enable personalization of pretty much any type of object.

Parameters:

elementID -

setComponentInstanceID

public void setComponentInstanceID(String compInstanceID)

Deprecated.

Sets the component instance ID. This method has been deprecated see getComponentInstanceID.

Parameters:

compInstanceID - a component instance ID.

setUserCompStyleID

public void setUserCompStyleID(String styleID)

Deprecated.

Sets the user preferred component style ID. This method has been deprecated. See getUserCompStyleID()

Parameters:

styleID - a style ID.

setUserCompXML

public void setUserCompXML(String userCompXML)

Deprecated.

Sets the user preferred component properties. This method has been deprecated. See getUserCompXML()

Parameters:

userCompXML - the user preferred component properties in xml format.