org.osivia.portal.api.editor

Interface EditorService

public interface EditorService

Editor service interface.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	MBEAN_NAME MBean name.
static String	WINDOW_PROPERTY_PREFIX Window property prefix.

Method Summary

Modifier and Type	Method and Description
void	addTemporaryAttachedPicture(PortalControllerContext portalControllerContext, String path, EditorTemporaryAttachedPicture picture) Add temporary attached picture.
void	clearAllTemporaryAttachedPictures(javax.servlet.http.HttpSession httpSession) Clear all temporary attached pictures.
void	clearTemporaryAttachedPictures(PortalControllerContext portalControllerContext, String path) Clear temporary attached pictures.
List<EditorModule>	getModules(PortalControllerContext portalControllerContext) Get modules.
List<EditorTemporaryAttachedPicture>	getTemporaryAttachedPictures(PortalControllerContext portalControllerContext, String path) Get temporary attached pictures.
void	serveResource(PortalControllerContext portalControllerContext, String editorId) Serve resource.

Field Detail

MBEAN_NAME

static final String MBEAN_NAME

MBean name.

See Also:

Constant Field Values

WINDOW_PROPERTY_PREFIX

static final String WINDOW_PROPERTY_PREFIX

Window property prefix.

See Also:

Constant Field Values

Method Detail

getModules

List<EditorModule> getModules(PortalControllerContext portalControllerContext)
                       throws PortalException

Get modules.

Parameters:

portalControllerContext - portal controller context

Returns:

modules

Throws:

PortalException

serveResource

void serveResource(PortalControllerContext portalControllerContext,
                   String editorId)
            throws javax.portlet.PortletException,
                   IOException

Serve resource.

Parameters:

portalControllerContext - portal controller context

editorId - editor identifier

Throws:

javax.portlet.PortletException

IOException

getTemporaryAttachedPictures

List<EditorTemporaryAttachedPicture> getTemporaryAttachedPictures(PortalControllerContext portalControllerContext,
                                                                  String path)
                                                           throws PortalException,
                                                                  IOException

Get temporary attached pictures.

Parameters:

portalControllerContext - portal controller context

path - parent document path

Returns:

temporary attached pictures

Throws:

PortalException

IOException

addTemporaryAttachedPicture

void addTemporaryAttachedPicture(PortalControllerContext portalControllerContext,
                                 String path,
                                 EditorTemporaryAttachedPicture picture)
                          throws PortalException,
                                 IOException

Add temporary attached picture.

Parameters:

portalControllerContext - portal controller context

path - parent document path

picture - temporary attached picture

Throws:

PortalException

IOException

clearTemporaryAttachedPictures

void clearTemporaryAttachedPictures(PortalControllerContext portalControllerContext,
                                    String path)
                             throws PortalException,
                                    IOException

Clear temporary attached pictures.

Parameters:

portalControllerContext - portal controller context

path - parent document path

Throws:

PortalException

IOException

clearAllTemporaryAttachedPictures

void clearAllTemporaryAttachedPictures(javax.servlet.http.HttpSession httpSession)
                                throws PortalException

Clear all temporary attached pictures.

Parameters:

httpSession - HTTP session

Throws:

PortalException