com.aol.acc
Class AccBuddyList

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

public class AccBuddyList
extends AccBase

IAccBuddyList maintains the Buddy List information.


Method Summary
 AccUser getBuddyByName(java.lang.String name)
          Finds the buddy in the Buddy List.

 AccUser[] getFrequentBuddies(int num)
          Gets the "num" most frequent-accessed users, as a list of IAccUsers.
If num is 0, a system default is used.

 AccGroup getGroupByIndex(int position)
          Retrieves a specific group by its position in the list.

 AccGroup getGroupByName(java.lang.String name)
          Finds the group in the Buddy List.

 int getGroupCount()
          Get the number of groups in the buddy list.

 int getGroupPosition(AccGroup group)
          Get the group position given a group object.

 int getMaxBuddyCount()
          The maximum number of buddies allowed on the buddy list
 int getMaxBuddyCountPerGroup()
          The maximum number of buddies that can be in a group
 int getMaxBuddyNameLength()
          The maximum length a buddy name can be
 int getMaxGroupCount()
          The maximum number of groups allowed on the buddy list
 int getMaxGroupNameLength()
          The maximum length a group name can be
 boolean getReady()
          Determines if state information has been received for all buddies on the buddy list
 AccSession getSession()
          The IAccSession associated with this buddy list
 AccGroup insertGroup(AccVariant group, int position)
          Inserts a new group to the Buddy List in the given position.
Specify -1 for position to add to the end of the list.

 void moveBuddy(int fromGroup, int fromPosition, int toGroup, int toPosition)
          Moves the position of the given buddy in the Buddy List.

 void moveGroup(int fromPosition, int toPosition)
          Moves the position of the given group in the Buddy List.

 void removeGroup(int position)
          Removes the given group from the Buddy List.

 
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

getGroupCount

public int getGroupCount()
                  throws AccException
Get the number of groups in the buddy list.

Throws:
AccException

getGroupByIndex

public AccGroup getGroupByIndex(int position)
                         throws AccException
Retrieves a specific group by its position in the list.

Throws:
AccException

getGroupPosition

public int getGroupPosition(AccGroup group)
                     throws AccException
Get the group position given a group object.

Throws:
AccException

insertGroup

public AccGroup insertGroup(AccVariant group,
                            int position)
                     throws AccException
Inserts a new group to the Buddy List in the given position.
Specify -1 for position to add to the end of the list.

Throws:
AccException

removeGroup

public void removeGroup(int position)
                 throws AccException
Removes the given group from the Buddy List.

Throws:
AccException

moveGroup

public void moveGroup(int fromPosition,
                      int toPosition)
               throws AccException
Moves the position of the given group in the Buddy List.

Throws:
AccException

moveBuddy

public void moveBuddy(int fromGroup,
                      int fromPosition,
                      int toGroup,
                      int toPosition)
               throws AccException
Moves the position of the given buddy in the Buddy List.

Throws:
AccException

getGroupByName

public AccGroup getGroupByName(java.lang.String name)
                        throws AccException
Finds the group in the Buddy List.

Throws:
AccException

getBuddyByName

public AccUser getBuddyByName(java.lang.String name)
                       throws AccException
Finds the buddy in the Buddy List.

Throws:
AccException

getFrequentBuddies

public AccUser[] getFrequentBuddies(int num)
                             throws AccException
Gets the "num" most frequent-accessed users, as a list of IAccUsers.
If num is 0, a system default is used.

Throws:
AccException

getSession

public AccSession getSession()
                      throws AccException
The IAccSession associated with this buddy list

Throws:
AccException

getMaxGroupCount

public int getMaxGroupCount()
                     throws AccException
The maximum number of groups allowed on the buddy list

Throws:
AccException

getMaxBuddyCount

public int getMaxBuddyCount()
                     throws AccException
The maximum number of buddies allowed on the buddy list

Throws:
AccException

getMaxGroupNameLength

public int getMaxGroupNameLength()
                          throws AccException
The maximum length a group name can be

Throws:
AccException

getMaxBuddyNameLength

public int getMaxBuddyNameLength()
                          throws AccException
The maximum length a buddy name can be

Throws:
AccException

getMaxBuddyCountPerGroup

public int getMaxBuddyCountPerGroup()
                             throws AccException
The maximum number of buddies that can be in a group

Throws:
AccException

getReady

public boolean getReady()
                 throws AccException
Determines if state information has been received for all buddies on the buddy list

Throws:
AccException