org.osivia.services.editor.link.portlet.service

Interface EditorLinkService

All Superinterfaces:

CommonService

All Known Implementing Classes:

EditorLinkServiceImpl

public interface EditorLinkService
extends CommonService

Editor link portlet service interface.

Author:

Cédric Krommenhoek

See Also:

CommonService

Field Summary

Fields

Modifier and Type	Field and Description
static String	ONLY_TEXT_PARAMETER Only text indicator parameter.
static String	ONLY_TEXT_WINDOW_PROPERTY Only text indicator window property.
static String	PORTLET_INSTANCE Portlet instance.
static String	TEXT_PARAMETER Text parameter.
static String	TEXT_WINDOW_PROPERTY Text window property.
static String	TITLE_PARAMETER Title parameter.
static String	TITLE_WINDOW_PROPERTY Title window property.
static String	URL_PARAMETER URL parameter.
static String	URL_WINDOW_PROPERTY URL window property.

Fields inherited from interface org.osivia.services.editor.common.service.CommonService

BASE_PATH_WINDOW_PROPERTY, PATH_WINDOW_PROPERTY

Method Summary

Modifier and Type	Method and Description
List<FilterType>	getFilterTypes(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get filter types.
EditorLinkForm	getForm(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get editor link form.
List<UrlType>	getUrlTypes(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get URL types.
String	resolveViewPath(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String name) Resolve view path.
void	save(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, EditorLinkForm form) Save editor link form.
net.sf.json.JSONObject	searchDocuments(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String filter, int page) Search documents.
void	unlink(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, EditorLinkForm form) Unlink.

Field Detail

PORTLET_INSTANCE

static final String PORTLET_INSTANCE

Portlet instance.

See Also:

Constant Field Values

URL_PARAMETER

static final String URL_PARAMETER

URL parameter.

See Also:

Constant Field Values

URL_WINDOW_PROPERTY

static final String URL_WINDOW_PROPERTY

URL window property.

See Also:

Constant Field Values

TEXT_PARAMETER

static final String TEXT_PARAMETER

Text parameter.

See Also:

Constant Field Values

TEXT_WINDOW_PROPERTY

static final String TEXT_WINDOW_PROPERTY

Text window property.

See Also:

Constant Field Values

TITLE_PARAMETER

static final String TITLE_PARAMETER

Title parameter.

See Also:

Constant Field Values

TITLE_WINDOW_PROPERTY

static final String TITLE_WINDOW_PROPERTY

Title window property.

See Also:

Constant Field Values

ONLY_TEXT_PARAMETER

static final String ONLY_TEXT_PARAMETER

Only text indicator parameter.

See Also:

Constant Field Values

ONLY_TEXT_WINDOW_PROPERTY

static final String ONLY_TEXT_WINDOW_PROPERTY

Only text indicator window property.

See Also:

Constant Field Values

Method Detail

save

void save(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
          EditorLinkForm form)
   throws javax.portlet.PortletException

Save editor link form.

Parameters:

portalControllerContext - portal controller context

form - editor link form

Throws:

javax.portlet.PortletException

unlink

void unlink(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
            EditorLinkForm form)
     throws javax.portlet.PortletException

Unlink.

Parameters:

portalControllerContext - portal controller context

form - editor link form

Throws:

javax.portlet.PortletException

searchDocuments

net.sf.json.JSONObject searchDocuments(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                                       String filter,
                                       int page)
                                throws javax.portlet.PortletException

Search documents.

Parameters:

portalControllerContext - portal controller context

filter - search filter

page - search pagination page number

Returns:

search result JSON object

Throws:

javax.portlet.PortletException

getForm

EditorLinkForm getForm(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                throws javax.portlet.PortletException

Get editor link form.

Parameters:

portalControllerContext - portal controller context

Returns:

editor link form

Throws:

javax.portlet.PortletException

getUrlTypes

List<UrlType> getUrlTypes(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                   throws javax.portlet.PortletException

Get URL types.

Parameters:

portalControllerContext - portal controller context

Returns:

URL types

Throws:

javax.portlet.PortletException

getFilterTypes

List<FilterType> getFilterTypes(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                         throws javax.portlet.PortletException,
                                IOException

Get filter types.

Parameters:

portalControllerContext - portal controller context

Returns:

filter types

Throws:

javax.portlet.PortletException

IOException

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