|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CentraSiteSession
CentraSiteSession interface provides instances of the CentraSite Object managers, and other specialized programs such as configurators, diagnostic handlers etc., based on the user who is currently mapped to the session. The interface simplifies retrieving instances of the various managers, configurators, handlers etc., and reuses them as applicable with the user scope.
Method Summary | |
---|---|
void |
close()
Closes a session, releases all resources, and performs an implicit logout. |
java.util.List<AboutTopic> |
getAboutTopics(ClientAboutInfo aboutClient)
|
CSOActionManager |
getActionManager()
Returns the action manager associated with this session. |
ActivityManager |
getActivityManager()
Returns the activity manager associated with this session. |
ActivityManager |
getActivityManager(User user)
Returns the activity manager for the given user. |
CSOSearchConditionManager |
getCentraSiteObjectConditionManager()
Returns the condition manager associated with this session. |
CentraSiteObjectManager |
getCentraSiteObjectManager()
Returns the object manager associated with this session. |
CSOSearchManager |
getCentraSiteObjectSearchManager()
Returns the search manager associated with this session. |
CentraSiteObjectTypeManager |
getCentraSiteObjectTypeManager()
Returns the type manager associated with this session. |
Configurator |
getConfigurator(Organization organization)
Returns the organization specific configurator. |
Configurator |
getConfigurator(User user)
Returns the user specific configurator. |
DiagnosticHandler |
getDiagnosticHandler()
Returns the session diagnostic handler. |
java.util.Locale |
getDisplayLanguage()
|
HelpCenter |
getHelpCenter()
Return the HelpCenter which is used to access the available HelpCenterTopic's |
User |
getOwner()
Returns the owner of this session. |
java.util.Locale |
getOwnerLocale()
Returns the locale defined for the currently logged in user. |
CSOUriGenerator |
getURIGenerator()
Returns the CSOUriGenerator for this session. |
boolean |
isClosed()
Indicates whether the current session is active or inactive. |
void |
setHttpServletRequest(javax.servlet.http.HttpServletRequest request)
|
void |
setURIGenerator(CSOUriGenerator uriGenerator)
The URI format is not fixed but greatly depends on the CSO client. |
Method Detail |
---|
CentraSiteObjectManager getCentraSiteObjectManager() throws CLLException
CentraSiteObjectManager
CLLException
- in case of a failure to return the CentraSiteObjectManager
associated with CentraSiteSessionCentraSiteObjectTypeManager getCentraSiteObjectTypeManager() throws CLLException
CentraSiteObjectTypeManager
CLLException
- in case of a failure to return the CentraSiteObjectTypeManager
associated with CentraSiteSessionCSOSearchManager getCentraSiteObjectSearchManager() throws CLLException
CSOSearchManager
CLLException
- in case of a failure to return the CSOSearchManager
associated with CentraSiteSessionCSOSearchConditionManager getCentraSiteObjectConditionManager() throws CLLException
CSOSearchConditionManager
CLLException
- in case of a failure to return the CSOSearchConditionManager
associated with CentraSiteSessionCSOActionManager getActionManager() throws CLLException
CSOActionManager
CLLException
- in case of a failure to return the CSOActionManager
associated with CentraSiteSessionConfigurator getConfigurator(User user) throws CLLException
user
- User
CLLException
- in case of a failure to return an instance of Configurator for the given userConfigurator getConfigurator(Organization organization) throws CLLException
organization
- Organization
CLLException
- in case of a failure to return an instance of Configurator for the given organizationDiagnosticHandler getDiagnosticHandler() throws CLLException
DiagnosticHandler
CLLException
- in case of failure to return the DiagnosticsHandler for CentraSiteSessionUser getOwner() throws CLLException
User
CLLException
- in case of a failure to return the owner of CentraSiteSessionActivityManager getActivityManager() throws CLLException
ActivityManager
CLLException
- in case of a failure to return the ActivityManager
associated with CentraSiteSessionActivityManager getActivityManager(User user) throws CLLException
ActivityManager
CLLException
- in case of a failure to return the ActivityManager
for the specific userjava.util.Locale getOwnerLocale() throws CLLException
Locale
CLLException
- in case of a failure to return the Locale
defined for the currently logged in uservoid close() throws CLLException
CLLException
- in case of a failure to release the resources held by the CentraSiteSessionboolean isClosed()
void setURIGenerator(CSOUriGenerator uriGenerator)
uriGenerator
- CSOUriGenerator getURIGenerator()
CSOUriGenerator
HelpCenter getHelpCenter() throws CLLException
HelpCenter
CLLException
- in case of failed to get the HelpCenter.java.util.List<AboutTopic> getAboutTopics(ClientAboutInfo aboutClient) throws CLLException
CLLException
java.util.Locale getDisplayLanguage() throws CLLException
CLLException
void setHttpServletRequest(javax.servlet.http.HttpServletRequest request)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |