lumis.portal.hyperlink
Class HyperLinkConfig

java.lang.Object
  lumis.portal.hyperlink.HyperLinkConfig

All Implemented Interfaces:

Cloneable

@StableMinor(version="6.2",
             sinceVersion="4.0")
public class HyperLinkConfig
extends Object
implements Cloneable

Value class for HyperLink data.

Since:

4.0.0

Constructor Summary

HyperLinkConfig()
Creates a new HyperLinkConfig.

HyperLinkConfig(IServiceInterfaceRequest request, IServiceInterfaceResponse response)
Creates a new HyperLinkConfig, with some properties initialized based on a service interface's request/response.

Method Summary

HyperLinkConfig	clone() Creates a clone of this hyperlink.
String	getDestServiceId()
String	getDestServiceInstanceId()
String	getDestServiceInterfaceId()
String	getDestServiceInterfaceInstanceId()
String	getEntityId()
Map<String,String[]>	getParameterMap()
String	getSourcePageId()
String	getTargetId()
int	getTargetType()
IURLFactory	getURLFactory() Returns the URL factory to be used for creating the HyperLink URL.
String	getWebsite() Deprecated. Since 6.2.0, due to the inclusion of websites feature. The Lumis Portal itself did not use this property. Kept only for backward compatibility.
void	setDestServiceId(String destServiceId)
void	setDestServiceInstanceId(String destServiceInstanceId)
void	setDestServiceInterfaceId(String destServiceInterfaceId)
void	setDestServiceInterfaceInstanceId(String destServiceInterfaceInstanceId)
void	setEntityId(String itemId)
void	setParameterMap(Map<String,String[]> parameterMap)
void	setSourcePageId(String sourcePageId)
void	setTargetId(String targetId)
void	setTargetType(int targetType)
void	setURLFactory(IURLFactory urlFactory) Sets the URL factory to be used to generate the HyperLink URL.
void	setWebsite(String website) Deprecated. Since 6.2.0, due to the inclusion of websites feature. The Lumis Portal itself did not use this property. Kept only for backward compatibility.

Methods inherited from class java.lang.Object

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

Constructor Detail

HyperLinkConfig

public HyperLinkConfig()

Creates a new HyperLinkConfig. If currently responding to a service interface request, consider using HyperLinkConfig(IServiceInterfaceRequest, IServiceInterfaceResponse) instead.

Since:

4.0.0

HyperLinkConfig

public HyperLinkConfig(IServiceInterfaceRequest request,
                       IServiceInterfaceResponse response)

Creates a new HyperLinkConfig, with some properties initialized based on a service interface's request/response.

The following properties are currently being initialized by this constructor:

• setSourcePageId(String): corresponding to the requested page.
• setURLFactory(IURLFactory): the response object is set as the URL factory.
• Information necessary about maintaining page state, if the hyperlink resolves to the same page.

Parameters:

request - the request.

response - the response.

Since:

5.6.0

Method Detail

getURLFactory

public IURLFactory getURLFactory()

Returns the URL factory to be used for creating the HyperLink URL.

Returns:

the URL factory (never null).

Since:

5.5.0

setURLFactory

public void setURLFactory(IURLFactory urlFactory)

Sets the URL factory to be used to generate the HyperLink URL. If not set, a default URL factory implementation will be used.

Parameters:

urlFactory - the URL factory.

Throws:

IllegalArgumentException - if urlFactory is null.

Since:

5.5.0

getDestServiceId

public String getDestServiceId()

Returns:

Returns the destServiceId.

setDestServiceId

public void setDestServiceId(String destServiceId)

Parameters:

destServiceId - The destServiceId to set.

getDestServiceInstanceId

public String getDestServiceInstanceId()

Returns:

Returns the destServiceInstanceId.

setDestServiceInstanceId

public void setDestServiceInstanceId(String destServiceInstanceId)

Parameters:

destServiceInstanceId - The destServiceInstanceId to set.

getDestServiceInterfaceId

public String getDestServiceInterfaceId()

Returns:

Returns the destServiceInterfaceId.

setDestServiceInterfaceId

public void setDestServiceInterfaceId(String destServiceInterfaceId)

Parameters:

destServiceInterfaceId - The destServiceInterfaceId to set.

getDestServiceInterfaceInstanceId

public String getDestServiceInterfaceInstanceId()

Returns:

Returns the destServiceInterfaceInstanceId.

setDestServiceInterfaceInstanceId

public void setDestServiceInterfaceInstanceId(String destServiceInterfaceInstanceId)

Parameters:

destServiceInterfaceInstanceId - The destServiceInterfaceInstanceId to set.

getEntityId

public String getEntityId()

Returns:

Returns the entityId.

setEntityId

public void setEntityId(String itemId)

Parameters:

entityId - The entityId to set.

getSourcePageId

public String getSourcePageId()

Returns:

Returns the sourcePageId.

setSourcePageId

public void setSourcePageId(String sourcePageId)

Parameters:

sourcePageId - The sourcePageId to set.

getWebsite

@Deprecated
public String getWebsite()

Deprecated. Since 6.2.0, due to the inclusion of websites feature. The Lumis Portal itself did not use this property. Kept only for backward compatibility.

Returns:

Returns the website.

setWebsite

@Deprecated
public void setWebsite(String website)

Deprecated. Since 6.2.0, due to the inclusion of websites feature. The Lumis Portal itself did not use this property. Kept only for backward compatibility.

Parameters:

website - The website to set.

getParameterMap

public Map<String,String[]> getParameterMap()

setParameterMap

public void setParameterMap(Map<String,String[]> parameterMap)

getTargetId

public String getTargetId()

setTargetId

public void setTargetId(String targetId)

getTargetType

public int getTargetType()

setTargetType

public void setTargetType(int targetType)

clone

public HyperLinkConfig clone()

Creates a clone of this hyperlink.

Overrides:

clone in class Object

Returns:

the clone.

Since:

4.2.0