Package zowe.client.sdk.zosfiles

Class ZosDsnList

java.lang.Object

zowe.client.sdk.zosfiles.ZosDsnList

public class ZosDsnList
extends Object

ZosDsnList class that provides Dataset member list function

Version:

1.0

Author:

Nikunj Goyal

Constructor Summary

Constructors

Constructor	Description
ZosDsnList(ZOSConnection connection)	ZosDsnList constructor
ZosDsnList(ZOSConnection connection, ZoweRequest request)	Alternative ZosDsnList constructor with ZoweRequest object.

Method Summary

Modifier and Type	Method	Description
List<Dataset>	listDsn(String dataSetName, ListParams params)	Get a list of Dataset names
List<Member>	listDsnMembers(String dataSetName, ListParams params)	Get a list of member objects from a partition Dataset

Methods inherited from class java.lang.Object

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

Constructor Detail

ZosDsnList

public ZosDsnList(ZOSConnection connection)

ZosDsnList constructor

Parameters:

connection - connection information, see ZOSConnection object

ZosDsnList

public ZosDsnList(ZOSConnection connection,
                  ZoweRequest request)
           throws Exception

Alternative ZosDsnList constructor with ZoweRequest object. This is mainly used for internal code unit testing with mockito, and it is not recommended to be used by the larger community.

Parameters:

connection - connection information, see ZOSConnection object

request - any compatible ZoweRequest Interface type object

Throws:

Exception - processing error

Method Detail

listDsn

public List<Dataset> listDsn(String dataSetName,
                             ListParams params)
                      throws Exception

Get a list of Dataset names

Parameters:

dataSetName - name of a dataset (e.g. 'DATASET.LIB')

params - list parameters, see ListParams object

Returns:

A String list of Dataset names

Throws:

Exception - error processing request

listDsnMembers

public List<Member> listDsnMembers(String dataSetName,
                                   ListParams params)
                            throws Exception

Get a list of member objects from a partition Dataset

Parameters:

dataSetName - name of a dataset (e.g. 'DATASET.LIB')

params - list parameters, see ListParams object

Returns:

list of member objects

Throws:

Exception - error processing request