fr.onema.sispea.struts

Class SispeaSession

java.lang.Object

fr.onema.sispea.struts.SispeaSession

All Implemented Interfaces:

Serializable

public class SispeaSession
extends Object
implements Serializable

This class contains all SISPEA information of the session. This should be the only object put in session by the SISPEA web app. The class contains an init method. This method should be called to reinitialize all sequence / context specific attributes of the SISPEA session. All context specific attributes should be reinitialized (set to null) by the init method.

Author:

CS

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Integer	chosenExerciseId the exercice chosen by user for comparator
protected List<Integer>	comparatorSpeasIds the speas ids of the comparator table .
protected Integer	competenceId the competence chosen by user for comparator
protected Boolean	fullScreen The full screen mode
protected boolean	LDAPUsersEmailLoaded LDAP Users Email loaded
protected MenuBean	menu The current menu.
protected Integer	municipalityId Current session's municipality Id.
protected List<SearchTerritoryDto>	mySearchsTerritorys list of "my request" for the territory search.
protected List<UsersFilterDto>	mySearchsUsers list of "my request" for the users search.
protected SearchTerritoryDto	searchTerritory The last request parameters used for the territory search.
protected List<TerritoryDto>	selectedTerritories Selected result Territory.
static String	SISPEA_SESSION The session object used by the SISPEA web app.
protected TerritoryDto	territory Current session's territory.
protected Map<String,List<SearchTerritoryResultDto>>	territoryIncludedSpeasIds the map containing loaeded territories
protected Collection<ExchangeMessageDto>	uploadedFileMsgs The messages issued by the uploaded file validation.
protected String	urlGoingTo The initial url asked for by the user before redirected to the login page.
protected UserDto	user The current user.
protected UsersFormDto	usersSearchInfo The user filter informations associated with the action.
protected List<XmlGroupTableDetailValue>	xmlCurrentContextGroup context detail values for tax editor
protected XmlGroupTableDetailValue	xmlCurrentGroupDetailed current xmlGroup detailed for price or tax editor
protected XmlGroupTableDetail	xmlCurrentGroupToDetail current xmlGroup to detail for price or tax editor
protected List<XmlGroupTab>	xmlGroups display xmlGroup list

Constructor Summary

Constructors

Constructor and Description
SispeaSession()

Method Summary

Methods

Modifier and Type	Method and Description
protected String	buildMapKey(TerritoryDto pTerritory, ExerciseDto pExercise)
void	clearTerritoryIncludedSpeasIds()
Integer	getChosenExerciseId()
List<Integer>	getComparatorSpeasIds()
Integer	getCompetenceId()
MenuBean	getMenu()
Integer	getMunicipalityId()
List<SearchTerritoryDto>	getMySearchsTerritorys()
List<UsersFilterDto>	getMySearchsUsers()
SearchTerritoryDto	getSearchTerritory()
List<TerritoryDto>	getSelectedTerritories()
TerritoryDto	getTerritory()
List<SearchTerritoryResultDto>	getTerritoryIncludedSpeasIds(TerritoryDto pTerritory, ExerciseDto pExercise)
Collection<ExchangeMessageDto>	getUploadedFileMsgs()
String	getUrlGoingTo()
UserDto	getUser()
UsersFormDto	getUsersSearchInfo()
List<XmlGroupTableDetailValue>	getXmlCurrentContextGroup()
XmlGroupTableDetailValue	getXmlCurrentGroupDetailed()
XmlGroupTableDetail	getXmlCurrentGroupToDetail()
List<XmlGroupTab>	getXmlGroups()
void	init() This method initializes the session.
boolean	isFullScreen()
boolean	isLDAPUsersEmailLoaded()
void	setChosenExerciseId(Integer pChosenExerciseId)
void	setComparatorSpeasIds(List<Integer> pComparatorSpeasIds)
void	setCompetenceId(Integer pCompetenceId)
void	setFullScreen(boolean pFullScreen)
void	setLDAPUsersEmailLoaded(boolean lDAPUsersEmailLoaded)
void	setMenu(MenuBean pMenu)
void	setMunicipalityId(Integer pMunicipalityId)
void	setMySearchsTerritorys(List<SearchTerritoryDto> pMySearchsTerritorys)
void	setMySearchsUsers(List<UsersFilterDto> pMySearchsUsers)
void	setSearchTerritory(SearchTerritoryDto pSearchTerritory)
void	setSelectedTerritories(List<TerritoryDto> pSelectedTerritories)
void	setTerritory(TerritoryDto pTerritory)
void	setTerritoryIncludedSpeasIds(TerritoryDto pTerritory, ExerciseDto pExercise, List<SearchTerritoryResultDto> pSearchTerritoryResult)
void	setUploadedFileMsgs(Collection<ExchangeMessageDto> pUploadedFileMsgs)
void	setUrlGoingTo(String pUrlGoingTo)
void	setUser(UserDto pUser)
void	setUsersSearchInfo(UsersFormDto pUsersSearchInfo)
void	setXmlCurrentContextGroup(List<XmlGroupTableDetailValue> pXmlCurrentContextGroup)
void	setXmlCurrentGroupDetailed(XmlGroupTableDetailValue pXmlCurrentGroupDetailed)
void	setXmlCurrentGroupToDetail(XmlGroupTableDetail pXmlCurrentGroupToDetail)
void	setXmlGroups(List<XmlGroupTab> pXmlGroups)

