NvdmAPI
Class NvdmList

java.lang.Object
  NvdmAPI.NvdmList

public class NvdmList

extends java.lang.Object

Container class for object names or class names. It basically wraps java.util.Vector and adds file, domain, class, and instance information, as well as an error code. NvdmList objects are used to pass back lists of object names or lists of class names etc. That's why they cannot be instantiated directly.

Version:

1.0, 6-Oct-2002

Author:

Lothar Baum

Method Summary

void	dump(java.io.PrintStream where) Dumps the contents of the list to a stream.
java.lang.String	getClss() Returns the class name this list was created for.
java.lang.String	getDomain() Returns the domain name this list was created for.
java.util.Enumeration	getEntries() Returns an enumeration of the list contents.
java.lang.String	getFile() Returns the file name this list was created for.
java.lang.String	getInstance() Returns the instance name this list was created for.
int	getRC() Returns the error code of the operation that created this list.
boolean	isOk() Tests if operation completed successfully.
int	size() Returns the number of elements in the list.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public java.lang.String getInstance()

Returns the instance name this list was created for. The name may contain wildcards (*).

Returns:

instance name the list was created for

getClss

public java.lang.String getClss()

Returns the class name this list was created for. The name may contain wildcards (*).

Returns:

class name the list was created for

getFile

public java.lang.String getFile()

Returns the file name this list was created for.

Returns:

file name the list was created for

getDomain

public java.lang.String getDomain()

Returns the domain name this list was created for.

Returns:

domain name the list was created for

getRC

public int getRC()

Returns the error code of the operation that created this list.

Returns:

0 if successful, or an error code > 0 (see RTE.getErrorText)

size

public int size()

Returns the number of elements in the list.

Returns:

the number of elements in the list (0 if empty)

isOk

public boolean isOk()

Tests if operation completed successfully. Basically a shortcut for testing getRC to be 0.

Returns:

true if list could successfully be retrieved from RCS, false in the case of an error

getEntries

public java.util.Enumeration getEntries()

Returns an enumeration of the list contents. Enumerates NvdmEntity objects.

Returns:

enumeration of NvdmEntity objects

dump

public void dump(java.io.PrintStream where)

Dumps the contents of the list to a stream. May be used for debugging purposes to see the contents of this container object.

Parameters:

where - the stream where to dump the information