com.stratelia.silverpeas.peasCore
Interface ComponentSessionController

All Known Implementing Classes:
AbstractComponentSessionController, AgendaSessionController, AlertUserPeasSessionController, ClipboardSessionController, CommunicationUserSessionController, DirectorySessionController, FileSharingSessionController, FormTemplateSessionController, GenericPanelPeasSessionController, ImportExportSessionController, InterestCenterSessionController, JobDomainPeasSessionController, JobManagerPeasSessionController, JobOrganizationPeasSessionController, JobSearchPeasSessionController, JobStartPagePeasSessionController, MyContactProfilSessionController, MyLinksPeasSessionController, MyProfilSessionController, NotificationUserSessionController, PdcClassifySessionController, PdcSearchSessionController, PdcSessionController, PdcSubscriptionSessionController, PdcUtilizationSessionController, PersonalizationSessionController, POPUPSessionController, ProfilSessionController, SelectionPeasSessionController, SelectionPeasWrapperSessionController, SILVERMAILSessionController, SilverStatisticsPeasSessionController, SubscriptionSessionController, TemplateDesignerSessionController, ThesaurusSessionController, ThumbnailSessionController, ToDoSessionController, VersioningSessionController, WebComponentController, WebConnectionsSessionController, WorkflowDesignerSessionController

public interface ComponentSessionController

The interface for all component session controllers.


Method Summary
 void addClipboardSelection(ClipboardSelection selection)
           
 void clipboardPasteDone()
           
 Integer getClipboardCount()
           
 String getClipboardErrorMessage()
           
 Exception getClipboardExceptionError()
           
 String getClipboardName()
           
 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)
 List getComponentParameters()
          Return the parameters for this component instance
 String getComponentParameterValue(ComponentInstanceParameterName parameterName)
          Return the parameter value of current component instance from a given centralized parameter name
 String getComponentParameterValue(String parameterName)
          Return the parameter value of current component instance from a given parameter name
 String getComponentUrl()
           
 SilverpeasRole getHighestSilverpeasUserRole()
          Gets the highest role the user has on the component.
 ResourceLocator getIcon()
           
 String getLanguage()
          Return the user language
 ResourceLocator getMultilang()
           
 OrganisationController getOrganisationController()
          Return the organizationController
 UserPreferences getPersonalization()
           
 ResourceLocator 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()
           
 String[] getUserAvailSpaceIds()
           
 UserDetail getUserDetail()
          Return the UserDetail of the current user
 String getUserId()
          Return the UserId of the current user
 String getUserRoleLevel()
          Deprecated. 
 String[] getUserRoles()
          Deprecated. 
 boolean isAppInMaintenance()
           
 boolean isSpaceInMaintenance(String spaceId)
           
 void removeClipboardElement(int index)
           
 void setAppModeMaintenance(boolean mode)
           
 void setClipboardError(String messageId, Exception ex)
           
 void setClipboardSelectedElement(int index, boolean selected)
           
 void setSpaceModeMaintenance(String spaceId, boolean mode)
           
 

Method Detail

getOrganisationController

OrganisationController getOrganisationController()
Return the organizationController


getLanguage

String getLanguage()
Return the user language


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


getComponentParameters

List getComponentParameters()
Return the parameters for this component instance


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()

getUserAvailSpaceIds

String[] getUserAvailSpaceIds()

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. 

Return the name of the user's roles


getUserRoleLevel

@Deprecated
String getUserRoleLevel()
Deprecated. 

Return the higher user's role (admin, publisher or user)


getPersonalization

UserPreferences getPersonalization()

getMultilang

ResourceLocator getMultilang()

getIcon

ResourceLocator getIcon()

getSettings

ResourceLocator 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 Exception
Throws:
Exception

getClipboardErrorMessage

String getClipboardErrorMessage()
                                throws Exception
Throws:
Exception

getClipboardExceptionError

Exception getClipboardExceptionError()
                                     throws Exception
Throws:
Exception

getClipboardObjects

Collection getClipboardObjects()
                               throws Exception
Throws:
Exception

addClipboardSelection

void addClipboardSelection(ClipboardSelection selection)
                           throws Exception
Throws:
Exception

getClipboardName

String getClipboardName()
                        throws Exception
Throws:
Exception

getClipboardCount

Integer getClipboardCount()
                          throws Exception
Throws:
Exception

clipboardPasteDone

void clipboardPasteDone()
                        throws Exception
Throws:
Exception

setClipboardSelectedElement

void setClipboardSelectedElement(int index,
                                 boolean selected)
                                 throws Exception
Throws:
Exception

getClipboardSize

int getClipboardSize()
                     throws Exception
Throws:
Exception

removeClipboardElement

void removeClipboardElement(int index)
                            throws Exception
Throws:
Exception

setClipboardError

void setClipboardError(String messageId,
                       Exception ex)
                       throws Exception
Throws:
Exception


Copyright © 2016 Silverpeas. All Rights Reserved.