com.aol.acc
Class AccGroup

java.lang.Object
  extended by com.aol.acc.AccBase
      extended by com.aol.acc.AccGroup

public class AccGroup
extends AccBase

The IAccGroup interface represents a group of buddies.


Method Summary
 AccUser getBuddyByIndex(int position)
          Retrieves a specific user by position in the group.

 AccUser getBuddyByName(java.lang.String name)
          Finds a user by name in the group.

 int getBuddyCount()
          Gets the number of users in the group.

 int getBuddyPosition(AccUser user)
          Get the user position given a user object.

 boolean getCollapsed()
          Whether the group is collapsed
 java.lang.String getName()
          Gets the name of the group.

 int getOnlineCount()
          The number of online buddies in the group
 boolean getReadOnly()
          Whether the group is read-only
 boolean getRecentBuddies()
          Whether the group is the "recent buddies" group
 AccSession getSession()
          The IAccSession associated with the IAccGroup
 boolean getShared()
          Whether the group is "shared"
 boolean getSmart()
          Whether the group is a smart group
 java.lang.String getSynchronizedStorageName()
          If synched with a database, the storage name
 java.lang.String getSynchronizedStorageType()
          If synched with a database, the storage type
 AccUser insertBuddy(java.lang.String user, int position)
          Inserts a new user in the group.
Specify -1 for position to add to the end of the group.

 void moveBuddy(int fromPosition, int toPosition)
          Move user from one position in the group to another position.

 void removeBuddy(int position)
          Removes a user from the group.

 void setCollapsed(boolean Collapsed)
          Whether the group is collapsed
 void setName(java.lang.String name)
          Sets the name of the group.

 void setSynchronizedStorageName(java.lang.String SynchronizedStorageName)
          If synched with a database, the storage name
 void setSynchronizedStorageType(java.lang.String SynchronizedStorageType)
          If synched with a database, the storage type
 
Methods inherited from class com.aol.acc.AccBase
compareHandle, equals
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getName

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

Throws:
AccException

setName

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

Throws:
AccException

getBuddyCount

public int getBuddyCount()
                  throws AccException
Gets the number of users in the group.

Throws:
AccException

getBuddyByIndex

public AccUser getBuddyByIndex(int position)
                        throws AccException
Retrieves a specific user by position in the group.

Throws:
AccException

getBuddyPosition

public int getBuddyPosition(AccUser user)
                     throws AccException
Get the user position given a user object.

Throws:
AccException

insertBuddy

public AccUser insertBuddy(java.lang.String user,
                           int position)
                    throws AccException
Inserts a new user in the group.
Specify -1 for position to add to the end of the group.

Throws:
AccException

removeBuddy

public void removeBuddy(int position)
                 throws AccException
Removes a user from the group.

Throws:
AccException

moveBuddy

public void moveBuddy(int fromPosition,
                      int toPosition)
               throws AccException
Move user from one position in the group to another position.

Throws:
AccException

getBuddyByName

public AccUser getBuddyByName(java.lang.String name)
                       throws AccException
Finds a user by name in the group.

Throws:
AccException

getSession

public AccSession getSession()
                      throws AccException
The IAccSession associated with the IAccGroup

Throws:
AccException

getOnlineCount

public int getOnlineCount()
                   throws AccException
The number of online buddies in the group

Throws:
AccException

getCollapsed

public boolean getCollapsed()
                     throws AccException
Whether the group is collapsed

Throws:
AccException

setCollapsed

public void setCollapsed(boolean Collapsed)
                  throws AccException
Whether the group is collapsed

Throws:
AccException

getShared

public boolean getShared()
                  throws AccException
Whether the group is "shared"

Throws:
AccException

getRecentBuddies

public boolean getRecentBuddies()
                         throws AccException
Whether the group is the "recent buddies" group

Throws:
AccException

getSmart

public boolean getSmart()
                 throws AccException
Whether the group is a smart group

Throws:
AccException

getReadOnly

public boolean getReadOnly()
                    throws AccException
Whether the group is read-only

Throws:
AccException

getSynchronizedStorageType

public java.lang.String getSynchronizedStorageType()
                                            throws AccException
If synched with a database, the storage type

Throws:
AccException

setSynchronizedStorageType

public void setSynchronizedStorageType(java.lang.String SynchronizedStorageType)
                                throws AccException
If synched with a database, the storage type

Throws:
AccException

getSynchronizedStorageName

public java.lang.String getSynchronizedStorageName()
                                            throws AccException
If synched with a database, the storage name

Throws:
AccException

setSynchronizedStorageName

public void setSynchronizedStorageName(java.lang.String SynchronizedStorageName)
                                throws AccException
If synched with a database, the storage name

Throws:
AccException