com.silverpeas.gallery.control
Class GallerySessionController

java.lang.Object
  com.stratelia.silverpeas.peasCore.AbstractComponentSessionController
      com.silverpeas.gallery.control.GallerySessionController

All Implemented Interfaces:

com.stratelia.silverpeas.peasCore.ComponentSessionController

public final class GallerySessionController
extends com.stratelia.silverpeas.peasCore.AbstractComponentSessionController

Field Summary

Fields inherited from class com.stratelia.silverpeas.peasCore.AbstractComponentSessionController

CHARACTER_ENCODING, context

Constructor Summary

GallerySessionController(com.stratelia.silverpeas.peasCore.MainSessionController mainSessionCtrl, com.stratelia.silverpeas.peasCore.ComponentContext componentContext)
Standard Session Controller Constructeur

Method Summary

void	addMediaToAlbums(String mediaId, String[] albums)
void	addMediaToBasket(String mediaId) Add media identifier given in parameter in basket
Collection<AlbumDetail>	addNbMedia(Collection<AlbumDetail> albums)
String	addOrder()
boolean	addToBasket() Add only photo media inside basket
static GalleryExporter	aGalleryExporter() Gets a new exporter of Kmelia publications.
Boolean	areCommentsEnabled()
void	clearBasket() Clear basket
void	clearListSelected()
void	clearSearchContext()
void	copyAlbum(String albumId)
void	copyMedia(String mediaId)
void	copySelectedMedia(Collection<String> mediaIds)
void	createAlbum(AlbumDetail album)
String	createMedia(MediaDataCreateDelegate delegate) Creating one media (just only one)
void	cutAlbum(String albumId)
void	cutMedia(String mediaId)
void	cutSelectedMedia(Collection<String> mediaIds)
void	deleteAlbum(String albumId)
void	deleteMedia(Collection<String> mediaIds)
void	deleteMedia(String mediaId)
void	deletePhotoFromBasket(String mediaId)
void	deleteSelectedPhotosFromBasket() Only remove selected photo from basket
com.silverpeas.importExport.report.ExportReport	exportAlbum(String albumId, MediaResolution mediaResolution) Export all picture from an album with the given resolution
com.silverpeas.importExport.report.ExportReport	exportSelection(MediaResolution mediaResolution) Export all selected images from basket with the given resolution
AlbumDetail	getAlbum(String albumId)
Collection<String>	getAlbumIdsOf(String mediaId)
AlbumDetail	getAlbumLight(String albumId)
Collection<AlbumDetail>	getAllAlbums()
List<com.silverpeas.comment.model.Comment>	getAllComments(Media media)
Collection<Media>	getAllMedia(AlbumDetail album)
List<Order>	getAllOrders()
List<String>	getBasketMediaIdList()
List<Media>	getBasketMedias()
String	getCharteUrl()
String	getCurrentAlbumId()
String	getCurrentOrderId()
MediaResolution	getDisplayedMediaResolution()
MediaResolution	getImagePreviewSize() Get the resolution preview of images
MediaResolution	getImageResolutionPreview(Media media) Get the resolution preview of the images
int	getIndexOfCurrentPage()
List<Media>	getLastRegisteredMedia()
Collection<String>	getListSelected()
Media	getMedia(String mediaId)
List<MetaData>	getMetaDataKeys()
com.stratelia.webactiv.util.ResourceLocator	getMetadataResources()
int	getNbMediaPerPage()
Media	getNext()
Collection<Media>	getNotVisible()
Order	getOrder(String orderId)
String	getOrderForm()
List<Order>	getOrdersByUser()
com.silverpeas.publicationTemplate.PublicationTemplate	getOrderTemplate(boolean register)
Collection<com.stratelia.webactiv.util.node.model.NodeDetail>	getPath()
Collection<com.stratelia.webactiv.util.node.model.NodeDetail>	getPath(com.stratelia.webactiv.util.node.model.NodePK nodePK)
com.stratelia.silverpeas.pdc.model.SearchContext	getPDCSearchContext()
Media	getPrevious()
org.silverpeas.search.searchEngine.model.QueryDescription	getQuery()
int	getRang()
List<Media>	getRestrictedListMedia()
String	getSearchKeyWord()
List<Media>	getSearchResultListMedia()
boolean	getSelect()
int	getSilverObjectId(String objectId)
Integer	getSlideshowWait()
MediaSort	getSort()
com.silverpeas.publicationTemplate.PublicationTemplate	getTemplate(boolean register)
String	getUrl(String orderId, String mediaId)
String	getWatermarkHD()
String	getWatermarkOther()
String	getXMLFormName()
com.silverpeas.form.DataRecord	getXMLSearchContext()
AlbumDetail	goToAlbum()
AlbumDetail	goToAlbum(String albumId)
String	initAlertUser(String mediaId)
void	initIndex()
boolean	isAccessAuthorized(String orderId)
protected boolean	isAdminOrPublisher(com.stratelia.webactiv.SilverpeasRole userRole)
boolean	isAlbumAdmin(com.stratelia.webactiv.SilverpeasRole userRole, String albumId, String userId)
Boolean	isBasket()
Boolean	isDragAndDropEnabled()
boolean	isExportEnable()
Boolean	isGuest()
Boolean	isMakeWatermark()
boolean	isMediaAdmin(com.stratelia.webactiv.SilverpeasRole userRole, String mediaId, String userId)
Boolean	isOrder()
Boolean	isPrivateSearch()
boolean	isSearchResult()
Boolean	isUsePdc()
Boolean	isViewList()
Boolean	isViewMetadata()
boolean	isViewNotVisible()
AlbumDetail	loadCurrentAlbum()
void	notifyUsers(com.stratelia.silverpeas.notificationManager.NotificationMetaData notifMetaData)
void	paste()
Collection<Media>	search(org.silverpeas.search.searchEngine.model.QueryDescription query)
void	sendAskMedia(String asking)
void	sendAskOrder(String orderId)
void	sendAskOrderUser(String orderId) Send notification to reader to alert him that his order has been processed
void	setCurrentAlbumId(String currentAlbumId)
void	setCurrentOrderId(String orderId)
void	setDisplayedMediaResolution(MediaResolution displayedMediaResolution)
void	setIndexOfCurrentPage(String index)
void	setMediaToAlbums(String mediaId, String[] albums)
void	setPDCSearchContext(com.stratelia.silverpeas.pdc.model.SearchContext context)
void	setQuery(org.silverpeas.search.searchEngine.model.QueryDescription query)
void	setRestrictedListMedia(Collection<Media> restrictedListMedia)
void	setSearchKeyWord(String searchKeyWord)
void	setSearchResult(boolean isSearchResult)
void	setSearchResultListMedia(Collection<Media> searchResultListMedia)
void	setSelect(boolean select)
void	setSort(MediaSort sort)
void	setSortSearch(MediaSort sort)
void	setViewNotVisible(boolean isViewNotVisible)
void	setXMLSearchContext(com.silverpeas.form.DataRecord data)
static void	sortAlbums(List<com.stratelia.webactiv.util.node.model.NodePK> albumPKs)
void	updateAlbum(AlbumDetail album)
void	updateMedia(Media media)
void	updateMediaByUser(Collection<String> mediaIds, MediaDataUpdateDelegate delegate) Updating several media (no file have to be handled)
void	updateMediaByUser(String mediaId, MediaDataUpdateDelegate delegate) Updating one media (just only one)
void	updateOrder(Order order)
void	updateOrderRow(String orderId, String mediaId)

