Package lumis.portal.hyperlink

Class HyperLinkConfig

  • All Implemented Interfaces:
    java.lang.Cloneable
    @StableMinor(version="17.0",
             sinceVersion="4.0")
public class HyperLinkConfig
extends java.lang.Object
implements java.lang.Cloneable
    Value class for HyperLink data.
    Since:
    4.0.0
    Version:
    $Revision: 26587 $ $Date: 2024-08-26 21:09:17 -0300 (Mon, 26 Aug 2024) $

    • Constructor Detail

      • 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:

        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:
        java.lang.IllegalArgumentException - if urlFactory is null.
        Since:
        5.5.0

      • getDestServiceId

        public java.lang.String getDestServiceId()
        Returns:
        Returns the destServiceId.

      • setDestServiceId

        public void setDestServiceId​(java.lang.String destServiceId)
        Parameters:
        destServiceId - The destServiceId to set.

      • getDestServiceInstanceId

        public java.lang.String getDestServiceInstanceId()
        Returns:
        Returns the destServiceInstanceId.

      • setDestServiceInstanceId

        public void setDestServiceInstanceId​(java.lang.String destServiceInstanceId)
        Parameters:
        destServiceInstanceId - The destServiceInstanceId to set.

      • getDestServiceInterfaceId

        public java.lang.String getDestServiceInterfaceId()
        Returns:
        Returns the destServiceInterfaceId.

      • setDestServiceInterfaceId

        public void setDestServiceInterfaceId​(java.lang.String destServiceInterfaceId)
        Parameters:
        destServiceInterfaceId - The destServiceInterfaceId to set.

      • getDestServiceInterfaceInstanceId

        public java.lang.String getDestServiceInterfaceInstanceId()
        Returns:
        Returns the destServiceInterfaceInstanceId.

      • setDestServiceInterfaceInstanceId

        public void setDestServiceInterfaceInstanceId​(java.lang.String destServiceInterfaceInstanceId)
        Parameters:
        destServiceInterfaceInstanceId - The destServiceInterfaceInstanceId to set.

      • getEntityId

        public java.lang.String getEntityId()
        Returns:
        Returns the entityId.

      • setEntityId

        public void setEntityId​(java.lang.String itemId)
        Parameters:
        entityId - The entityId to set.

      • getSourcePageId

        public java.lang.String getSourcePageId()
        Returns:
        Returns the sourcePageId.

      • setSourcePageId

        public void setSourcePageId​(java.lang.String sourcePageId)
        Parameters:
        sourcePageId - The sourcePageId to set.

      • getWebsite

        @Deprecated
public java.lang.String getWebsite()
        Deprecated.
        Since 6.2.0, due to the inclusion of websites feature. The LumisXP itself did not use this property. Kept only for backward compatibility.
        Returns:
        Returns the website.

      • setWebsite

        @Deprecated
public void setWebsite​(java.lang.String website)
        Deprecated.
        Since 6.2.0, due to the inclusion of websites feature. The LumisXP itself did not use this property. Kept only for backward compatibility.
        Parameters:
        website - The website to set.

      • getParameterMap

        public java.util.Map<java.lang.String,​java.lang.String[]> getParameterMap()

      • setParameterMap

        public void setParameterMap​(java.util.Map<java.lang.String,​java.lang.String[]> parameterMap)

      • getTargetId

        public java.lang.String getTargetId()

      • setTargetId

        public void setTargetId​(java.lang.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 java.lang.Object
        Returns:
        the clone.
        Since:
        4.2.0