Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

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

java.lang.Object
  extended by com.tarantella.tta.webservices.client.views.WSObject
All Implemented Interfaces:
java.io.Serializable

public class WSObject
extends java.lang.Object
implements java.io.Serializable

The class represents a single assigned application.

See Also:
Serialized Form

Constructor Summary
WSObject()
          Constructor
WSObject(IResponse object)
          Constructor
 
Method Summary
 java.lang.String getAbsoluteURL()
          Gets the absolute URL for a document.
 java.util.HashMap<java.lang.String,java.lang.String> getAttributes()
          Gets a map of attributes for the object.
 java.util.HashMap<java.lang.String,java.lang.String[]> getAttributeValues()
          Gets a map of attributes for the object.
 int getChildCount()
          Gets the number of children on the object.
 java.lang.String getHashName()
          Gets a hash of the object name.
 int getInstancesRemaining()
          Gets the number of remaining application sessions that can be launched for this application.
 WSObject getParent()
          Gets the parent of this object.
 java.lang.String getToolTip()
          Gets a default tool-tip for the application.
 boolean isApplication()
          Tests if the object is an application or document.
 boolean isDocument()
          Tests if the object is a document.
 boolean isEmulatorSession()
          Tests if the object is an application session.
 boolean isEnabled()
          Tests if the object is an application or document that should be enabled.
 boolean isGroup()
          Tests if the object is a group.
 boolean isInNewBrowserWindow()
          Tests if the object is a document that should be launched in a new browser window.
 boolean isInPlace()
          Tests if the object is a document that should be launched in-place.
 boolean isOpen()
          Tests if the object is open.
 boolean isResumable()
          Tests if the object is a resumable application session.
 boolean isVisible()
          Tests if the object should be displayed.
 void setAbsoluteURL(java.lang.String url)
          Sets the absolute URL for a document.
 void setHashName(java.lang.String hashName)
          Sets the hash of the object name.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WSObject

public WSObject(IResponse object)
Constructor

Parameters:
object - Parsed XML object representing the object.
Since:
1.1

WSObject

public WSObject()
Constructor

Since:
1.1
Method Detail

isApplication

public boolean isApplication()
Tests if the object is an application or document.

Returns:
trueif the object is an application or document
falseif the object is not an application or document
Since:
1.1

isOpen

public boolean isOpen()
Tests if the object is open.

Returns:
trueif the object is open
falseif the object is not open
Since:
1.1

isVisible

public boolean isVisible()
Tests if the object should be displayed. An object is deemed as displayable if its parent and all ancestors should be displayed.

Returns:
trueif the object should be displayed
falseif the object should not be displayed
Since:
1.1

isDocument

public boolean isDocument()
Tests if the object is a document.

Returns:
trueif the object is a document
falseif the object is not a document
Since:
1.1

isGroup

public boolean isGroup()
Tests if the object is a group.

Returns:
trueif the object is a group
falseif the object is not a group
Since:
1.1

isInPlace

public boolean isInPlace()
Tests if the object is a document that should be launched in-place. in-place means in the display frame of the standard frameset.

Returns:
trueif the object is a document that should be launched in-place
falseif the object is not a document, or if it should be launched elsewhere
Since:
1.1

isInNewBrowserWindow

public boolean isInNewBrowserWindow()
Tests if the object is a document that should be launched in a new browser window.

Returns:
trueif the object is a document that should be launched in a new browser window
falseif the object is not a document, or if it should not be launched in a new browser window
Since:
1.1

isEnabled

public boolean isEnabled()
Tests if the object is an application or document that should be enabled. enabled means in that more launches are possible for the application or document.

Returns:
trueif the object is an application or document that is enabled
falseif the object is not an application or group, or if it not enabled
Since:
1.1

getInstancesRemaining

public int getInstancesRemaining()
Gets the number of remaining application sessions that can be launched for this application.

Returns:
-1: unlimited application sessions may be launched, or
the number of additional application sessions that may be launched
Since:
1.1

getAttributes

public java.util.HashMap<java.lang.String,java.lang.String> getAttributes()
Gets a map of attributes for the object. If an attribute has multiple values, only the first one is returned.

Returns:
A map of object attributes.
Since:
1.1

getAttributeValues

public java.util.HashMap<java.lang.String,java.lang.String[]> getAttributeValues()
Gets a map of attributes for the object. If an attribute has multiple values, all are returned.

Returns:
A map of object attributes.
Since:
1.1

getChildCount

public int getChildCount()
Gets the number of children on the object.

Returns:
The number of children.
Since:
1.1

getToolTip

public java.lang.String getToolTip()
Gets a default tool-tip for the application.

Returns:
The tool-tip.
Since:
1.1

isEmulatorSession

public boolean isEmulatorSession()
Tests if the object is an application session.

Returns:
trueif the object is an application session
falseif the object is not an application session
Since:
1.1

isResumable

public boolean isResumable()
Tests if the object is a resumable application session.

Returns:
trueif the object is a resumable application session
falseif the object is not a resumable application session
Since:
1.1

getHashName

public java.lang.String getHashName()
Gets a hash of the object name.

Returns:
A hash of the object name.
Since:
1.1

setHashName

public void setHashName(java.lang.String hashName)
Sets the hash of the object name.

Parameters:
hashName - The hash of the object name.
Since:
1.1

getAbsoluteURL

public java.lang.String getAbsoluteURL()
Gets the absolute URL for a document.

Returns:
The absolute URL.
Since:
1.1

setAbsoluteURL

public void setAbsoluteURL(java.lang.String url)
Sets the absolute URL for a document.

Parameters:
url - The absolute URL for a document.
Since:
1.1

getParent

public WSObject getParent()
Gets the parent of this object.

Returns:
The parent of this object.
Since:
1.1

Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

Copyright © 2012, 2013, Oracle and/or its affiliates. All rights reserved.