Package zowe.client.sdk.zosfiles.uss.methods

Class UssChangeTag

java.lang.Object

zowe.client.sdk.zosfiles.uss.methods.UssChangeTag

public class UssChangeTag
extends Object

Provides Unix System Services (USS) chtag functionality

z/OSMF REST API

Version:

3.0

Author:

James Kostrewski, Frank Giordano

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
Response	binary(String fileNamePath)	Change tag of a UNIX file to binary type
Response	changeCommon(String fileNamePath, ChangeTagParams params)	Change tag of a UNIX file request driven by ChangeTagParams object settings
Response	get(String fileNamePath)	Retrieve existing UNIX file tag information
Response	remove(String fileNamePath)	Remove tag of a UNIX file
Response	text(String fileNamePath, String codeSet)	Change tag of a UNIX file to text type

Methods inherited from class java.lang.Object

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

Constructor Detail

UssChangeTag

public UssChangeTag(ZosConnection connection)

UssChangeTag Constructor

Parameters:

connection - connection information, see ZosConnection object

UssChangeTag

public UssChangeTag(ZosConnection connection,
                    ZosmfRequest request)

Alternative UssChangeTag 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

binary

public Response binary(String fileNamePath)
                throws ZosmfRequestException

Change tag of a UNIX file to binary type

Parameters:

fileNamePath - file name with path

Returns:

Response Object

Throws:

ZosmfRequestException - request error state

text

public Response text(String fileNamePath,
                     String codeSet)
              throws ZosmfRequestException

Change tag of a UNIX file to text type

Parameters:

fileNamePath - file name with path

codeSet - code set name. i.e. IBM-1047

Returns:

Response Object

Throws:

ZosmfRequestException - request error state

remove

public Response remove(String fileNamePath)
                throws ZosmfRequestException

Remove tag of a UNIX file

Parameters:

fileNamePath - file name with path

Returns:

Response Object

Throws:

ZosmfRequestException - request error state

get

public Response get(String fileNamePath)
             throws ZosmfRequestException

Retrieve existing UNIX file tag information

Parameters:

fileNamePath - file name with path

Returns:

Response Object

Throws:

ZosmfRequestException - request error state

changeCommon

public Response changeCommon(String fileNamePath,
                             ChangeTagParams params)
                      throws ZosmfRequestException

Change tag of a UNIX file request driven by ChangeTagParams object settings

Parameters:

fileNamePath - file name with path

params - parameters for the change tag request, see ChangeTagParams object

Returns:

Response Object

Throws:

ZosmfRequestException - request error state