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	PARENT_DOCUMENT_PATH_WINDOW_PROPERTY Parent document path window property.

Method Summary

Modifier and Type	Method and Description
void	cancel(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Cancel document edition.
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	restore(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, AbstractDocumentEditionForm form) Restore document file.
void	save(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, AbstractDocumentEditionForm form) Save document edition.
void	upload(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, AbstractDocumentEditionForm form) Upload document file.

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

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

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