org.osivia.services.editor.image.portlet.service

Interface EditorImageService

All Superinterfaces:

CommonService

All Known Implementing Classes:

EditorImageServiceImpl

public interface EditorImageService
extends CommonService

Editor image portlet service interface.

Author:

Cédric Krommenhoek

See Also:

CommonService

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALT_PARAMETER Alternate text parameter.
static String	ALT_WINDOW_PROPERTY Alternate text window property.
static String	HEIGHT_PARAMETER Height parameter.
static String	HEIGHT_WINDOW_PROPERTY Height window property.
static String	PORTLET_INSTANCE Portlet instance.
static String	SRC_PARAMETER Source URL parameter.
static String	SRC_WINDOW_PROPERTY Source URL window property.
static String	WIDTH_PARAMETER Width parameter.
static String	WIDTH_WINDOW_PROPERTY Width 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
void	addAttachedImage(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, EditorImageSourceAttachedForm attachedForm) Add attached image.
void	deleteAttachedImage(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, EditorImageSourceAttachedForm attachedForm, int index) Delete attached image.
void	filterDocuments(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, EditorImageSourceDocumentForm documentForm) Filter documents.
EditorImageSourceAttachedForm	getAttachedForm(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get attached image form.
EditorImageSourceDocumentForm	getDocumentForm(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get image document form.
EditorImageForm	getForm(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get form.
void	save(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, EditorImageForm form) Save.
void	selectAttachedImage(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, EditorImageSourceAttachedForm attachedForm, int index) Select attached image.
void	selectDocument(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String path) Select image document.
void	serveImagePreview(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Serve image preview.
void	serveSearchResults(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String filter, String scope) Serve search results.

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

resolveViewPath

Field Detail

PORTLET_INSTANCE

static final String PORTLET_INSTANCE

Portlet instance.

See Also:

Constant Field Values

SRC_PARAMETER

static final String SRC_PARAMETER

Source URL parameter.

See Also:

Constant Field Values

SRC_WINDOW_PROPERTY

static final String SRC_WINDOW_PROPERTY

Source URL window property.

See Also:

Constant Field Values

ALT_PARAMETER

static final String ALT_PARAMETER

Alternate text parameter.

See Also:

Constant Field Values

ALT_WINDOW_PROPERTY

static final String ALT_WINDOW_PROPERTY

Alternate text window property.

See Also:

Constant Field Values

HEIGHT_PARAMETER

static final String HEIGHT_PARAMETER

Height parameter.

See Also:

Constant Field Values

HEIGHT_WINDOW_PROPERTY

static final String HEIGHT_WINDOW_PROPERTY

Height window property.

See Also:

Constant Field Values

WIDTH_PARAMETER

static final String WIDTH_PARAMETER

Width parameter.

See Also:

Constant Field Values

WIDTH_WINDOW_PROPERTY

static final String WIDTH_WINDOW_PROPERTY

Width window property.

See Also:

Constant Field Values

Method Detail

getForm

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

Get form.

Parameters:

portalControllerContext - portal controller context

Returns:

form

Throws:

javax.portlet.PortletException

save

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

Save.

Parameters:

portalControllerContext - portal controller context

form - form

Throws:

javax.portlet.PortletException

getAttachedForm

EditorImageSourceAttachedForm getAttachedForm(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                                       throws javax.portlet.PortletException

Get attached image form.

Parameters:

portalControllerContext - portal controller context

Returns:

attached image form

Throws:

javax.portlet.PortletException

addAttachedImage

void addAttachedImage(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                      EditorImageSourceAttachedForm attachedForm)
               throws javax.portlet.PortletException,
                      IOException

Add attached image.

Parameters:

portalControllerContext - portal controller context

attachedForm - attached image form

Throws:

javax.portlet.PortletException

IOException

selectAttachedImage

void selectAttachedImage(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                         EditorImageSourceAttachedForm attachedForm,
                         int index)
                  throws javax.portlet.PortletException

Select attached image.

Parameters:

portalControllerContext - portal controller context

attachedForm - attached image form

index - attached image index

Throws:

javax.portlet.PortletException

deleteAttachedImage

void deleteAttachedImage(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                         EditorImageSourceAttachedForm attachedForm,
                         int index)
                  throws javax.portlet.PortletException

Delete attached image.

Parameters:

portalControllerContext - portal controller context

attachedForm - attached image form

index - attached image index

Throws:

javax.portlet.PortletException

getDocumentForm

EditorImageSourceDocumentForm getDocumentForm(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                                       throws javax.portlet.PortletException

Get image document form.

Parameters:

portalControllerContext - portal controller context

Returns:

image document form

Throws:

javax.portlet.PortletException

filterDocuments

void filterDocuments(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                     EditorImageSourceDocumentForm documentForm)
              throws javax.portlet.PortletException

Filter documents.

Parameters:

portalControllerContext - portal controller context

documentForm - image document 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

Select image document.

Parameters:

portalControllerContext - portal controller context

path - document path

Throws:

javax.portlet.PortletException

serveImagePreview

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

Serve image preview.

Parameters:

portalControllerContext - portal controller context

Throws:

javax.portlet.PortletException

IOException