Methods inherited from class java.lang.Object

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

Field Detail

SISPEA_SESSION

public static final String SISPEA_SESSION

The session object used by the SISPEA web app. This object should be the only SISPEA object in the session scope.

See Also:

Constant Field Values

user

protected UserDto user

The current user. This attribute may be null if there is not any authenticated user yet.

menu

protected MenuBean menu

The current menu. This attribute should not be null.

fullScreen

protected Boolean fullScreen

The full screen mode

selectedTerritories

protected List<TerritoryDto> selectedTerritories

Selected result Territory.

territoryIncludedSpeasIds

protected Map<String,List<SearchTerritoryResultDto>> territoryIncludedSpeasIds

the map containing loaeded territories

comparatorSpeasIds

protected List<Integer> comparatorSpeasIds

the speas ids of the comparator table .

chosenExerciseId

protected Integer chosenExerciseId

the exercice chosen by user for comparator

competenceId

protected Integer competenceId

the competence chosen by user for comparator

municipalityId

protected Integer municipalityId

Current session's municipality Id.

territory

protected TerritoryDto territory

Current session's territory.

uploadedFileMsgs

protected Collection<ExchangeMessageDto> uploadedFileMsgs

The messages issued by the uploaded file validation.

searchTerritory

protected SearchTerritoryDto searchTerritory

The last request parameters used for the territory search. These parameters are re-used when scrolling through the result pages.

mySearchsTerritorys

protected List<SearchTerritoryDto> mySearchsTerritorys

list of "my request" for the territory search.

mySearchsUsers

protected List<UsersFilterDto> mySearchsUsers

list of "my request" for the users search.

LDAPUsersEmailLoaded

protected boolean LDAPUsersEmailLoaded

LDAP Users Email loaded

usersSearchInfo

protected UsersFormDto usersSearchInfo

The user filter informations associated with the action.

urlGoingTo

protected String urlGoingTo

The initial url asked for by the user before redirected to the login page. This attribute should only be used in the login process.

xmlGroups

protected List<XmlGroupTab> xmlGroups

display xmlGroup list

xmlCurrentContextGroup

protected List<XmlGroupTableDetailValue> xmlCurrentContextGroup

context detail values for tax editor

xmlCurrentGroupDetailed

protected XmlGroupTableDetailValue xmlCurrentGroupDetailed

current xmlGroup detailed for price or tax editor

xmlCurrentGroupToDetail

protected XmlGroupTableDetail xmlCurrentGroupToDetail

current xmlGroup to detail for price or tax editor

Constructor Detail

SispeaSession

public SispeaSession()

Method Detail

init

public void init()

This method initializes the session. Each action that start a new GUI sequence should call this method to have a initialized and clean session. This method must be updated whenever new objects are added to the SISPEA session.

getUser

public UserDto getUser()

setUser

public void setUser(UserDto pUser)

getMenu

