com.softwareag.cis.plugin.adapter
Class WorkplaceBootstrapInfoProvider

java.lang.Object
  extended by com.softwareag.cis.plugin.adapter.WorkplaceBootstrapInfoProvider
All Implemented Interfaces:
WorkplaceContext, com.softwareag.cis.plugin.util.BaseConstants, com.softwareag.cis.workplace.IMFWorkplaceBootstrapInfoProvider2, com.softwareag.cis.workplace.MFWorkplaceConstants

public class WorkplaceBootstrapInfoProvider
extends java.lang.Object
implements com.softwareag.cis.workplace.IMFWorkplaceBootstrapInfoProvider2, com.softwareag.cis.workplace.MFWorkplaceConstants, WorkplaceContext, com.softwareag.cis.plugin.util.BaseConstants


Field Summary
 
Fields inherited from interface com.softwareag.cis.workplace.MFWorkplaceConstants
HTMLPAGE, HTMLPAGE_BIND, HTMLPAGE2, MFWORKPLACEINFO_LOOKUP, MFWORKPLACEINFO_LOOKUP2, TYPE_CALLBACK, TYPE_CIPAGE, TYPE_CIPAGEPOPUP, TYPE_CITARGET, TYPE_FOLDER, TYPE_HTMLPOPUP, TYPE_HTMLTARGET, TYPE_NORMALPAGE
 
Fields inherited from interface com.softwareag.cis.plugin.extpt.util.WorkplaceContext
rcs_id
 
Fields inherited from interface com.softwareag.cis.plugin.util.BaseConstants
CONTROL_PLUGIN_ID, DEFAULT_LOGIN_CONTEXT, DEFAULT_LOGIN_PAGE, DEFAULT_STYLE, DEFAULT_STYLE_WP, EP_ABOUT_ID, EP_ABOUT_PAGE_URL_ATTR, EP_ABOUT_POPUP_TITLE_ATTR, EP_CONNECTION_HANDLER, EP_I18N, EP_LOGGED_USER, EP_MY_ACCOUNT_ID, EP_MY_ACCOUNT_PAGE_URL_ATTR, EP_MY_ACCOUNT_POPUP_TITLE_ATTR, EP_PARAMETER, EP_PERSPECTIVE, EP_PLUGIN_INFO, EP_REQUIRES_LOGGED_IN_USER, EP_TOPIC, EP_TOPIC_PROP_PERSPECTIVE, FRAME_AVAILABLE_ACTIVITIES, FRAME_CONTENT, FRAME_CURRENT_ACTIVITIES, FRAME_DOWNLOAD, FRAME_EXECUTE_DEFERRED, FRAME_HEADER, FRAME_NEW, FRAME_TOP, HEADER_PAGE, ICON_URL_PREFIX, KEYCODE_ENTER, KEYCODE_ESC, KEYCODE_NONE, MAINWORKPLACE_PAGE, MAINWORKPLACE_PAGE_RTL, MFWORKPLACE_PAGE, MY_APPLICATION, MY_PLUGIN_ID, PAGE_URL_PREFIX, PARM_PLUGGABLEUI_LOGIN_CONTEXT, PLUGGABLEUI_EXTERNAL_LOGIN_PAGE, PLUGGABLEUI_SSOLOGOFFLANDINGURL, PREFERED_PLUGIN, rcs_id, SESSION_APPLICATION_CONTEXT, SESSION_DEFERRED_RUNNABLE, SESSION_JAAS_LOGIN_CONTEXT, SESSION_JAAS_SUBJECT, SESSION_KNOWN_ACTIVITIES, SESSION_KNOWN_ADAPTERS, SESSION_LOCALE, SESSION_UPDATE_ADAPTERS, SESSION_WORKPLACE_ADAPTER, SESSION_WORKPLACE_BOOTSTRAP_INFO_PROVIDER, SHOW_THROWABLE_PAGE_FULL, SHOW_THROWABLELOGIN_PAGE_FULL
 
Constructor Summary
WorkplaceBootstrapInfoProvider()
           
 
Method Summary
 Topic findTopicForWorkplaceActivity(com.softwareag.cis.workplace.IMFWorkplaceActivity activity)
           
 java.util.List getAllPerspectives()
          Obtain List of all perspectives
 java.util.List getAllTopics()
          Obtain List of topics registered for the extension point
 Perspective getCurrentPerspective()
           
 java.util.Set getCurrentPerspectives()
           
 Topic getCurrentTopic()
          Get currently visible topic
 Perspective getEffectivePerspective()
          Get effective perspective - i.e. the perspective hosting the currently visible topic.
static WorkplaceBootstrapInfoProvider getInstance(com.softwareag.cis.server.Adapter adapter)
          Get instance of the class.
 java.util.Locale getLocale()
           
