Class ConsoleValidator

Class validates parameters for console commands

export

Hierarchy

ConsoleValidator

Index

Methods

Methods

Static validateCollectCommonParms

validateCollectCommonParms(session: AbstractSession, consoleName: string, commandResponseKey: string): void

- Defined in @zowe/zos-console-for-zowe-sdk/src/ConsoleValidator.ts:90
Validate supplied parameters

static

memberof

ConsoleValidator

Parameters
- session: AbstractSession
  
  representing connection to this api
- consoleName: string
  
  name of the EMCS console that is used to issue the command
- commandResponseKey: string
  
  command response key from the Issue Command request
Returns void

Static validateCollectParm

validateCollectParm(parms: ICollectParms): void

- Defined in @zowe/zos-console-for-zowe-sdk/src/ConsoleValidator.ts:68
Validate supplied parameters

static

memberof

ConsoleValidator

Parameters
- parms: ICollectParms
  
  console collect parameters, @see {ICollectParms}
Returns void

Static validateCollectParms

validateCollectParms(session: AbstractSession, parms: ICollectParms): void

- Defined in @zowe/zos-console-for-zowe-sdk/src/ConsoleValidator.ts:103
Validate supplied parameters

static

memberof

ConsoleValidator

Parameters
- session: AbstractSession
  
  representing connection to this api
- parms: ICollectParms
  
  console collect parameters, @see {ICollectParms}
Returns void

Static validateCommonParms

validateCommonParms(session: AbstractSession, consoleName: string, commandParms: IZosmfIssueParms): void

- Defined in @zowe/zos-console-for-zowe-sdk/src/ConsoleValidator.ts:32
Validate supplied parameters

static

memberof

Parameters
- session: AbstractSession
  
  representing connection to this api
- consoleName: string
  
  name of the EMCS console that is used to issue the command
- commandParms: IZosmfIssueParms
  
  synchronous console issue parameters, @see {IZosmfIssueParms}
Returns void

Static Private validateConsoleName

validateConsoleName(consoleName: string): void

- Defined in @zowe/zos-console-for-zowe-sdk/src/ConsoleValidator.ts:125
Validate console name

static

memberof

ConsoleValidator

Parameters
- consoleName: string
Returns void

Static validateIssueParm

validateIssueParm(parms: IIssueParms): void

- Defined in @zowe/zos-console-for-zowe-sdk/src/ConsoleValidator.ts:78
Validate supplied parameters

static

memberof

ConsoleValidator

Parameters
- parms: IIssueParms
  
  console issue parameters, @see {IIssueParms}
Returns void

Static validateIssueParms

validateIssueParms(session: AbstractSession, parms: IIssueParms): void

- Defined in @zowe/zos-console-for-zowe-sdk/src/ConsoleValidator.ts:45
Validate supplied parameters

static

memberof

ConsoleValidator

Parameters
- session: AbstractSession
  
  representing connection to this api
- parms: IIssueParms
  
  console issue parameters, @see {IIssueParms}
Returns void

Static validateIssueSimpleParms

validateIssueSimpleParms(session: AbstractSession, theCommand: string): void

- Defined in @zowe/zos-console-for-zowe-sdk/src/ConsoleValidator.ts:57
Validate supplied parameters

static

memberof

ConsoleValidator

Parameters
- session: AbstractSession
  
  representing connection to this api
- theCommand: string
  
  command to issue
Returns void

Static Private validateSession

validateSession(session: AbstractSession): void

- Defined in @zowe/zos-console-for-zowe-sdk/src/ConsoleValidator.ts:114
Validate session

static

memberof

ConsoleValidator

Parameters
- session: AbstractSession
  
  representing connection to this api
Returns void

Generated using TypeDoc