Oracle Secure Global Desktop Web Services API Documentation
Release 4.7

E21396-02

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

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

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

The WebtopGroup class manages a group of assigned applications, typically used by user-defined preferences.

A assigned applications group consists of members and attributes that control its display, for example, whether it should be shown and whether it should be expanded or collapsed. It is used by WebtopGroupContainer and WebtopViewBean.

See Also:
Serialized Form

Constructor Summary
WebtopGroup()
          Constructor.
WebtopGroup(java.lang.String name)
          Constructor.
WebtopGroup(java.lang.String name, boolean isCollapsed)
          Constructor.
WebtopGroup(java.lang.String name, boolean isCollapsed, boolean isShown)
          Constructor.
 
Method Summary
 boolean addMember(java.lang.String member)
          Adds a member to the group.
 boolean addMember(java.lang.String member, int location)
          Adds a member to the group at a specific location.
 boolean addMembers(java.lang.String[] members)
          Adds members to the group.
 boolean containsMember(java.lang.String name)
          Tests if the group contains the named member.
 boolean dump(java.lang.StringBuffer buffer)
          Dumps members.
 int findMember(java.lang.String name)
          Finds the location of the named member.
 int getId()
          Gets the unique ID of the group.
 int getMemberCount()
          Gets the number of members in the group.
 java.lang.String[] getMembers()
          Gets the group members.
 java.lang.String getName()
          Gets the name of the group.
 boolean isCollapsed()
          Gets the open/closed state of the group.
 boolean isShown()
          Gets the visibility of the group.
 boolean load(java.lang.String data)
          Loads members.
 boolean moveMember(java.lang.String name, int location)
          Moves a member of the group to a specific location.
 boolean removeMember(int location)
          Removes a member of the group from a specific location.
 boolean removeMember(java.lang.String name)
          Removes a named member of the group.
 boolean replaceGroupMembers(java.lang.String[] members)
          Replaces all group members.
 void setCollapsed(boolean state)
          Sets the open/closed state of the group.
 void setName(java.lang.String name)
          Sets the name of the group.
 void setShown(boolean state)
          Sets the visibility of the group.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WebtopGroup

public WebtopGroup()
Constructor. Creates an unnamed group. By default, the group is collapsed and shown.

Since:
1.0

WebtopGroup

public WebtopGroup(java.lang.String name)
Constructor. Creates a named group. By default, the group is collapsed and shown.

Parameters:
name - The name of the group.
Since:
1.0

WebtopGroup

public WebtopGroup(java.lang.String name,
                   boolean isCollapsed)
Constructor. Creates a named group. By default, the group is shown.

Parameters:
name - The name of the group.
isCollapsed - Flag controlling the open/closed state of the group.
truethe group is initially closed/collapsed
falsethe group is initially open
Since:
1.0

WebtopGroup

public WebtopGroup(java.lang.String name,
                   boolean isCollapsed,
                   boolean isShown)
Constructor. Creates a named group.

Parameters:
name - The name of the group.
isCollapsed - Flag controlling the open/closed state of the group.
truethe group is initially closed/collapsed
falsethe group is initially open
isShown - Flag controlling the visibility of the group.
truethe group is initially visible/shown
falsethe group is initially not shown
Since:
1.0
Method Detail

getName

public java.lang.String getName()
Gets the name of the group.

Returns:
The name of the group. This can be null.
Since:
1.0

isCollapsed

public boolean isCollapsed()
Gets the open/closed state of the group.

Returns:
truegroup is closed/collapsed
falsegroup is open
Since:
1.0

isShown

public boolean isShown()
Gets the visibility of the group.

Returns:
truegroup is visible/shown
falsegroup is not shown
Since:
1.0

setName

public void setName(java.lang.String name)
Sets the name of the group.

Parameters:
name - The name of the group.
Since:
1.0

setCollapsed

public void setCollapsed(boolean state)
Sets the open/closed state of the group.

Parameters:
state - The open/closed state of the group.
truestate is closed/collapsed
falsestate is open
Since:
1.0

setShown

public void setShown(boolean state)
Sets the visibility of the group.

Parameters:
state - The visibility of the group.
truestate is visible/shown
falsestate is not shown
Since:
1.0

replaceGroupMembers

public boolean replaceGroupMembers(java.lang.String[] members)
Replaces all group members.

Parameters:
members - The new group members.
Returns:
truemembers replaced
falsemembers not replaced
Since:
1.0

getMembers

public java.lang.String[] getMembers()
Gets the group members.

Returns:
The members of the group.
Since:
1.0

addMember

public boolean addMember(java.lang.String member)
Adds a member to the group. The member is added at the end of the group.

Parameters:
member - The new member.
Returns:
truemember added
falsemember not added
Since:
1.0

addMember

public boolean addMember(java.lang.String member,
                         int location)
Adds a member to the group at a specific location.

Parameters:
member - The new member.
location - The location at which the member is added.
Returns:
truemember added
falsemember not added
Since:
1.0

getMemberCount

public int getMemberCount()
Gets the number of members in the group.

Returns:
The number of members in the group.
Since:
1.0

moveMember

public boolean moveMember(java.lang.String name,
                          int location)
Moves a member of the group to a specific location.

Parameters:
name - The name of the member.
location - The destination location.
Returns:
truemember moved
falsemember not moved
Since:
1.0

removeMember

public boolean removeMember(int location)
Removes a member of the group from a specific location.

Parameters:
location - The location of the member to be removed.
Returns:
truemember removed
falsemember not removed
Since:
1.0

removeMember

public boolean removeMember(java.lang.String name)
Removes a named member of the group.

Parameters:
name - The name of the member to be removed.
Returns:
truemember removed
falsemember not removed
Since:
1.0

addMembers

public boolean addMembers(java.lang.String[] members)
Adds members to the group. Duplicate members are removed.

Parameters:
members - Members to be added.
Returns:
truemembers added
falsemembers not added
Since:
1.0

load

public boolean load(java.lang.String data)
Loads members.

Parameters:
data - Data containing members. Created by dump(StringBuffer).
Returns:
truemembers loaded
falsemembers not loaded
Since:
1.0

dump

public boolean dump(java.lang.StringBuffer buffer)
Dumps members.

Parameters:
buffer - Buffer for members. Can be read by load(String).
Returns:
truemembers dumped
falsemembers not dumped
Since:
1.0

containsMember

public boolean containsMember(java.lang.String name)
Tests if the group contains the named member.

Parameters:
name - The name of the desired member.
Returns:
truegroup contains named member
falsegroup does not contain named member
Since:
1.0

findMember

public int findMember(java.lang.String name)
Finds the location of the named member.

Parameters:
name - The name of the desired member.
Returns:
-1named member does not exist, or
 the location of the named member
Since:
1.0

getId

public int getId()
Gets the unique ID of the group.

Returns:
The group ID.
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.