lumis.portal.incontextedit

Interface IServiceInterfaceInContextEdit

All Known Implementing Classes:

ContentServiceInterfaceInContextEdit

public interface IServiceInterfaceInContextEdit

In context edit handler. The implementations are responsible for dealing with in context edit actions.

Since:

6.0.1

Version:

$Revision: 16227 $ $Date: 2014-03-27 13:10:30 +0000 (Thu, 27 Mar 2014) $

Field Summary

Fields

Modifier and Type	Field and Description
static String	LUMIS_INTERFACE_IN_CONTEXT_EDIT_ATTRIBUTE_NAME The interface instance in context edit attribute name;

Method Summary

Modifier and Type	Method and Description
String	getInContextEditMenu(SessionConfig sessionConfig, IURLFactory urlFactory, ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig, String detailsLumItemId, ITransaction transaction) Returns in context edit menu XML string for the given service interface instance.
String	getInContextEditMenu(SessionConfig sessionConfig, IURLFactory urlFactory, String itemId, String sourcePageId, ITransaction transaction) Returns in context edit menu XML string for the given content (represented by a version's item id).
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.

Field Detail

LUMIS_INTERFACE_IN_CONTEXT_EDIT_ATTRIBUTE_NAME

static final String LUMIS_INTERFACE_IN_CONTEXT_EDIT_ATTRIBUTE_NAME

The interface instance in context edit attribute name;

Since:

6.0.1

See Also:

Constant Field Values

Method Detail

getInContextEditMenu

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

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

Parameters:

sessionConfig - the session config.

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

serviceInterfaceInstanceConfig - 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

Since:

6.0.1

getInContextEditMenu

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

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

Parameters:

sessionConfig - the session config.

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

itemId - 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

Since:

6.0.1

processInContextEditContent

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

Process in context edit content related attributes.

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

Since:

6.0.1

removeInContextEditInterfaceInstance

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

Removes in context editing interface instance related attributes if needed.

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

Since:

6.0.1