Methods inherited from class com.stratelia.silverpeas.peasCore.AbstractComponentSessionController

addClipboardSelection, clipboardPasteDone, close, getAlertUser, getClipboardCount, getClipboardErrorMessage, getClipboardExceptionError, getClipboardName, getClipboardObjects, getClipboardSelectedObjects, getClipboardSize, getComponentAccessController, getComponentId, getComponentLabel, getComponentName, getComponentParameters, getComponentParameterValue, getComponentParameterValue, getComponentRootName, getComponentUrl, getFavoriteSpace, getGenericPanel, getHighestSilverpeasUserRole, getIcon, getLanguage, getLastResults, getLook, getMultilang, getOrganisationController, getPersonalization, getRSSUrl, getSelection, getServerNameAndPort, getSettings, getSilverpeasUserRoles, getSpaceId, getSpaceLabel, getString, getSubscriptionContext, getUrlEncodedParameter, getUserAccessLevel, getUserAvailComponentIds, getUserAvailSpaceIds, getUserDetail, getUserDetail, getUserId, getUserManageableGroupIds, getUserManageableSpaceIds, getUserRoleLevel, getUserRoles, isAppInMaintenance, isGroupManager, isPasswordChangeAllowed, isSpaceInMaintenance, removeClipboardElement, setAppModeMaintenance, setClipboardError, setClipboardSelectedElement, setComponentRootName, setFavoriteSpaceToMainSessionController, setGenericPanel, setIconFileName, setLastResults, setMultilangFileName, setResourceFileName, setSpaceModeMaintenance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GallerySessionController

