Package 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$ $Date$

    • Field Detail

      • LUMIS_INTERFACE_IN_CONTEXT_EDIT_ATTRIBUTE_NAME

        static final java.lang.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

        java.lang.String getInContextEditMenu​(SessionConfig sessionConfig,
                                      IURLFactory urlFactory,
                                      ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
                                      java.lang.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

        java.lang.String getInContextEditMenu​(SessionConfig sessionConfig,
                                      IURLFactory urlFactory,
                                      java.lang.String itemId,
                                      java.lang.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

        java.lang.String processInContextEditContent​(ServiceContainerRenderRequest renderRequest,
                                             ServiceInterfaceInstanceConfig serviceInterfaceInstanceConfig,
                                             java.lang.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,
                                             java.lang.String html,
                                             org.apache.wicket.util.string.AppendingStringBuffer sb,
                                             java.lang.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