com.tarantella.tta.webservices.client.views
Class CombinedView

java.lang.Object
  java.util.Observable
      com.tarantella.tta.webservices.client.views.WebtopViewBean
          com.tarantella.tta.webservices.client.views.CombinedView

All Implemented Interfaces:

java.io.Serializable

public class CombinedView
extends WebtopViewBean

The class maintains a combined view of assigned applications and application sessions. The application sessions are stored as children of the application item from which they were launched.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.tarantella.tta.webservices.client.views.WebtopViewBean

ATTR_ENABLED, ATTR_HIDDEN, ATTR_OPEN, EVENT_TOGGLE_GROUP, VALUE_CLOSED, VALUE_OPEN, VALUE_TRUE

Constructor Summary

CombinedView()
Constructor.

Method Summary

void	generateSessionView(java.lang.String searchSpec, java.lang.String[] attributes, boolean forceRefresh) Generates and caches a view of application sessions.
java.util.Enumeration	getCombinedView(java.lang.String webtopXml, java.lang.String sessionsXml, WebtopGroupContainer groups) Gets an enumerator over the combined view.
EmulatorSessionsView	getEmulatorSessionsView() Gets the application sessions view.
boolean	isEmulatorSession(IResponse object) Tests if the object is an application session.
boolean	processEvent(java.lang.String[] eventNames, java.lang.String[] eventActions, java.lang.String[] eventData) Processes events affecting this view.
boolean	processEvent(java.lang.String eventName, java.lang.String eventAction, java.lang.String eventData) Processes events affecting this view.
void	setMergedXml(java.lang.String xml, java.lang.String[] sessionAttrs) Deprecated. Sets merged XML in the view.

Methods inherited from class com.tarantella.tta.webservices.client.views.WebtopViewBean

generateView, generateViewHierarchy, getApplicationCount, getInstancesRemaining, getSortedWebtopViewEnumeration, getWebtopEnumeration, getWebtopViewEnumeration, isApplication, isDocument, isEnabled, isGroup, isInNewBrowserWindow, isInPlace, isVisible, lookupWebtopItems, searchWebtopContent, searchWebtopContentHierarchy

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

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

Constructor Detail

CombinedView

public CombinedView()

Constructor.

Since:

1.0

Method Detail

getCombinedView

public java.util.Enumeration getCombinedView(java.lang.String webtopXml,
                                             java.lang.String sessionsXml,
                                             WebtopGroupContainer groups)

Gets an enumerator over the combined view.

Parameters:

webtopXml - XML for assigned applications

sessionsXml - XML for application sessions

groups - User's assigned applications grouping

Returns:

The enumerator over the combined view.

Since:

1.0

setMergedXml

public void setMergedXml(java.lang.String xml,
                         java.lang.String[] sessionAttrs)

Deprecated. Sets merged XML in the view.

Parameters:

xml - Merged XML for assigned applications and application sessions.

sessionAttrs - Application session attributes.

Since:

1.0

getEmulatorSessionsView

public EmulatorSessionsView getEmulatorSessionsView()

Gets the application sessions view. This excludes assigned applications.

Returns:

The application sessions view

Since:

1.0

processEvent

public boolean processEvent(java.lang.String eventName,
                            java.lang.String eventAction,
                            java.lang.String eventData)
                     throws java.rmi.RemoteException

Processes events affecting this view. If the view is unable to process the event, the local cache may be invalid. It is the responsibility of the caller to refresh the cache in these circumstances. For supported events and actions, see:

WebtopViewBean.processEvent(String, String, String)

EmulatorSessionsView.processEvent(String, String, String)

Overrides:

processEvent in class WebtopViewBean

Parameters:

eventName - Name of the event

eventAction - Event action

eventData - Event data

Returns:

true if the event was processed and the view updated

false if the event was not processed, possibly leaving the view invalid

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0

processEvent

public boolean processEvent(java.lang.String[] eventNames,
                            java.lang.String[] eventActions,
                            java.lang.String[] eventData)
                     throws java.rmi.RemoteException

Processes events affecting this view. If the view is unable to process any of the events, the local cache may be invalid. It is the responsibility of the caller to refresh the cache in these circumstances. For supported events and actions, see:

WebtopViewBean.processEvent(String, String, String)

EmulatorSessionsView.processEvent(String, String, String)

Parameters:

eventNames - Ordered array of event names.

eventActions - Ordered array of event actions.

eventData - Ordered array of event data.

Returns:

true if the events were processed and the view updated

false if an event was not processed, possibly leaving the view invalid

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0

isEmulatorSession

public boolean isEmulatorSession(IResponse object)

Tests if the object is an application session.

Parameters:

object - Assigned application object

Returns:

true if the object is an application session

false if the object is not an application session

Since:

1.0

generateSessionView

public void generateSessionView(java.lang.String searchSpec,
                                java.lang.String[] attributes,
                                boolean forceRefresh)
                         throws java.rmi.RemoteException

Generates and caches a view of application sessions.

Parameters:

searchSpec - RFC 2254 search specification to select matching application sessions

attributes - The attributes desired in the response

forceRefresh - Flag controlling how the request is serviced.

true	request must be sent to the server
false	request may be serviced from the cached view

Throws:

java.rmi.RemoteException - On receipt of a SOAP fault.

Since:

1.0