Package org.silverpeas.core.web.mvc.controller

Interface ComponentSessionController

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractCalendarWebController, AbstractComponentSessionController, AgendaSessionController, ClipboardSessionController, DirectorySessionController, DragAndDropWebEditorController, FileSharingSessionController, FormTemplateSessionController, ImportExportSessionController, InterestCenterSessionController, JcrMonitorWebController, JobDomainPeasSessionController, JobManagerPeasSessionController, JobSearchPeasSessionController, JobStartPagePeasSessionController, MyContactProfilSessionController, MyLinksPeasWebController, MyProfilSessionController, PdcClassifySessionController, PdcSearchSessionController, PdcSessionController, PdcSubscriptionSessionController, PdcUtilizationSessionController, PersonalizationSessionController, POPUPSessionController, ProfilSessionController, SelectionPeasWrapperSessionController, SILVERMAILSessionController, SilverStatisticsPeasSessionController, SubscriptionSessionController, TemplateDesignerSessionController, ThesaurusSessionController, ThumbnailSessionController, ToDoSessionController, UserCalendarWebController, UserNotificationSessionController, VariablesSessionController, VersioningSessionController, WbeWebController, WebComponentController, WebConnectionsSessionController, WorkflowDesignerSessionController

public interface ComponentSessionController
extends Serializable

The interface for all component session controllers.

Author:

nicolas eysseric and didier wenzek

Method Summary

Modifier and Type	Method	Description
void	addClipboardSelection(ClipboardSelection selection)
void	clipboardPasteDone()
String	getClipboardErrorMessage()
Exception	getClipboardExceptionError()
Collection	getClipboardObjects()
Collection	getClipboardSelectedObjects()
int	getClipboardSize()
String	getComponentId()	Return the component id
String	getComponentLabel()	Return the component label (as known by the user)
String	getComponentName()	Return the name of the component (as specified in the xmlComponent)
String	getComponentParameterValue(String parameterName)	Return the parameter value of current component instance from a given parameter name
String	getComponentParameterValue(ComponentInstanceParameterName parameterName)	Return the parameter value of current component instance from a given centralized parameter name
String	getComponentUrl()
SilverpeasRole	getHighestSilverpeasUserRole()	Gets the highest role the user has on the component.
SettingBundle	getIcon()
String	getLanguage()	Return the user language
LocalizationBundle	getMultilang()
OrganizationController	getOrganisationController()	Return the organizationController
UserPreferences	getPersonalization()
SettingBundle	getSettings()
Collection<SilverpeasRole>	getSilverpeasUserRoles()	Gets the roles the user has on the component.
String	getSpaceId()	Return the space id
String	getSpaceLabel()	Return the space label (as known by the user)
String[]	getUserAvailComponentIds()
UserDetail	getUserDetail()	Return the UserDetail of the current user
String	getUserId()	Return the UserId of the current user
String[]	getUserRoles()	Deprecated. use instead getSilverpeasUserRoles().
ZoneId	getZoneId()	Return the user zone id
boolean	isAppInMaintenance()
boolean	isSpaceInMaintenance(String spaceId)
void	removeClipboardElement(int index)
void	setAppModeMaintenance(boolean mode)
void	setClipboardSelectedElement(int index, boolean selected)
void	setSpaceModeMaintenance(String spaceId, boolean mode)

Method Detail

getOrganisationController

OrganizationController getOrganisationController()

Return the organizationController

getLanguage

String getLanguage()

Return the user language

getZoneId

ZoneId getZoneId()

Return the user zone id

getUserDetail

UserDetail getUserDetail()

Return the UserDetail of the current user

getUserId

String getUserId()

Return the UserId of the current user

getSpaceLabel

String getSpaceLabel()

Return the space label (as known by the user)

getSpaceId

String getSpaceId()

Return the space id

getComponentName

String getComponentName()

Return the name of the component (as specified in the xmlComponent)

getComponentLabel

String getComponentLabel()

Return the component label (as known by the user)

getComponentId

String getComponentId()

Return the component id

getComponentParameterValue

String getComponentParameterValue(String parameterName)

Return the parameter value of current component instance from a given parameter name

getComponentParameterValue

String getComponentParameterValue(ComponentInstanceParameterName parameterName)

Return the parameter value of current component instance from a given centralized parameter name

getUserAvailComponentIds

String[] getUserAvailComponentIds()

getComponentUrl

String getComponentUrl()

getSilverpeasUserRoles

Collection<SilverpeasRole> getSilverpeasUserRoles()

Gets the roles the user has on the component.

Returns:

a list of user roles.

getHighestSilverpeasUserRole

SilverpeasRole getHighestSilverpeasUserRole()

Gets the highest role the user has on the component.

Returns:

a user role.

getUserRoles

@Deprecated
String[] getUserRoles()

Deprecated.

use instead getSilverpeasUserRoles().

The names of user roles.

Returns:

array of user role name.

getPersonalization

UserPreferences getPersonalization()

getMultilang

LocalizationBundle getMultilang()

getIcon

SettingBundle getIcon()

getSettings

SettingBundle getSettings()

isAppInMaintenance

boolean isAppInMaintenance()

setAppModeMaintenance

void setAppModeMaintenance(boolean mode)

isSpaceInMaintenance

boolean isSpaceInMaintenance(String spaceId)

setSpaceModeMaintenance

void setSpaceModeMaintenance(String spaceId,
                             boolean mode)

getClipboardSelectedObjects

Collection getClipboardSelectedObjects()
                                throws SilverpeasException

Throws:

SilverpeasException

getClipboardErrorMessage

String getClipboardErrorMessage()
                         throws SilverpeasException

Throws:

SilverpeasException

getClipboardExceptionError

Exception getClipboardExceptionError()
                              throws SilverpeasException

Throws:

SilverpeasException

getClipboardObjects

Collection getClipboardObjects()
                        throws SilverpeasException

Throws:

SilverpeasException

addClipboardSelection

void addClipboardSelection(ClipboardSelection selection)
                    throws SilverpeasException

Throws:

SilverpeasException

clipboardPasteDone

void clipboardPasteDone()
                 throws SilverpeasException

Throws:

SilverpeasException

setClipboardSelectedElement

void setClipboardSelectedElement(int index,
                                 boolean selected)
                          throws SilverpeasException

Throws:

SilverpeasException

getClipboardSize

int getClipboardSize()
              throws SilverpeasException

Throws:

SilverpeasException

removeClipboardElement

void removeClipboardElement(int index)
                     throws SilverpeasException

Throws:

SilverpeasException