fr.gouv.education.foad.filebrowser.portlet.service

Interface FileBrowserService

All Known Implementing Classes:

FileBrowserServiceImpl

public interface FileBrowserService

File browser portlet service interface.

Author:

Cédric Krommenhoek

Method Summary

Modifier and Type	Method and Description
void	delete(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, List<String> identifiers) Delete documents.
void	drop(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, List<String> sourceIdentifiers, String targetIdentifier) Drop.
void	duplicate(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String path) Duplicate document.
void	endUpload(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) end upload.
FileBrowserBulkDownloadContent	getBulkDownload(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, List<String> paths) Get bulk download content.
FileBrowserForm	getForm(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Get form.
org.dom4j.Element	getToolbar(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, List<String> indexes, String viewId) Get file browser toolbar DOM element.
FileBrowserView	getView(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, String viewId) Get view.
void	saveView(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, FileBrowserView view) Save view.
void	sortItems(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, FileBrowserForm form, FileBrowserSort sort, boolean alt) Sort file browser items.
void	updateMenubar(org.osivia.portal.api.context.PortalControllerContext portalControllerContext) Update menubar.
void	upload(org.osivia.portal.api.context.PortalControllerContext portalControllerContext, FileBrowserForm form) Upload.

Method Detail

getView

FileBrowserView getView(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                        String viewId)
                 throws javax.portlet.PortletException

Get view.

Parameters:

portalControllerContext - portal controller context

viewId - provided view identifier, may be null

Returns:

view

Throws:

javax.portlet.PortletException

saveView

void saveView(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
              FileBrowserView view)
       throws javax.portlet.PortletException

Save view.

Parameters:

portalControllerContext - portal controller context

view - view

Throws:

javax.portlet.PortletException

getForm

FileBrowserForm 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

sortItems

void sortItems(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
               FileBrowserForm form,
               FileBrowserSort sort,
               boolean alt)
        throws javax.portlet.PortletException

Sort file browser items.

Parameters:

portalControllerContext - portal controller context

form - form

sort - sort

alt - alternative sort indicator

Throws:

javax.portlet.PortletException

getToolbar

org.dom4j.Element getToolbar(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                             List<String> indexes,
                             String viewId)
                      throws javax.portlet.PortletException

Get file browser toolbar DOM element.

Parameters:

portalControllerContext - portal controller context

indexes - selected items indexes

viewId - provided view identifier, may be null

Returns:

DOM element

Throws:

javax.portlet.PortletException

duplicate

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

Duplicate document.

Parameters:

portalControllerContext - portal controller context

path - document path

Throws:

javax.portlet.PortletException

delete

void delete(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
            List<String> identifiers)
     throws javax.portlet.PortletException,
            IOException

Delete documents.

Parameters:

portalControllerContext - portal controller context

identifiers - document identifiers

Throws:

javax.portlet.PortletException

IOException

getBulkDownload

FileBrowserBulkDownloadContent getBulkDownload(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
                                               List<String> paths)
                                        throws javax.portlet.PortletException,
                                               IOException

Get bulk download content.

Parameters:

portalControllerContext - portal controller context

paths - document paths

Returns:

content

Throws:

javax.portlet.PortletException

IOException

drop

void drop(org.osivia.portal.api.context.PortalControllerContext portalControllerContext,
          List<String> sourceIdentifiers,
          String targetIdentifier)
   throws javax.portlet.PortletException

Drop.

Parameters:

portalControllerContext - portal controller context

sourceIdentifiers - source identifiers

targetIdentifier - target identifier

Throws:

javax.portlet.PortletException

upload

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

Upload.

Parameters:

portalControllerContext - portal controller context

form - form

Throws:

javax.portlet.PortletException

IOException

endUpload

void endUpload(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
        throws javax.portlet.PortletException

end upload.

Parameters:

portalControllerContext - portal controller context

form - form

Throws:

javax.portlet.PortletException

IOException

updateMenubar

void updateMenubar(org.osivia.portal.api.context.PortalControllerContext portalControllerContext)
            throws javax.portlet.PortletException

Update menubar.

Parameters:

portalControllerContext - portal controller context

Throws:

javax.portlet.PortletException