public GallerySessionController(com.stratelia.silverpeas.peasCore.MainSessionController mainSessionCtrl,
                                com.stratelia.silverpeas.peasCore.ComponentContext componentContext)

Standard Session Controller Constructeur

Parameters:

mainSessionCtrl - The user's profile

componentContext - The component's profile

See Also:

Method Detail

getLastRegisteredMedia

public List<Media> getLastRegisteredMedia()

getAllComments

public List<com.silverpeas.comment.model.Comment> getAllComments(Media media)

getSilverObjectId

public int getSilverObjectId(String objectId)

goToAlbum

public AlbumDetail goToAlbum()

goToAlbum

public AlbumDetail goToAlbum(String albumId)

loadCurrentAlbum

public AlbumDetail loadCurrentAlbum()

getAlbum

public AlbumDetail getAlbum(String albumId)

getAlbumLight

public AlbumDetail getAlbumLight(String albumId)

getNotVisible

public Collection<Media> getNotVisible()

getAllAlbums

public Collection<AlbumDetail> getAllAlbums()

setMediaToAlbums

public void setMediaToAlbums(String mediaId,
                             String[] albums)

addMediaToAlbums

public void addMediaToAlbums(String mediaId,
                             String[] albums)

createAlbum

public void createAlbum(AlbumDetail album)

updateAlbum

public void updateAlbum(AlbumDetail album)

deleteAlbum

public void deleteAlbum(String albumId)

getMetadataResources

public com.stratelia.webactiv.util.ResourceLocator getMetadataResources()

getMedia

public Media getMedia(String mediaId)

getPrevious

public Media getPrevious()

getNext

public Media getNext()

createMedia

public String createMedia(MediaDataCreateDelegate delegate)

Creating one media (just only one)

Parameters:

delegate -

Returns:

updateMediaByUser

public void updateMediaByUser(String mediaId,
                              MediaDataUpdateDelegate delegate)
                       throws Exception

Updating one media (just only one)

Parameters:

mediaId -

delegate -

Throws:

Exception

updateMediaByUser

public void updateMediaByUser(Collection<String> mediaIds,
                              MediaDataUpdateDelegate delegate)
                       throws Exception

Updating several media (no file have to be handled)

Parameters:

mediaIds -

delegate -

Throws:

Exception

updateMedia

public void updateMedia(Media media)

deleteMedia

public void deleteMedia(String mediaId)

deleteMedia

public void deleteMedia(Collection<String> mediaIds)

getPath

public Collection<com.stratelia.webactiv.util.node.model.NodeDetail> getPath(com.stratelia.webactiv.util.node.model.NodePK nodePK)

getPath

public Collection<com.stratelia.webactiv.util.node.model.NodeDetail> getPath()

getAlbumIdsOf

public Collection<String> getAlbumIdsOf(String mediaId)

getNbMediaPerPage

public int getNbMediaPerPage()

getDisplayedMediaResolution

public MediaResolution getDisplayedMediaResolution()

setDisplayedMediaResolution

public void setDisplayedMediaResolution(MediaResolution displayedMediaResolution)

getSort

public MediaSort getSort()

setSort

public void setSort(MediaSort sort)

setSortSearch

public void setSortSearch(MediaSort sort)

setIndexOfCurrentPage

public void setIndexOfCurrentPage(String index)

getIndexOfCurrentPage

public int getIndexOfCurrentPage()

