Interface ComponentSessionController
-
- All Superinterfaces:
Serializable
- All Known Implementing Classes:
AbstractAdminComponentSessionController
,AbstractCalendarWebController
,AbstractComponentSessionController
,AgendaSessionController
,ClipboardSessionController
,DirectorySessionController
,DocumentTemplateWebController
,DragAndDropWebEditorController
,FileSharingSessionController
,FormTemplateSessionController
,ImportExportSessionController
,InterestCenterSessionController
,JobDomainPeasSessionController
,JobManagerPeasSessionController
,JobSearchPeasSessionController
,JobStartPagePeasSessionController
,MyContactProfilSessionController
,MyLinksPeasWebController
,MyProfilSessionController
,PdcClassifySessionController
,PdcSearchSessionController
,PdcSessionController
,PdcSubscriptionSessionController
,PdcUtilizationSessionController
,PersonalizationSessionController
,POPUPSessionController
,ProfilSessionController
,SelectionPeasWrapperSessionController
,SILVERMAILSessionController
,SilverStatisticsPeasSessionController
,SubscriptionSessionController
,TemplateDesignerSessionController
,ThesaurusSessionController
,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
All Methods Instance Methods Abstract Methods Deprecated Methods 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 idString
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 nameString
getComponentParameterValue(ComponentInstanceParameterName parameterName)
Return the parameter value of current component instance from a given centralized parameter nameString
getComponentUrl()
SilverpeasRole
getHighestSilverpeasUserRole()
Gets the highest role the user has on the component.org.silverpeas.kernel.bundle.SettingBundle
getIcon()
String
getLanguage()
Return the user languageorg.silverpeas.kernel.bundle.LocalizationBundle
getMultilang()
OrganizationController
getOrganisationController()
Return the organizationControllerUserPreferences
getPersonalization()
org.silverpeas.kernel.bundle.SettingBundle
getSettings()
Collection<SilverpeasRole>
getSilverpeasUserRoles()
Gets the roles the user has on the component.String
getSpaceId()
Return the space idString
getSpaceLabel()
Return the space label (as known by the user)String[]
getUserAvailComponentIds()
UserDetail
getUserDetail()
Return the UserDetail of the current userString
getUserId()
Return the UserId of the current userString[]
getUserRoles()
Deprecated.use insteadgetSilverpeasUserRoles()
.ZoneId
getZoneId()
Return the user zone idboolean
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 insteadgetSilverpeasUserRoles()
.The names of user roles.- Returns:
- array of user role name.
-
getPersonalization
UserPreferences getPersonalization()
-
getMultilang
org.silverpeas.kernel.bundle.LocalizationBundle getMultilang()
-
getIcon
org.silverpeas.kernel.bundle.SettingBundle getIcon()
-
getSettings
org.silverpeas.kernel.bundle.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 org.silverpeas.kernel.SilverpeasException
- Throws:
org.silverpeas.kernel.SilverpeasException
-
getClipboardErrorMessage
String getClipboardErrorMessage() throws org.silverpeas.kernel.SilverpeasException
- Throws:
org.silverpeas.kernel.SilverpeasException
-
getClipboardExceptionError
Exception getClipboardExceptionError() throws org.silverpeas.kernel.SilverpeasException
- Throws:
org.silverpeas.kernel.SilverpeasException
-
getClipboardObjects
Collection getClipboardObjects() throws org.silverpeas.kernel.SilverpeasException
- Throws:
org.silverpeas.kernel.SilverpeasException
-
addClipboardSelection
void addClipboardSelection(ClipboardSelection selection) throws org.silverpeas.kernel.SilverpeasException
- Throws:
org.silverpeas.kernel.SilverpeasException
-
clipboardPasteDone
void clipboardPasteDone() throws org.silverpeas.kernel.SilverpeasException
- Throws:
org.silverpeas.kernel.SilverpeasException
-
setClipboardSelectedElement
void setClipboardSelectedElement(int index, boolean selected) throws org.silverpeas.kernel.SilverpeasException
- Throws:
org.silverpeas.kernel.SilverpeasException
-
getClipboardSize
int getClipboardSize() throws org.silverpeas.kernel.SilverpeasException
- Throws:
org.silverpeas.kernel.SilverpeasException
-
removeClipboardElement
void removeClipboardElement(int index) throws org.silverpeas.kernel.SilverpeasException
- Throws:
org.silverpeas.kernel.SilverpeasException
-
-