org.osivia.services.editor.common.service

Interface CommonService

All Known Subinterfaces:

EditorImageService, EditorLinkService, EditorPluginService

All Known Implementing Classes:

CommonServiceImpl, EditorImageServiceImpl, EditorLinkServiceImpl, EditorPluginServiceImpl

public interface CommonService

Portlet common service interface.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	BASE_PATH_WINDOW_PROPERTY Base path window property.
static String	PATH_WINDOW_PROPERTY Current document path window property.

Method Summary

Modifier and Type	Method and Description
SourceDocumentForm	getSourceDocumentForm(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get source document form.
String	resolveViewPath(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String name) Resolve view path.
void	selectDocument(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String path) Select document.
void	serveSearchResults(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String filter, String scope) Serve search results.

Field Detail

BASE_PATH_WINDOW_PROPERTY

static final String BASE_PATH_WINDOW_PROPERTY

Base path window property.

See Also:

Constant Field Values

PATH_WINDOW_PROPERTY

static final String PATH_WINDOW_PROPERTY

Current document path window property.

See Also:

Constant Field Values

Method Detail

resolveViewPath

String resolveViewPath(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                       String name)
                throws javax.portlet.PortletException

Resolve view path.

Parameters:

portalControllerContext - portal controller context

name - view name

Returns:

path

Throws:

javax.portlet.PortletException

getSourceDocumentForm

SourceDocumentForm getSourceDocumentForm(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                                  throws javax.portlet.PortletException

Get source document form.

Parameters:

portalControllerContext - portal controller context

Returns:

form

Throws:

javax.portlet.PortletException

serveSearchResults

void serveSearchResults(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                        String filter,
                        String scope)
                 throws javax.portlet.PortletException,
                        IOException

Serve search results.

Parameters:

portalControllerContext - portal controller context

filter - search filter

scope - search scope

Throws:

javax.portlet.PortletException

IOException

selectDocument

void selectDocument(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                    String path)
             throws javax.portlet.PortletException,
                    IOException

Select document.

Parameters:

portalControllerContext - portal controller context

path - document path

Throws:

javax.portlet.PortletException

IOException