com.sssw.portal.api
Interface EbiUserComponentInfo

public interface EbiUserComponentInfo

Interface for managing user component information for a portal application.

Field Summary

static String	EL_PORTAL_USER_COMPONENT Portal user component element type
static String	PARAM_MODE The Component title key.
static String	PARAM_TITLE The component title key.
static String	STATE_MAXIMIZED The maximized window state.
static String	STATE_MINIMIZED The minimized window state.
static String	STATE_NORMAL The normal window state.

Method Summary

boolean	containsComponentInstance(String instanceID) Checks to see whether the information about the specified component instance exists in this EbiUserComponentInfo object.
String[]	getComponentInstanceIDs() Gets the list of component instance identifiers.
String	getComponentName() Gets the component name.
String	getParameter(String instanceID, String name) Gets the value of a specified parameter name for a component instance.
Enumeration	getParameterNames(String instanceID) Gets an enumeration of the parameter names that are defined for a component instance.
String[]	getParameterValues(String instanceID, String name) Gets a String array of parameter values for a specified parameter and component instance.
String	getPortalID() Gets the portal ID.
String	getState(String instanceID) Gets the state of a component instance.
String	getStyleID(String instanceID) Gets the styleID of a component instance.
String	getUserUUID() Gets the user UUID.
void	removeComponentInstance(String instanceID) Removes a component instance.
void	removeParameter(String instanceID, String param) Removes a parameter.
void	setComponentName(String compName) Sets the component name.
void	setParameter(String instanceID, String name, String value) Sets a value of a specified parameter name.
void	setPortalID(String portalID) Sets the portal ID.
void	setState(String instanceID, String state) Sets the state for this component instance for the user for a component instance.
void	setStyleID(String instanceID, String styleID) Sets the style Identifier for a component instance.
void	setUserUUID(String userIID) Sets the user UUID.

Field Detail

EL_PORTAL_USER_COMPONENT

public static final String EL_PORTAL_USER_COMPONENT

Portal user component element type

STATE_NORMAL

public static final String STATE_NORMAL

The normal window state.

STATE_MINIMIZED

public static final String STATE_MINIMIZED

The minimized window state.

STATE_MAXIMIZED

public static final String STATE_MAXIMIZED

The maximized window state.

PARAM_TITLE

public static final String PARAM_TITLE

The component title key.

Parameter which stores the current title of a given component instance.

PARAM_MODE

public static final String PARAM_MODE

The Component title key.

Parameter which stores the current title of a given component instance.

Method Detail

getUserUUID

public String getUserUUID()

Gets the user UUID.

Returns:

the user UUID.

getPortalID

public String getPortalID()

Gets the portal ID.

Returns:

the portal ID.

getComponentName

public String getComponentName()

Gets the component name.

Returns:

the component name.

getComponentInstanceIDs

public String[] getComponentInstanceIDs()

Gets the list of component instance identifiers.

Returns:

the list of component instance identifiers.

containsComponentInstance

public boolean containsComponentInstance(String instanceID)

Checks to see whether the information about the specified component instance exists in this EbiUserComponentInfo object.

Parameters:

instanceID - A component instance ID.

Returns:

true if the information about the specified component instance exists, false otherwise.

getState

public String getState(String instanceID)

Gets the state of a component instance.

Parameters:

instanceID - A component instance ID.

Returns:

the state for a component instance.

getStyleID

public String getStyleID(String instanceID)

Gets the styleID of a component instance.

Parameters:

instanceID - A component instance ID.

Returns:

the state for a component instance.

getParameter

public String getParameter(String instanceID,
                           String name)

Gets the value of a specified parameter name for a component instance. You should only use this method if you are sure that there is only one value for this parameter name.

Parameters:

instanceID - A component instance ID.

paramName - A parameter name

Returns:

a value of the specified parameter name.

getParameterNames

public Enumeration getParameterNames(String instanceID)

Gets an enumeration of the parameter names that are defined for a component instance.

Parameters:

instanceID - A component instance ID.

Returns:

an enumeration of the parameter names.

getParameterValues

public String[] getParameterValues(String instanceID,
                                   String name)

Gets a String array of parameter values for a specified parameter and component instance.

Parameters:

instanceID - A component instance ID.

name - A parameter name.

Returns:

a String array of the parameter values.

setUserUUID

public void setUserUUID(String userIID)

Sets the user UUID.

Parameters:

userIID - A user UUID.

setPortalID

public void setPortalID(String portalID)

Sets the portal ID.

Parameters:

portalID - A portal ID.

setComponentName

public void setComponentName(String compName)

Sets the component name.

Parameters:

compName - A component name.

setStyleID

public void setStyleID(String instanceID,
                       String styleID)

Sets the style Identifier for a component instance.

Parameters:

instanceID - A component instance ID.

styleID - A style ID selected for this component instance for the user.

setState

public void setState(String instanceID,
                     String state)

Sets the state for this component instance for the user for a component instance.

Parameters:

instanceID - A component instance ID.

state - A state.

setParameter

public void setParameter(String instanceID,
                         String name,
                         String value)

Sets a value of a specified parameter name.

Parameters:

instanceID - A component instance ID.

name - A parameter name.

value - A parameter value.

removeParameter

public void removeParameter(String instanceID,
                            String param)

Removes a parameter.

Parameters:

instanceID - A component instance ID.

param - A parameter to be removed.

removeComponentInstance

public void removeComponentInstance(String instanceID)

Removes a component instance.

Parameters:

instanceID - A component instance ID.