org.osivia.services.editor.image.portlet.repository

Interface EditorImageRepository

All Superinterfaces:

CommonRepository

All Known Implementing Classes:

EditorImageRepositoryImpl

public interface EditorImageRepository
extends CommonRepository

Editor image portlet repository interface.

Author:

Cédric Krommenhoek

See Also:

CommonRepository

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTACHED_IMAGE_URL_PREFIX Attached image URL prefix.
static String	ATTACHED_IMAGES_PROPERTY Attached images document property.

Fields inherited from interface org.osivia.services.editor.common.repository.CommonRepository

DOCUMENT_URL_PREFIX, WEB_ID_PROPERTY

Method Summary

Modifier and Type	Method and Description
void	addAttachedImage(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String path, File temporaryFile, String fileName, String contentType) Add attached image.
void	copyAttachedImage(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String sourcePath, String targetPath) Copy attached image.
void	deleteAttachedImage(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String path, int index) Delete attached image.
org.osivia.portal.core.cms.CMSBinaryContent	getAttachedImagePreviewBinaryContent(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, int index) Get attached image preview binary content.
SortedSet<AttachedImage>	getAttachedImages(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String path) Get attached images.
String	getAttachedImageUrl(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, int index, String fileName) Get attached image URL.
String	getCurrentPath(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get current path.
org.osivia.portal.core.cms.CMSBinaryContent	getImageDocumentPreviewBinaryContent(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String webId, String content) Get image document preview binary content.
org.osivia.portal.core.cms.CMSBinaryContent	getSourcePreviewBinaryContent(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String path) Get source preview binary content.

Methods inherited from interface org.osivia.services.editor.common.repository.CommonRepository

getDocument, searchDocuments

Field Detail

ATTACHED_IMAGES_PROPERTY

static final String ATTACHED_IMAGES_PROPERTY

Attached images document property.

See Also:

Constant Field Values

ATTACHED_IMAGE_URL_PREFIX

static final String ATTACHED_IMAGE_URL_PREFIX

Attached image URL prefix.

See Also:

Constant Field Values

Method Detail

getAttachedImages

SortedSet<AttachedImage> getAttachedImages(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                                           String path)
                                    throws javax.portlet.PortletException

Get attached images.

Parameters:

portalControllerContext - portal controller context

path - document path

Returns:

attached images

Throws:

javax.portlet.PortletException

addAttachedImage

void addAttachedImage(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                      String path,
                      File temporaryFile,
                      String fileName,
                      String contentType)
               throws javax.portlet.PortletException

Add attached image.

Parameters:

portalControllerContext - portal controller context

path - document path

temporaryFile - attached image temporary file

fileName - attached image file name

contentType - attached image content type

Throws:

javax.portlet.PortletException

getAttachedImageUrl

String getAttachedImageUrl(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                           int index,
                           String fileName)
                    throws javax.portlet.PortletException,
                           IOException

Get attached image URL.

Parameters:

portalControllerContext - portal controller context

index - attached image index

fileName - attached image file name

Returns:

URL

Throws:

javax.portlet.PortletException

IOException

deleteAttachedImage

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

Delete attached image.

Parameters:

portalControllerContext - portal controller context

path - document path

index - attached image index

Throws:

javax.portlet.PortletException

copyAttachedImage

void copyAttachedImage(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                       String sourcePath,
                       String targetPath)
                throws javax.portlet.PortletException

Copy attached image.

Parameters:

portalControllerContext - portal controller context

sourcePath - source document path

targetPath - target document path

Throws:

javax.portlet.PortletException

getSourcePreviewBinaryContent

org.osivia.portal.core.cms.CMSBinaryContent getSourcePreviewBinaryContent(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                                                                          String path)
                                                                   throws javax.portlet.PortletException,
                                                                          IOException

Get source preview binary content.

Parameters:

portalControllerContext - portal controller context

path - source path

Returns:

binary content

Throws:

javax.portlet.PortletException

IOException

getImageDocumentPreviewBinaryContent

org.osivia.portal.core.cms.CMSBinaryContent getImageDocumentPreviewBinaryContent(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                                                                                 String webId,
                                                                                 String content)
                                                                          throws javax.portlet.PortletException

Get image document preview binary content.

Parameters:

portalControllerContext - portal controller context

webId - image webId

content - image content

Returns:

binary content

Throws:

javax.portlet.PortletException

getAttachedImagePreviewBinaryContent

org.osivia.portal.core.cms.CMSBinaryContent getAttachedImagePreviewBinaryContent(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                                                                                 int index)
                                                                          throws javax.portlet.PortletException

Get attached image preview binary content.

Parameters:

portalControllerContext - portal controller context

index - attached image index

Returns:

binary content

Throws:

javax.portlet.PortletException

getCurrentPath

String getCurrentPath(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
               throws javax.portlet.PortletException

Get current path.

Parameters:

portalControllerContext - portal controller context

Returns:

path

Throws:

javax.portlet.PortletException