static Topic getTopic(com.softwareag.cis.server.Adapter adapter, java.lang.Class topicClass)
          Get first topic being an instance of the specified class for session identified by given adapter
 Topic getTopic(java.lang.Class topicClass)
          Get first topic being an instance of the specified class
 java.util.List getVisiblePerspectives()
          Obtain List of visible perspectives
 com.softwareag.cis.workplace.MFWorkplaceAdapter getWorkplaceAdapter()
          Get the MFWorkplaceAdapter
 com.softwareag.cis.workplace.MFWorkplaceInfo getWorkplaceInfo()
          Obtain MFWorkplaceInfo
 com.softwareag.cis.workplace.MFWorkplaceInfo getWorkplaceInfo(com.softwareag.cis.workplace.IMFWorkplaceBootstrapInfo envInfo)
          Provide description of workplace.
 void reactOnSwitchSelectedTopic(com.softwareag.cis.workplace.MFWorkplaceTopic oldMFWorkplaceTopic, com.softwareag.cis.workplace.MFWorkplaceTopic newMFWorkplaceTopic)
          Handle switch of topics
 void refreshTopics()
          Refresh topics after visibility of one ore more topics has changed (usually due to a different view)
static void refreshTopics(com.softwareag.cis.server.Adapter adapter)
          Refresh topics after visibility of one ore more topics has changed
 void setCurrentPerspective(Perspective newPerspective, Topic newTopic, boolean withNotification, Command topicCommand)
          Switch visible perspective
 void updateWorkplace(Topic newTopic, com.softwareag.cis.server.Adapter adapter, Command topicCommand)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WorkplaceBootstrapInfoProvider

public WorkplaceBootstrapInfoProvider()
Method Detail

getInstance

public static WorkplaceBootstrapInfoProvider getInstance(com.softwareag.cis.server.Adapter adapter)
Get instance of the class.

Parameters:
adapter - Used for retrieving the session.
Returns:
WorkplaceBootstrapInfoProvider retrieved from the session.

getAllPerspectives

public java.util.List getAllPerspectives()
Obtain List of all perspectives

Returns:
List of Topic objects

getVisiblePerspectives

public java.util.List getVisiblePerspectives()
Obtain List of visible perspectives

Returns:
List of Topic objects

getAllTopics

public java.util.List getAllTopics()
Obtain List of topics registered for the extension point

Returns:
List of Topic objects

findTopicForWorkplaceActivity

public Topic findTopicForWorkplaceActivity(com.softwareag.cis.workplace.IMFWorkplaceActivity activity)

getTopic

public static Topic getTopic(com.softwareag.cis.server.Adapter adapter,
                             java.lang.Class topicClass)
Get first topic being an instance of the specified class for session identified by given adapter

Parameters:
adapter -
topicClass -
Returns:
the first matching topic or null if not found

getTopic

public Topic getTopic(java.lang.Class topicClass)
Get first topic being an instance of the specified class

Parameters:
topicClass -
Returns:
the first matching topic or null if not found

setCurrentPerspective

public void setCurrentPerspective(Perspective newPerspective,
                                  Topic newTopic,
                                  boolean withNotification,
                                  Command topicCommand)
Switch visible perspective

Parameters:
newPerspective - the perspective to be made visible

getEffectivePerspective

public Perspective getEffectivePerspective()
Get effective perspective - i.e. the perspective hosting the currently visible topic.

Returns:
the effective perspective

getCurrentTopic

public Topic getCurrentTopic()
Get currently visible topic

Returns:
the Topic currently being visible - may be null

getWorkplaceInfo

public com.softwareag.cis.workplace.MFWorkplaceInfo getWorkplaceInfo(com.softwareag.cis.workplace.IMFWorkplaceBootstrapInfo envInfo)
Provide description of workplace.

Specified by:
getWorkplaceInfo in interface com.softwareag.cis.workplace.IMFWorkplaceBootstrapInfoProvider2
Parameters:
envInfo -

getWorkplaceInfo

public com.softwareag.cis.workplace.MFWorkplaceInfo getWorkplaceInfo()
Description copied from interface: WorkplaceContext
Obtain MFWorkplaceInfo

Specified by:
getWorkplaceInfo in interface WorkplaceContext
Returns:
the MFWorkplaceInfo object

getLocale

public java.util.Locale getLocale()

refreshTopics

public void refreshTopics()
Refresh topics after visibility of one ore more topics has changed (usually due to a different view)

Specified by:
refreshTopics in interface WorkplaceContext

refreshTopics

public static void refreshTopics(com.softwareag.cis.server.Adapter adapter)
Refresh topics after visibility of one ore more topics has changed

Parameters:
adapter - Used for retrieving the session.

getWorkplaceAdapter

public com.softwareag.cis.workplace.MFWorkplaceAdapter getWorkplaceAdapter()
Description copied from interface: WorkplaceContext
Get the MFWorkplaceAdapter

Specified by:
getWorkplaceAdapter in interface WorkplaceContext
Returns:
MFWorkplaceAdapter Retrieve the workplace adapter from session.

reactOnSwitchSelectedTopic

public void reactOnSwitchSelectedTopic(com.softwareag.cis.workplace.MFWorkplaceTopic oldMFWorkplaceTopic,
                                       com.softwareag.cis.workplace.MFWorkplaceTopic newMFWorkplaceTopic)
Handle switch of topics

Parameters:
oldMFWorkplaceTopic - the topic which had been visible before
newMFWorkplaceTopic - the topic which is going to become visible

getCurrentPerspectives

public java.util.Set getCurrentPerspectives()
Returns:
the currently chosen perspective - should always be non-null

getCurrentPerspective

public Perspective getCurrentPerspective()
Returns:
the currently chosen perspective - should always be non-null

updateWorkplace

public void updateWorkplace(Topic newTopic,
                            com.softwareag.cis.server.Adapter adapter,
                            Command topicCommand)