getCurrentAlbumId

public String getCurrentAlbumId()

setCurrentAlbumId

public void setCurrentAlbumId(String currentAlbumId)

getRang

public int getRang()

isDragAndDropEnabled

public Boolean isDragAndDropEnabled()

isUsePdc

public Boolean isUsePdc()

isViewMetadata

public Boolean isViewMetadata()

isMakeWatermark

public Boolean isMakeWatermark()

getWatermarkHD

public String getWatermarkHD()

getWatermarkOther

public String getWatermarkOther()

isViewList

public Boolean isViewList()

areCommentsEnabled

public Boolean areCommentsEnabled()

getSlideshowWait

public Integer getSlideshowWait()

getXMLFormName

public String getXMLFormName()

initIndex

public void initIndex()

initAlertUser

public String initAlertUser(String mediaId)

search

public Collection<Media> search(org.silverpeas.search.searchEngine.model.QueryDescription query)

sendAskMedia

public void sendAskMedia(String asking)

getListSelected

public Collection<String> getListSelected()

clearListSelected

public void clearListSelected()

getRestrictedListMedia

public List<Media> getRestrictedListMedia()

setRestrictedListMedia

public void setRestrictedListMedia(Collection<Media> restrictedListMedia)

getSearchResultListMedia

public List<Media> getSearchResultListMedia()

setSearchResultListMedia

public void setSearchResultListMedia(Collection<Media> searchResultListMedia)

getSearchKeyWord

public String getSearchKeyWord()

setSearchKeyWord

public void setSearchKeyWord(String searchKeyWord)

getSelect

public boolean getSelect()

setSelect

public void setSelect(boolean select)

isPrivateSearch

public Boolean isPrivateSearch()

isAlbumAdmin

public boolean isAlbumAdmin(com.stratelia.webactiv.SilverpeasRole userRole,
                            String albumId,
                            String userId)

isMediaAdmin

public boolean isMediaAdmin(com.stratelia.webactiv.SilverpeasRole userRole,
                            String mediaId,
                            String userId)

copySelectedMedia

public void copySelectedMedia(Collection<String> mediaIds)
                       throws com.silverpeas.util.clipboard.ClipboardException

Throws:

com.silverpeas.util.clipboard.ClipboardException

cutSelectedMedia

public void cutSelectedMedia(Collection<String> mediaIds)
                      throws com.silverpeas.util.clipboard.ClipboardException

Throws:

com.silverpeas.util.clipboard.ClipboardException

copyMedia

public void copyMedia(String mediaId)
               throws com.silverpeas.util.clipboard.ClipboardException

Throws:

com.silverpeas.util.clipboard.ClipboardException

cutMedia

public void cutMedia(String mediaId)
              throws com.silverpeas.util.clipboard.ClipboardException

Throws:

com.silverpeas.util.clipboard.ClipboardException

copyAlbum

public void copyAlbum(String albumId)
               throws com.silverpeas.util.clipboard.ClipboardException

Throws:

com.silverpeas.util.clipboard.ClipboardException

cutAlbum

public void cutAlbum(String albumId)
              throws com.silverpeas.util.clipboard.ClipboardException

Throws:

com.silverpeas.util.clipboard.ClipboardException

paste

public void paste()
           throws com.silverpeas.util.clipboard.ClipboardException

Throws:

com.silverpeas.util.clipboard.ClipboardException

getAllMedia

public Collection<Media> getAllMedia(AlbumDetail album)

sendAskOrder

public void sendAskOrder(String orderId)

sendAskOrderUser

public void sendAskOrderUser(String orderId)

Send notification to reader to alert him that his order has been processed

Parameters:

orderId - the order identifier

addToBasket

public boolean addToBasket()

Add only photo media inside basket

Returns:

true if selection contains only photo, false else if

addMediaToBasket

public void addMediaToBasket(String mediaId)

Add media identifier given in parameter in basket

Parameters:

mediaId - the media identifier to add

deleteSelectedPhotosFromBasket

public void deleteSelectedPhotosFromBasket()

Only remove selected photo from basket

deletePhotoFromBasket

public void deletePhotoFromBasket(String mediaId)

clearBasket

public void clearBasket()

Clear basket

getBasketMediaIdList

public List<String> getBasketMediaIdList()

getBasketMedias

public List<Media> getBasketMedias()

getOrder

public Order getOrder(String orderId)

getCurrentOrderId

public String getCurrentOrderId()

setCurrentOrderId

public void setCurrentOrderId(String orderId)

addOrder

public String addOrder()

updateOrderRow

public void updateOrderRow(String orderId,
                           String mediaId)

getUrl

public String getUrl(String orderId,
                     String mediaId)

isAccessAuthorized

public boolean isAccessAuthorized(String orderId)

getMetaDataKeys

public List<MetaData> getMetaDataKeys()

updateOrder

public void updateOrder(Order order)

getAllOrders

public List<Order> getAllOrders()

getOrdersByUser

public List<Order> getOrdersByUser()

getOrderForm

public String getOrderForm()

getCharteUrl

public String getCharteUrl()

isBasket

public Boolean isBasket()

isGuest

public Boolean isGuest()

isOrder

public Boolean isOrder()

isViewNotVisible

public boolean isViewNotVisible()

isExportEnable

public boolean isExportEnable()

setViewNotVisible

public void setViewNotVisible(boolean isViewNotVisible)

isSearchResult

public boolean isSearchResult()

setSearchResult

public void setSearchResult(boolean isSearchResult)

getQuery

public org.silverpeas.search.searchEngine.model.QueryDescription getQuery()

setQuery

public void setQuery(org.silverpeas.search.searchEngine.model.QueryDescription query)

setPDCSearchContext

public void setPDCSearchContext(com.stratelia.silverpeas.pdc.model.SearchContext context)

getPDCSearchContext

public com.stratelia.silverpeas.pdc.model.SearchContext getPDCSearchContext()

setXMLSearchContext

public void setXMLSearchContext(com.silverpeas.form.DataRecord data)

getXMLSearchContext

public com.silverpeas.form.DataRecord getXMLSearchContext()

clearSearchContext

public void clearSearchContext()

isAdminOrPublisher

protected boolean isAdminOrPublisher(com.stratelia.webactiv.SilverpeasRole userRole)

sortAlbums

public static void sortAlbums(List<com.stratelia.webactiv.util.node.model.NodePK> albumPKs)

addNbMedia

public Collection<AlbumDetail> addNbMedia(Collection<AlbumDetail> albums)

notifyUsers

public void notifyUsers(com.stratelia.silverpeas.notificationManager.NotificationMetaData notifMetaData)

exportAlbum

public com.silverpeas.importExport.report.ExportReport exportAlbum(String albumId,
                                                                   MediaResolution mediaResolution)
                                                            throws com.silverpeas.export.ExportException

Export all picture from an album with the given resolution

Parameters:

albumId -

mediaResolution -

Throws:

com.silverpeas.export.ExportException

aGalleryExporter

public static GalleryExporter aGalleryExporter()

Gets a new exporter of Kmelia publications.

Returns:

a KmeliaPublicationExporter instance.

exportSelection

public com.silverpeas.importExport.report.ExportReport exportSelection(MediaResolution mediaResolution)
                                                                throws com.silverpeas.export.ExportException

Export all selected images from basket with the given resolution

Parameters:

mediaResolution -

Throws:

com.silverpeas.export.ExportException

getImagePreviewSize

public MediaResolution getImagePreviewSize()

Get the resolution preview of images

Returns:

the image resolution on preview

getImageResolutionPreview

public MediaResolution getImageResolutionPreview(Media media)

Get the resolution preview of the images

Parameters:

media -

Returns:

the media resolution on preview

getTemplate

public com.silverpeas.publicationTemplate.PublicationTemplate getTemplate(boolean register)
                                                                   throws com.silverpeas.publicationTemplate.PublicationTemplateException

Throws:

com.silverpeas.publicationTemplate.PublicationTemplateException

getOrderTemplate

public com.silverpeas.publicationTemplate.PublicationTemplate getOrderTemplate(boolean register)
                                                                        throws com.silverpeas.publicationTemplate.PublicationTemplateException

Throws:

com.silverpeas.publicationTemplate.PublicationTemplateException