Package lumis.portal.serviceinterfaceinstance

Class ServiceInterfaceRenderResultResponse

java.lang.Object

lumis.portal.serviceinterfaceinstance.ServiceInterfaceRenderResultResponse

All Implemented Interfaces:

IServiceInterfaceBaseRenderResponse, IServiceInterfaceRenderResultResponse, IURLFactory

public class ServiceInterfaceRenderResultResponse
extends java.lang.Object
implements IServiceInterfaceRenderResultResponse

A delegate to a ServiceContainerRenderResponse that stores the rendered string to support returning and changing it.

Since:

17.1.0

Constructor Summary

Constructors

Constructor	Description
ServiceInterfaceRenderResultResponse(ServiceContainerRenderResponse renderResponse)

Method Summary

Modifier and Type	Method	Description
void	addCookie(javax.servlet.http.Cookie cookie)
IServiceInterfaceUrl	createActionURL()	Creates an action URL.
IServiceInterfaceUrl	createPortalURL()	Creates a URL for accessing a portal page.
IServiceInterfaceUrl	createRenderURL()	Creates a render URL.
void	deleteCookie(javax.servlet.http.Cookie cookie)
java.lang.String	encodeURL(java.lang.String path)	Returns the encoded URL of the resource, like servlets, JSPs, images and other static files, at the given path.
PortalPrintWriter	getBeforeWriter()
java.lang.String	getNamespace()	The value returned by this method should be prefixed or appended to elements, such as JavaScript variables or function names, to ensure they are unique in the context of the portal page.
java.lang.String	getRenderString()	Returns the rendered string.
boolean	isCommited()
IServiceInterfaceRenderResultResponse	setRenderString(java.lang.String renderString)	Sets the rendered string.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServiceInterfaceRenderResultResponse

public ServiceInterfaceRenderResultResponse(ServiceContainerRenderResponse renderResponse)

Method Detail

getRenderString

public java.lang.String getRenderString()

Description copied from interface: IServiceInterfaceRenderResultResponse

Returns the rendered string.

Specified by:

getRenderString in interface IServiceInterfaceRenderResultResponse

Returns:

the rendered string

setRenderString

public IServiceInterfaceRenderResultResponse setRenderString(java.lang.String renderString)

Description copied from interface: IServiceInterfaceRenderResultResponse

Sets the rendered string.

Specified by:

setRenderString in interface IServiceInterfaceRenderResultResponse

Parameters:

renderString - the rendered string

Returns:

this response object

getBeforeWriter

public PortalPrintWriter getBeforeWriter()
                                  throws java.io.IOException

Specified by:

getBeforeWriter in interface IServiceInterfaceBaseRenderResponse

Throws:

java.io.IOException

isCommited

public boolean isCommited()

Specified by:

isCommited in interface IServiceInterfaceBaseRenderResponse

createActionURL

public IServiceInterfaceUrl createActionURL()

Description copied from interface: IURLFactory

Creates an action URL.

Specified by:

createActionURL in interface IURLFactory

Returns:

the URL object.

See Also:

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

createRenderURL

public IServiceInterfaceUrl createRenderURL()

Description copied from interface: IURLFactory

Creates a render URL.

Specified by:

createRenderURL in interface IURLFactory

Returns:

the URL object.

See Also:

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

addCookie

public void addCookie(javax.servlet.http.Cookie cookie)

Specified by:

addCookie in interface IServiceInterfaceBaseRenderResponse

deleteCookie

public void deleteCookie(javax.servlet.http.Cookie cookie)

Specified by:

deleteCookie in interface IServiceInterfaceBaseRenderResponse

encodeURL

public java.lang.String encodeURL(java.lang.String path)

Description copied from interface: IServiceInterfaceBaseRenderResponse

Returns the encoded URL of the resource, like servlets, JSPs, images and other static files, at the given path.

Portlets should encode all resource URLs pointing to resources in the portlet application via this method in order to ensure that they get served via the portal application.

Some portal/portlet-container implementation may require those URLs to contain implementation specific data encoded in it. Because of that, portlets should use this method to create such URLs.

The encodeURL method may include the session ID and other portal/portlet-container specific information into the URL. If encoding is not needed, it returns the URL unchanged.

Portlet developer should be aware that the returned URL might not be a well formed URL but a special token at the time the portlet is generating its content. Thus portlets should not add additional parameters on the resulting URL or expect to be able to parse the URL. As a result, the outcome of the encodeURL call may be different than calling encodeURL in the servlet world.

Specified by:

encodeURL in interface IServiceInterfaceBaseRenderResponse

Parameters:

path - the URI path to the resource. This must be either an absolute URL (e.g. http://my.co/myportal/mywebap/myfolder/myresource.gif) or a full path URI (e.g. /myportal/mywebap/myfolder/myresource.gif).

Returns:

the encoded resource URL as string, may not be a valid URL

getNamespace

public java.lang.String getNamespace()

Description copied from interface: IServiceInterfaceBaseRenderResponse

The value returned by this method should be prefixed or appended to elements, such as JavaScript variables or function names, to ensure they are unique in the context of the portal page.

The namespace value must be constant for the lifetime of the portlet window.

Specified by:

getNamespace in interface IServiceInterfaceBaseRenderResponse

Returns:

the namespace

createPortalURL

public IServiceInterfaceUrl createPortalURL()

Description copied from interface: IURLFactory

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.

Specified by:

createPortalURL in interface IURLFactory

Returns:

the URL object.

See Also:

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