lumis.portal.url

Interface IURLFactory

All Known Subinterfaces:

IMockServiceInterfaceActionResponse, IMockServiceInterfaceRenderResponse, IMockServiceInterfaceResponse, IServiceInterfaceActionResponse, IServiceInterfaceActionResponseSPI, IServiceInterfaceRenderResponse, IServiceInterfaceRenderResponseSPI, IServiceInterfaceResponse

All Known Implementing Classes:

BufferedServiceInterfaceRenderResponseSPI, ChatServiceInterfaceResponse, MockServiceInterfaceActionResponse, MockServiceInterfaceRenderResponse, ServiceContainerActionResponse, ServiceContainerRenderResponse, ServiceContainerResponse, ServiceInterfaceRenderResponseSPIWrapper

@StableMinor(version="12.5",
             sinceVersion="5.0")
public interface IURLFactory

Interface implemented by classes able to generate Portal URL objects.

Since:

5.5.0

Version:

$Revision: 24140 $ $Date: 2020-09-14 21:50:42 +0000 (Mon, 14 Sep 2020) $

Method Summary

Modifier and Type	Method and Description
IServiceInterfaceUrl	createActionURL() Creates an action URL.
IServiceInterfaceUrl	createPortalURL() Creates a URL for accessing a portal page.
IServiceInterfaceUrl	createRenderURL() Creates a render URL.

Method Detail

createActionURL

IServiceInterfaceUrl createActionURL()

Creates an action URL.

Returns:

the URL object.

Since:

5.5.0

See Also:

IServiceInterface.processAction(lumis.portal.serviceinterface.IServiceInterfaceActionRequest, lumis.portal.serviceinterface.IServiceInterfaceActionResponse)

createRenderURL

IServiceInterfaceUrl createRenderURL()

Creates a render URL.

Returns:

the URL object.

Since:

5.5.0

See Also:

IServiceInterface.render(lumis.portal.serviceinterface.IServiceInterfaceRenderRequest, lumis.portal.serviceinterface.IServiceInterfaceRenderResponse)

createPortalURL

IServiceInterfaceUrl createPortalURL()

Creates a URL for accessing a portal page.

The returned URL object will not have its destination specified, so it will refer to the portal home by default. Its methods may be used to specify the URL destination.

Returns:

the URL object.

Since:

5.5.0

See Also:

IServiceInterfaceUrl.setPageId(String), IServiceInterfaceUrl.setChannelId(String)