Package com.ibm.as400.resource

Class RUserList

java.lang.Object

com.ibm.as400.resource.ResourceList

com.ibm.as400.resource.BufferedResourceList

com.ibm.as400.resource.SystemResourceList

com.ibm.as400.resource.RUserList

All Implemented Interfaces:

Serializable

public class RUserList
extends SystemResourceList

Deprecated.

Use UserList instead, as this package may be removed in the future.

The RUserList class represents a list of users on the system. The following selection IDs are supported:

• SELECTION_CRITERIA
• GROUP_PROFILE
• USER_PROFILE

Use one or more of these selection IDs with getSelectionValue() and setSelectionValue() to access the selection values for an RUserList.

RUserList objects generate RUser objects.

// Create an RUserList object to represent a list of users.
AS400 system = new AS400("MYSYSTEM", "MYUSERID", "MYPASSWORD");
RUserList userList = new RUserList(system);


// Set the selection so that only user profiles
// that are group profiles are included in the list.
userList.setSelectionValue(RUserList.SELECTION_CRITERIA, RUserList.GROUP);


// Open the list and wait for it to complete.
userList.open();
userList.waitForComplete();


// Read and print the user profile names and text
// descriptions for the users in the list.
long numberOfUsers = userList.getListLength();
for(long i = 0; i < numberOfUsers; ++i)
{
    RUser user = (RUser)userList.resourceAt(i);
    System.out.println(user.getAttributeValue(RUser.USER_PROFILE_NAME));
    System.out.println(user.getAttributeValue(RUser.TEXT_DESCRIPTION));
    System.out.println();
}


// Close the list.
userList.close();

See Also:

RUser, Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALL	Deprecated. Selection value indicating that the list contains all user profiles and group profiles.
static String	GROUP	Deprecated. Selection value indicating that the list contains only user profiles that are group profiles.
static String	GROUP_PROFILE	Deprecated. Selection ID for group profile.
static String	MEMBER	Deprecated. Selection value indicating that the list contains only user profiles that are members of a specified group.
static String	NOGROUP	Deprecated. Selection value indicating that the list contains only user profiles that are not group profiles.
static String	NONE	Deprecated. Selection value indicating that no group profile is specified.
static String	SELECTION_CRITERIA	Deprecated. Selection ID for selection criteria.
static String	USER	Deprecated. Selection value indicating that the list contains only user profiles that are not group profiles.
static String	USER_PROFILE	Deprecated. Selection ID for user profile.

Constructor Summary

Constructors

Constructor	Description
RUserList()	Deprecated. Constructs an RUserList object.
RUserList(AS400 system)	Deprecated. Constructs an RUserList object.

Method Summary

Modifier and Type	Method	Description
protected void	establishConnection()	Deprecated. Establishes the connection to the system.

Methods inherited from class com.ibm.as400.resource.SystemResourceList

close, isBidiEnabled, isResourceAvailable, open, refreshContents, refreshStatus, resourceAt, setSelectionValue, waitForComplete, waitForResource

Methods inherited from class com.ibm.as400.resource.BufferedResourceList

fireResourceAdded, getNumberOfPages, getPageSize, setNumberOfPages, setPageSize

Methods inherited from class com.ibm.as400.resource.ResourceList

addActiveStatusListener, addPropertyChangeListener, addResourceListListener, addVetoableChangeListener, arePropertiesFrozen, fireBusy, fireIdle, fireLengthChanged, fireListClosed, fireListCompleted, fireListInError, fireListOpened, firePropertyChange, fireVetoableChange, freezeProperties, getAttributeMetaData, getAttributeMetaData, getListLength, getPresentation, getSelectionMetaData, getSelectionMetaData, getSelectionValue, getSelectionValue, getSortMetaData, getSortMetaData, getSortOrder, getSortValue, getSystem, isComplete, isConnectionEstablished, isInError, isOpen, removeActiveStatusListener, removePropertyChangeListener, removeResourceListListener, removeVetoableChangeListener, resources, setAttributeMetaData, setPresentation, setSelectionValue, setSortOrder, setSortValue, setSystem, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ALL

public static final String ALL

Deprecated.

Selection value indicating that the list contains all user profiles and group profiles.

See Also:

Constant Field Values

USER

public static final String USER

Deprecated.

Selection value indicating that the list contains only user profiles that are not group profiles. These are user profiles that do not have a group identifier specified.

See Also:

Constant Field Values

GROUP

public static final String GROUP

Deprecated.

Selection value indicating that the list contains only user profiles that are group profiles. These are user profiles that have a group identifier specified.

See Also:

Constant Field Values

MEMBER

public static final String MEMBER

Deprecated.

Selection value indicating that the list contains only user profiles that are members of a specified group.

See Also:

Constant Field Values

NONE

public static final String NONE

Deprecated.

Selection value indicating that no group profile is specified.

See Also:

Constant Field Values

NOGROUP

public static final String NOGROUP

Deprecated.

Selection value indicating that the list contains only user profiles that are not group profiles. These are user profiles that do not have a group identifier specified.

See Also:

Constant Field Values

SELECTION_CRITERIA

public static final String SELECTION_CRITERIA

Deprecated.

Selection ID for selection criteria. This identifies a String selection, which represents which users are returned. Possible values are:

• ALL - All user profiles and group profiles are returned.
• USER - Only user profiles that are not group profiles are returned. These are user profiles that do not have a group identifier specified.
• GROUP - Only user profiles that are group profiles are returned. These are user profiles that have a group identifier specified.
• MEMBER - User profiles that are members of the group specified for the GROUP_PROFILE selection value are returned.

See Also:

Constant Field Values

GROUP_PROFILE

public static final String GROUP_PROFILE

Deprecated.

Selection ID for group profile. This identifies a String selection, which represents the group profile whose members are to be returned. Possible values are:

• NONE - No group profile is specified.
• NOGROUP - Users who are not a member of any group are returned.
• The group profile name - Users who are a member of this group are returned.

This must be set to a group profile name or NOGROUP if SELECTION_CRITERIA is set to MEMBER. This must be set to NONE if SELECTION_CRITERIA is not set to MEMBER.

See Also:

Constant Field Values

USER_PROFILE

public static final String USER_PROFILE

Deprecated.

Selection ID for user profile. This identifies a String selection, which represents the user profile specification that describes the users to be included in the list. The user profile can be specified only when connecting to systems running OS/400 V5R1 or later. Possible values are:

• ALL - All users are specified.
• The generic user profile name. A generic name is a String which contains one or more characters followed by an '*'.
• The user profile name.

See Also:

Constant Field Values

Constructor Detail

RUserList

public RUserList()

Deprecated.

Constructs an RUserList object.

RUserList

public RUserList(AS400 system)

Deprecated.

Constructs an RUserList object.

Parameters:

system - The system.

Method Detail

establishConnection

protected void establishConnection()
                            throws ResourceException

Deprecated.

Establishes the connection to the system.

The method is called by the resource framework automatically when the connection needs to be established.

Overrides:

establishConnection in class ResourceList

Throws:

ResourceException - If an error occurs.