com.vwp.vuapi.user
Class VUUserInfo

java.lang.Object
  com.vwp.vuapi.util.VUInfo
      com.vwp.vuapi.user.VUUserInfo

public class VUUserInfo
extends VUInfo

This class is a container for user-related information like they are provided by the different listeners. Please note: fields that are currently not available, e.g. because the listener context isn't able to provide all user-related information are initialized with null or -1. Please use the VUInfoTool to collect all available information and to store lists of users.

Field Summary

int	visibility visibility information for a user; please see the VUInterface.VU_USER_xxx-constants for allowed values

Fields inherited from class com.vwp.vuapi.util.VUInfo

ID, name

Constructor Summary

VUUserInfo(int ID)
Constructor for a new VUUserInfo object; this constructor is used by the API only, there is no valid operation that makes it necessary for an application to use it.

VUUserInfo(String name, int visibility)
Constructor for a new VUUserInfo object; this constructor is used by the API only, there is no valid operation that makes it necessary for an application to use it.

VUUserInfo(String name, int ID, int visibility)
Constructor for a new VUUserInfo object; this constructor is used by the API only, there is no valid operation that makes it necessary for an application to use it.

Method Summary

void	set(VUUserInfo ui) This method sets the available values of the given VUUserInfo object, that means, memebers of the given parameter that are not -1 and not null are copied to the related members of this object

Methods inherited from class com.vwp.vuapi.util.VUInfo

set

Methods inherited from class java.lang.Object

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

Field Detail

visibility

public int visibility

visibility information for a user; please see the VUInterface.VU_USER_xxx-constants for allowed values

Constructor Detail

VUUserInfo

public VUUserInfo(String name,
                  int visibility)

Constructor for a new VUUserInfo object; this constructor is used by the API only, there is no valid operation that makes it necessary for an application to use it.

Parameters:

name - the name of the user

visibility - flags for that user (please see the VUInterface.VU_USER_xxx-constants for allowed values)

VUUserInfo

public VUUserInfo(String name,
                  int ID,
                  int visibility)

Constructor for a new VUUserInfo object; this constructor is used by the API only, there is no valid operation that makes it necessary for an application to use it.

Parameters:

name - the name of the user

ID - a unique identifier that specifies this user non-ambiguous, this identifier is created by the API

visibility - flags for that user (please see the VUInterface.VU_USER_xxx-constants for allowed values)

VUUserInfo

public VUUserInfo(int ID)

Constructor for a new VUUserInfo object; this constructor is used by the API only, there is no valid operation that makes it necessary for an application to use it.

Parameters:

ID - a unique identifier that specifies this user non-ambiguous, this identifier is created by the API

Method Detail

set

public void set(VUUserInfo ui)

This method sets the available values of the given VUUserInfo object, that means, memebers of the given parameter that are not -1 and not null are copied to the related members of this object

Parameters:

ui - the VUUserInfo object to copy the available members from