lumis.content.incontextedit

Class ContentServiceInterfaceInContextEdit

java.lang.Object

lumis.content.incontextedit.ContentServiceInterfaceInContextEdit

All Implemented Interfaces:

IServiceInterfaceInContextEdit

public class ContentServiceInterfaceInContextEdit
extends Object
implements IServiceInterfaceInContextEdit

Content implementation for IServiceInterfaceInContextEdit.

Since:

6.0.1

Version:

$Revision: 20808 $ $Date: 2017-11-30 19:13:55 +0000 (Thu, 30 Nov 2017) $

Field Summary

Fields inherited from interface lumis.portal.incontextedit.IServiceInterfaceInContextEdit

LUMIS_INTERFACE_IN_CONTEXT_EDIT_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor and Description
ContentServiceInterfaceInContextEdit()

Method Summary

Modifier and Type	Method and Description
String	getInContextEditMenu(SessionConfig sessionConfig, IURLFactory urlFactory, ServiceInterfaceInstanceConfig interfaceInstance, String detailsLumItemId, ITransaction transaction) Returns in context edit menu XML string for the given service interface instance.
String	getInContextEditMenu(SessionConfig sessionConfig, IURLFactory urlFactory, String lumItemId, String sourcePageId, ITransaction transaction) Returns in context edit menu XML string for the given content (represented by a version's item id).
boolean	isInContextEditEnabled(SessionConfig sessionConfig, ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, ITransaction transaction) Returns whether or not in context edit is enabled for the given service interface instance.
String	processInContextEditContent(ServiceContainerRenderRequest renderRequest, ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, String outputHTML, ITransaction transaction) Process in context edit content related attributes.
boolean	removeInContextEditInterfaceInstance(SessionConfig sessionConfig, IPortalMode portalMode, ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, String html, org.apache.wicket.util.string.AppendingStringBuffer sb, String detailsLumItemId, ITransaction transaction) Removes in context editing interface instance related attributes if needed.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentServiceInterfaceInContextEdit

public ContentServiceInterfaceInContextEdit()

Method Detail

isInContextEditEnabled

public boolean isInContextEditEnabled(SessionConfig sessionConfig,
                                      ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
                                      ITransaction transaction)
                               throws PortalException

Returns whether or not in context edit is enabled for the given service interface instance.

Parameters:

sessionConfig - the session config.

serviceInterfaceInstanceConfig - the service interface isntance config.

transaction - the transaction.

Returns:

whether or not in context edit is enabled for the given service interface instance.

Throws:

PortalException

Since:

6.0.1

getInContextEditMenu

public String getInContextEditMenu(SessionConfig sessionConfig,
                                   IURLFactory urlFactory,
                                   ServiceInterfaceInstanceConfig interfaceInstance,
                                   String detailsLumItemId,
                                   ITransaction transaction)
                            throws PortalException

Description copied from interface: IServiceInterfaceInContextEdit

Returns in context edit menu XML string for the given service interface instance.

Specified by:

getInContextEditMenu in interface IServiceInterfaceInContextEdit

Parameters:

sessionConfig - the session config.

urlFactory - the URL factory to be used during menu generation.

interfaceInstance - the interface instance config.

detailsLumItemId - the lumItemId passed to the source page.

transaction - the transaction.

Returns:

the service interface instance's in context edit menu's XML string.

Throws:

PortalException

getInContextEditMenu

public String getInContextEditMenu(SessionConfig sessionConfig,
                                   IURLFactory urlFactory,
                                   String lumItemId,
                                   String sourcePageId,
                                   ITransaction transaction)
                            throws PortalException

Description copied from interface: IServiceInterfaceInContextEdit

Returns in context edit menu XML string for the given content (represented by a version's item id).

Specified by:

getInContextEditMenu in interface IServiceInterfaceInContextEdit

Parameters:

sessionConfig - the session config.

urlFactory - the URL factory to be used during menu generation.

lumItemId - the item id.

sourcePageId - the source page identifier.

transaction - the transaction.

Returns:

in context edit menu XML string for the given content (represented by a version's item id).

Throws:

PortalException

processInContextEditContent

public String processInContextEditContent(ServiceContainerRenderRequest renderRequest,
                                          ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
                                          String outputHTML,
                                          ITransaction transaction)
                                   throws PortalException

Description copied from interface: IServiceInterfaceInContextEdit

Process in context edit content related attributes.

Specified by:

processInContextEditContent in interface IServiceInterfaceInContextEdit

Parameters:

renderRequest - the request.

serviceInterfaceInstanceConfig - the service interface instance.

outputHTML - the HTML to be processed.

transaction - the transaction.

Returns:

a processed version of HTML.

Throws:

PortalException

removeInContextEditInterfaceInstance

public boolean removeInContextEditInterfaceInstance(SessionConfig sessionConfig,
                                                    IPortalMode portalMode,
                                                    ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
                                                    String html,
                                                    org.apache.wicket.util.string.AppendingStringBuffer sb,
                                                    String detailsLumItemId,
                                                    ITransaction transaction)
                                             throws PortalException

Description copied from interface: IServiceInterfaceInContextEdit

Removes in context editing interface instance related attributes if needed.

Specified by:

removeInContextEditInterfaceInstance in interface IServiceInterfaceInContextEdit

Parameters:

sessionConfig - the session config.

portalMode - the portal mode.

serviceInterfaceInstanceConfig - the interface instance.

html - the HTML to be processed.

sb - the String Buffer to store processed version of HTML.

detailsLumItemId - the lumItemId passed to the details interface (if the interface is details).

transaction - the transaction.

Returns:

A boolean indicating if the interface instance attribute should be added or not. Also, appends in string buffer the processed version of HTML.

Throws:

PortalException