org.osivia.services.edition.portlet.service

Interface DocumentEditionService

All Known Implementing Classes:

DocumentEditionServiceImpl

public interface DocumentEditionService

Document edition portlet service interface.

Author:

Cédric Krommenhoek

Field Summary

Fields

Modifier and Type	Field and Description
static String	DOCUMENT_PATH_WINDOW_PROPERTY Document path window property.
static String	DOCUMENT_TYPE_WINDOW_PROPERTY Document type window property.
static String	EXTRACT_ARCHIVE_WINDOW_PROPERTY Extract archive indicator window property.
static String	FULLSCREEN_WINDOW_PROPERTY Fullscreen indicator window property.
static long	MAX_UPLOAD_SIZE Max upload size.
static String	PARENT_DOCUMENT_PATH_WINDOW_PROPERTY Parent document path window property.
static String	REQUIRED_PRIMARY_MIME_TYPE_WINDOW_PROPERTY Required primary MIME-type window property.

Method Summary

Modifier and Type	Method and Description
void	cancel(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Cancel document edition.
void	deleteAttachment(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, AbstractDocumentEditionForm form, String value) Delete document attachment.
void	deletePicture(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, AbstractDocumentEditionForm form, String pictureType) Delete document picture.
AbstractDocumentEditionForm	getForm(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get document edition form.
DocumentEditionRepository<?>	getRepository(String name) Get portlet repository.
String	getViewPath(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get view path.
DocumentEditionWindowProperties	getWindowProperties(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get window properties.
void	picturePreview(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, AbstractDocumentEditionForm form, String pictureType) Picture preview.
void	restore(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, AbstractDocumentEditionForm form) Restore document file.
void	restoreAttachment(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, AbstractDocumentEditionForm form, String value) Restore attachment.
void	restorePicture(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, AbstractDocumentEditionForm form, String pictureType) Restore document picture.
void	save(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, AbstractDocumentEditionForm form) Save document edition.
void	serveEditor(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String editorId) Serve editor.
void	upload(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, AbstractDocumentEditionForm form) Upload document file.
void	uploadAttachments(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, AbstractDocumentEditionForm form) Upload document attachments.
void	uploadPicture(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, AbstractDocumentEditionForm form, String pictureType) Upload document picture.
void	validate(AbstractDocumentEditionForm form, org.springframework.validation.Errors errors) Validate document edition form.

Field Detail

DOCUMENT_PATH_WINDOW_PROPERTY

static final String DOCUMENT_PATH_WINDOW_PROPERTY

Document path window property.

See Also:

Constant Field Values

PARENT_DOCUMENT_PATH_WINDOW_PROPERTY

static final String PARENT_DOCUMENT_PATH_WINDOW_PROPERTY

Parent document path window property.

See Also:

Constant Field Values

DOCUMENT_TYPE_WINDOW_PROPERTY

static final String DOCUMENT_TYPE_WINDOW_PROPERTY

Document type window property.

See Also:

Constant Field Values

REQUIRED_PRIMARY_MIME_TYPE_WINDOW_PROPERTY

static final String REQUIRED_PRIMARY_MIME_TYPE_WINDOW_PROPERTY

Required primary MIME-type window property.

See Also:

Constant Field Values

EXTRACT_ARCHIVE_WINDOW_PROPERTY

static final String EXTRACT_ARCHIVE_WINDOW_PROPERTY

Extract archive indicator window property.

See Also:

Constant Field Values

FULLSCREEN_WINDOW_PROPERTY

static final String FULLSCREEN_WINDOW_PROPERTY

Fullscreen indicator window property.

See Also:

Constant Field Values

MAX_UPLOAD_SIZE

static final long MAX_UPLOAD_SIZE

Max upload size.

Method Detail

getWindowProperties

DocumentEditionWindowProperties getWindowProperties(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
                                             throws javax.portlet.PortletException

Get window properties.

Parameters:

portalControllerContext - portal controller context

Returns:

window properties

Throws:

javax.portlet.PortletException

getForm

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

Get document edition form.

Parameters:

portalControllerContext - portal controller context

Returns:

form

Throws:

javax.portlet.PortletException

IOException

getRepository

DocumentEditionRepository<?> getRepository(String name)

Get portlet repository.

Parameters:

name - repository name

Returns:

repository

getViewPath

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

Get view path.

Parameters:

portalControllerContext - portal controller context

Returns:

view path

Throws:

javax.portlet.PortletException

IOException

upload

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

Upload document file.

Parameters:

portalControllerContext - portal controller context

form - document edition form

Throws:

javax.portlet.PortletException

IOException

restore

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

Restore document file.

Parameters:

portalControllerContext - portal controller context

form - document edition form

Throws:

javax.portlet.PortletException

IOException

uploadAttachments

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

Upload document attachments.

Parameters:

portalControllerContext - portal controller context

form - document edition form

Throws:

javax.portlet.PortletException

IOException

deleteAttachment

void deleteAttachment(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                      AbstractDocumentEditionForm form,
                      String value)
               throws javax.portlet.PortletException,
                      IOException

Delete document attachment.

Parameters:

portalControllerContext - portal controller context

form - document edition form

value - parameter value

Throws:

javax.portlet.PortletException

IOException

restoreAttachment

void restoreAttachment(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                       AbstractDocumentEditionForm form,
                       String value)
                throws javax.portlet.PortletException,
                       IOException

Restore attachment.

Parameters:

portalControllerContext - portal controller context

form - document edition form

value - parameter value

Throws:

javax.portlet.PortletException

IOException

uploadPicture

void uploadPicture(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                   AbstractDocumentEditionForm form,
                   String pictureType)
            throws javax.portlet.PortletException,
                   IOException

Upload document picture.

Parameters:

portalControllerContext - portal controller context

form - document edition form

pictureType - picture type

Throws:

javax.portlet.PortletException

IOException

deletePicture

void deletePicture(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                   AbstractDocumentEditionForm form,
                   String pictureType)
            throws javax.portlet.PortletException,
                   IOException

Delete document picture.

Parameters:

portalControllerContext - portal controller context

form - document edition form

pictureType - picture type

Throws:

javax.portlet.PortletException

IOException

restorePicture

void restorePicture(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                    AbstractDocumentEditionForm form,
                    String pictureType)
             throws javax.portlet.PortletException,
                    IOException

Restore document picture.

Parameters:

portalControllerContext - portal controller context

form - document edition form

pictureType - picture type

Throws:

javax.portlet.PortletException

IOException

validate

void validate(AbstractDocumentEditionForm form,
              org.springframework.validation.Errors errors)

Validate document edition form.

Parameters:

form - document edition form

errors - errors

save

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

Save document edition.

Parameters:

portalControllerContext - portal controller context

form - document edition form

Throws:

javax.portlet.PortletException

IOException

cancel

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

Cancel document edition.

Parameters:

portalControllerContext - portal controller context

Throws:

javax.portlet.PortletException

IOException

picturePreview

void picturePreview(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                    AbstractDocumentEditionForm form,
                    String pictureType)
             throws javax.portlet.PortletException,
                    IOException

Picture preview.

Parameters:

portalControllerContext - portal controller context

form - document edition form

pictureType - picture type

Throws:

javax.portlet.PortletException

IOException

serveEditor

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

Serve editor.

Parameters:

portalControllerContext - portal controller context

editorId - editor identifier

Throws:

javax.portlet.PortletException

IOException