Package zowe.client.sdk.zosfiles.dsn.methods

Class DsnList

java.lang.Object

zowe.client.sdk.zosfiles.dsn.methods.DsnList

public class DsnList
extends Object

Provides list dataset and member functionality

Version:

3.0

Author:

Frank Giordano

Constructor Summary

Constructors

Constructor	Description
DsnList(ZosConnection connection)	DsnList constructor
DsnList(ZosConnection connection, ZosmfRequest request)	Alternative DsnList constructor with ZoweRequest object.

Method Summary

Modifier and Type	Method	Description
List<Dataset>	getDatasets(String dataSetName, ListParams params)	Get a list of Dataset objects
List<Member>	getMembers(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

DsnList

public DsnList(ZosConnection connection)

DsnList constructor

Parameters:

connection - connection information, see ZosConnection object

DsnList

public DsnList(ZosConnection connection,
               ZosmfRequest request)

Alternative DsnList 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 object

Method Detail

getDatasets

public List<Dataset> getDatasets(String dataSetName,
                                 ListParams params)
                          throws ZosmfRequestException

Get a list of Dataset objects

Parameters:

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

params - list parameters, see ListParams object

Returns:

A String list of Dataset names

Throws:

ZosmfRequestException - request error state

getMembers

public List<Member> getMembers(String dataSetName,
                               ListParams params)
                        throws ZosmfRequestException

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:

ZosmfRequestException - request error state