Package lumis.portal.serviceinterface

Interface IServiceInterfaceRenderResponse

All Superinterfaces:

IServiceInterfaceResponse, IURLFactory, MimeResponse, PortletResponse, RenderResponse

All Known Subinterfaces:

IMockServiceInterfaceRenderResponse, IServiceInterfaceRenderResponseSPI

All Known Implementing Classes:

BufferedServiceInterfaceRenderResponseSPI, ChatServiceInterfaceResponse, MockServiceInterfaceRenderResponse, ServiceContainerRenderResponse, ServiceInterfaceRenderResponseSPIWrapper

@StableMinor(version="14.1",
             sinceVersion="7.0")
public interface IServiceInterfaceRenderResponse
extends IServiceInterfaceResponse, RenderResponse

Service interface response for a render action.

Since:

4.0.0

Version:

$Revision: 24683 $ $Date: 2021-08-23 18:55:58 -0300 (Mon, 23 Aug 2021) $

Field Summary

Fields

Modifier and Type	Field	Description
static int	APPLY_STYLE_FROM_DEFINITION
static int	APPLY_STYLE_NONE
static int	APPLY_STYLE_ONLY_IF_NOT_DEFINED
static int	APPLY_STYLE_OVERRIDE

Fields inherited from interface javax.portlet.MimeResponse

CACHE_SCOPE, ETAG, EXPIRATION_CACHE, MARKUP_HEAD_ELEMENT, NAMESPACED_RESPONSE, PRIVATE_SCOPE, PUBLIC_SCOPE, USE_CACHED_CONTENT

Method Summary

Modifier and Type	Method	Description
void	applyStyle(int applyRule, String styleFile)
IServiceInterfaceUrl	createActionURL()	Creates an action URL.
IServiceInterfaceUrl	createRenderURL()	Creates a render URL.
PortalPrintWriter	getBeforeWriter()
PrintWriter	getWriter()
boolean	isCommited()
void	setStyleId(String styleId)

Methods inherited from interface lumis.portal.serviceinterface.IServiceInterfaceResponse

addCookie, deleteCookie

Methods inherited from interface lumis.portal.url.IURLFactory

createPortalURL

Methods inherited from interface javax.portlet.MimeResponse

createResourceURL, flushBuffer, getBufferSize, getCacheControl, getCharacterEncoding, getContentType, getLocale, getPortletOutputStream, isCommitted, reset, resetBuffer, setBufferSize

Methods inherited from interface javax.portlet.PortletResponse

addProperty, addProperty, addProperty, createElement, encodeURL, getNamespace, setProperty

Methods inherited from interface javax.portlet.RenderResponse

setContentType, setNextPossiblePortletModes, setTitle

Field Detail

APPLY_STYLE_NONE

static final int APPLY_STYLE_NONE

See Also:

Constant Field Values

APPLY_STYLE_FROM_DEFINITION

static final int APPLY_STYLE_FROM_DEFINITION

See Also:

Constant Field Values

APPLY_STYLE_ONLY_IF_NOT_DEFINED

static final int APPLY_STYLE_ONLY_IF_NOT_DEFINED

See Also:

Constant Field Values

APPLY_STYLE_OVERRIDE

static final int APPLY_STYLE_OVERRIDE

See Also:

Constant Field Values

Method Detail

getWriter

PrintWriter getWriter()
               throws IOException

Specified by:

getWriter in interface MimeResponse

Throws:

IOException

getBeforeWriter

PortalPrintWriter getBeforeWriter()
                           throws IOException

Throws:

IOException

isCommited

boolean isCommited()

applyStyle

void applyStyle(int applyRule,
                String styleFile)
         throws ServiceException,
                PortalException

Throws:

ServiceException

PortalException

setStyleId

void setStyleId(String styleId)
         throws ServiceException,
                PortalException

Throws:

ServiceException

PortalException

createActionURL

IServiceInterfaceUrl createActionURL()

Description copied from interface: IURLFactory

Creates an action URL.

Specified by:

createActionURL in interface IURLFactory

Specified by:

createActionURL in interface MimeResponse

Returns:

the URL object.

See Also:

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

createRenderURL

IServiceInterfaceUrl createRenderURL()

Description copied from interface: IURLFactory

Creates a render URL.

Specified by:

createRenderURL in interface IURLFactory

Specified by:

createRenderURL in interface MimeResponse

Returns:

the URL object.

See Also:

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