public MenuBean getMenu()

setMenu

public void setMenu(MenuBean pMenu)

getUploadedFileMsgs

public Collection<ExchangeMessageDto> getUploadedFileMsgs()

setUploadedFileMsgs

public void setUploadedFileMsgs(Collection<ExchangeMessageDto> pUploadedFileMsgs)

getSearchTerritory

public SearchTerritoryDto getSearchTerritory()

setSearchTerritory

public void setSearchTerritory(SearchTerritoryDto pSearchTerritory)

getMunicipalityId

public Integer getMunicipalityId()

setMunicipalityId

public void setMunicipalityId(Integer pMunicipalityId)

getMySearchsTerritorys

public List<SearchTerritoryDto> getMySearchsTerritorys()

setMySearchsTerritorys

public void setMySearchsTerritorys(List<SearchTerritoryDto> pMySearchsTerritorys)

getMySearchsUsers

public List<UsersFilterDto> getMySearchsUsers()

setMySearchsUsers

public void setMySearchsUsers(List<UsersFilterDto> pMySearchsUsers)

getTerritory

public TerritoryDto getTerritory()

setTerritory

public void setTerritory(TerritoryDto pTerritory)

getUrlGoingTo

public String getUrlGoingTo()

setUrlGoingTo

public void setUrlGoingTo(String pUrlGoingTo)

getSelectedTerritories

public List<TerritoryDto> getSelectedTerritories()

setSelectedTerritories

public void setSelectedTerritories(List<TerritoryDto> pSelectedTerritories)

getUsersSearchInfo

public UsersFormDto getUsersSearchInfo()

setUsersSearchInfo

public void setUsersSearchInfo(UsersFormDto pUsersSearchInfo)

getComparatorSpeasIds

public List<Integer> getComparatorSpeasIds()

setComparatorSpeasIds

public void setComparatorSpeasIds(List<Integer> pComparatorSpeasIds)

getChosenExerciseId

public Integer getChosenExerciseId()

setChosenExerciseId

public void setChosenExerciseId(Integer pChosenExerciseId)

getCompetenceId

public Integer getCompetenceId()

setCompetenceId

public void setCompetenceId(Integer pCompetenceId)

getXmlGroups

public List<XmlGroupTab> getXmlGroups()

setXmlGroups

public void setXmlGroups(List<XmlGroupTab> pXmlGroups)

getXmlCurrentGroupDetailed

public XmlGroupTableDetailValue getXmlCurrentGroupDetailed()

setXmlCurrentGroupDetailed

public void setXmlCurrentGroupDetailed(XmlGroupTableDetailValue pXmlCurrentGroupDetailed)

getXmlCurrentGroupToDetail

public XmlGroupTableDetail getXmlCurrentGroupToDetail()

setXmlCurrentGroupToDetail

public void setXmlCurrentGroupToDetail(XmlGroupTableDetail pXmlCurrentGroupToDetail)

getXmlCurrentContextGroup

public List<XmlGroupTableDetailValue> getXmlCurrentContextGroup()

setXmlCurrentContextGroup

public void setXmlCurrentContextGroup(List<XmlGroupTableDetailValue> pXmlCurrentContextGroup)

isFullScreen

public boolean isFullScreen()

setFullScreen

public void setFullScreen(boolean pFullScreen)

getTerritoryIncludedSpeasIds

public List<SearchTerritoryResultDto> getTerritoryIncludedSpeasIds(TerritoryDto pTerritory,
                                                          ExerciseDto pExercise)

setTerritoryIncludedSpeasIds

public void setTerritoryIncludedSpeasIds(TerritoryDto pTerritory,
                                ExerciseDto pExercise,
                                List<SearchTerritoryResultDto> pSearchTerritoryResult)

clearTerritoryIncludedSpeasIds

public void clearTerritoryIncludedSpeasIds()

buildMapKey

protected String buildMapKey(TerritoryDto pTerritory,
                 ExerciseDto pExercise)

isLDAPUsersEmailLoaded

public boolean isLDAPUsersEmailLoaded()

setLDAPUsersEmailLoaded

public void setLDAPUsersEmailLoaded(boolean lDAPUsersEmailLoaded)