org.nuxeo.ecm.platform.picture.web
Interface PictureBookManager

All Known Implementing Classes:

PictureBookManagerBean

public interface PictureBookManager

Provide Creation Book related actions.

Author:

Laurent Doguin

Method Summary

void	addView() Adds the current view to the views ArrayList using viewtitle, description, tag and maxsize.
String	createPictureBook() Creates and saves a Picture Book DocumentModel using views, timeinterval, description and title.
String	downloadAll()
String	downloadSelectedBook()
String	getDescription() Gets the description.
Integer	getMaxsize() Gets the maxsize.
String[]	getSelectedViews()
List<SelectItem>	getSelectItems()
String	getTag() Gets the tag.
Integer	getTimeinterval() Deprecated. The time interval is now handled by the PictureBook layout
String	getTitle() Gets the title.
ArrayList<Map<String,Object>>	getViews() Gets the views.
String	getViewtitle() Gets the viewtitle.
void	initialize()
void	reset()
void	setDescription(String description) Sets the description.
void	setMaxsize(Integer maxsize) Sets the maxsize.
void	setSelectedViews(String[] selectedViews)
void	setSelectItems(List<SelectItem> selectItems)
void	setTag(String tag) Sets the tag.
void	setTimeinterval(Integer timeinterval) Sets the Time Interval.
void	setTitle(String title) Sets the title.
void	setViews(ArrayList<Map<String,Object>> views) Sets the views.
void	setViewtitle(String viewtitle) Sets the viewtitle.

Method Detail

setTimeinterval

void setTimeinterval(Integer timeinterval)

Sets the Time Interval. timeinterval is the time spend before the next picture is displayed in the slideshow in seconds.

Parameters:

timeinterval - an Integer holding the Time Interval

getTimeinterval

@Deprecated
Integer getTimeinterval()

Deprecated. The time interval is now handled by the PictureBook layout

Gets the Time Interval. timeinterval is the time spend before the next picture is displayed in the slideshow in seconds.

Returns:

an Integer holding the Time Interval

setTitle

void setTitle(String title)

Sets the title. This is the title of the PictureBook as defined in the Dublincore schema

Parameters:

title - a String holding the title

getTitle

String getTitle()

Gets the title. This is the title of the PictureBook as defined in the Dublincore schema.

Returns:

a String holding the title

getViews

ArrayList<Map<String,Object>> getViews()

Gets the views. The views are Map that contains different information about each type of picture you might want. It has the 3 default following views: Original View, Medium View, used for the slideShow Thumbnail View, used For the PictureBook.

Returns:

an ArrayList of Map holding the views

setViews

void setViews(ArrayList<Map<String,Object>> views)

Sets the views. The views are Map that contains different information about each type of picture you might want. It has the 3 default following views: Original View, Medium View, used for the slideShow Thumbnail View, used For the PictureBook

Parameters:

views - an ArrayList of Map holding the views

setViewtitle

void setViewtitle(String viewtitle)

Sets the viewtitle. viewtitle is the property title of a view. For example the default title For the Original view is 'Original'.

Parameters:

viewtitle - a String holding the title of a view

getViewtitle

String getViewtitle()

Gets the viewtitle. viewtitle is the property title of a view. For example the default title For the Original view is 'Original'

Returns:

a String holding the title of a view.

setDescription

void setDescription(String description)

Sets the description. description is a property of a view.

Parameters:

description - a String holding the description

getDescription

String getDescription()

Gets the description. description is a property of a view.

Returns:

a String holding the description

setTag

void setTag(String tag)

Sets the tag. tag is a property of a view.

Parameters:

tag - a String holding the tag

getTag

String getTag()

Gets the tag. tag is a property of a view.

Returns:

a String holding the description

setMaxsize

void setMaxsize(Integer maxsize)

Sets the maxsize. maxsize is a property of a view. Maximum size of the longest side of a picture. It is used to create the file of a view.

Parameters:

maxsize - an Integer holding the maximum size

getMaxsize

Integer getMaxsize()

Gets the maxsize. maxsize is a property of a view. Maximum size of the longest side of a picture. It is used to create the file of a view.

Returns:

an Integer holding the maximum size

addView

void addView()

Adds the current view to the views ArrayList using viewtitle, description, tag and maxsize.

createPictureBook

String createPictureBook()
                         throws Exception

Creates and saves a Picture Book DocumentModel using views, timeinterval, description and title.

Throws:

Exception

reset

void reset()
           throws ClientException

Throws:

ClientException

initialize

void initialize()
                throws Exception

Throws:

Exception

downloadSelectedBook

String downloadSelectedBook()
                            throws ClientException,
                                   IOException

Throws:

ClientException

IOException

downloadAll

String downloadAll()
                   throws ClientException,
                          IOException

Throws:

ClientException

IOException

getSelectItems

List<SelectItem> getSelectItems()
                                throws ClientException

Throws:

ClientException

setSelectItems

void setSelectItems(List<SelectItem> selectItems)

getSelectedViews

String[] getSelectedViews()

setSelectedViews

void setSelectedViews(String[] selectedViews)