Package lumis.portal.hyperlink

Interface IHyperLinkManager

All Known Implementing Classes:

HyperLinkManager

@StableMinor(version="14.0",
             sinceVersion="4.0")
public interface IHyperLinkManager

Provides hyperlink related operations.

Since:

4.0.0

Version:

$Revision: 24477 $ $Date: 2021-04-28 11:30:36 -0300 (Wed, 28 Apr 2021) $

See Also:

lumis.portal.hyperlink

Method Summary

Modifier and Type	Method	Description
String	getHyperlinkServiceId(SessionConfig sessionConfig, HyperLinkConfig hyperLinkConfig, ITransaction transaction)	Returns the id of the service related to the given hyperlink.
IServiceInterfaceUrl	getUrl(SessionConfig sessionConfig, HyperLinkConfig hyperLinkConfig, ITransaction transaction)	Returns the URL corresponding to the information contained in the given HyperlinkConfig.
String	getXmlString(SessionConfig sessionConfig, Node hyperLinkNode, String serviceId, String serviceInstanceId, String sourcePageId, ITransaction transaction)	Deprecated. This method may be removed in the future.

Method Detail

getUrl

IServiceInterfaceUrl getUrl(SessionConfig sessionConfig,
                            HyperLinkConfig hyperLinkConfig,
                            ITransaction transaction)
                     throws ManagerException,
                            PortalException

Returns the URL corresponding to the information contained in the given HyperlinkConfig.

Parameters:

sessionConfig - the user session information.

hyperLinkConfig - contains the hyperlink information to be used.

transaction - the transaction for persistence access.

Returns:

Returns the corresponding url, or null if it could not be resolved.

Throws:

ManagerException

PortalException

See Also:

lumis.portal.hyperlink

getXmlString

@Deprecated
String getXmlString(SessionConfig sessionConfig,
                    Node hyperLinkNode,
                    String serviceId,
                    String serviceInstanceId,
                    String sourcePageId,
                    ITransaction transaction)
             throws ManagerException,
                    PortalException

Deprecated.

This method may be removed in the future.

Get the XML string of the hyperlink.

Parameters:

sessionConfig -

hyperLinkNode -

serviceId -

serviceInstanceId -

sourcePageId -

transaction -

Returns:

Returns a String.

Throws:

ManagerException

PortalException

getHyperlinkServiceId

String getHyperlinkServiceId(SessionConfig sessionConfig,
                             HyperLinkConfig hyperLinkConfig,
                             ITransaction transaction)
                      throws ManagerException,
                             PortalException

Returns the id of the service related to the given hyperlink.

If the service id is not explicitly defined in the hyperLinkConfig, other defined ids are analyzed to infer the corresponding service.

Parameters:

sessionConfig - the user session information.

hyperLinkConfig - contains the hyperlink information to be used.

transaction - the transaction for persistence access.

Returns:

the service id, or null if it could not be inferred.

Throws:

ManagerException

PortalException

Since:

4.0.10