Class validates parameters for TSO commands

export

### Hierarchy

- TsoValidator

## Index

### Methods

- validateErrorMessageFromZosmf
- validateIssueParams
- validateNotEmptyString
- validatePingParms
- validatePingZosmfResponse
- validateSession
- validateStartParams
- validateStartZosmfResponse
- validateStopParams
- validateString

## Methods

### Static validateErrorMessageFromZosmf

- validateErrorMessageFromZosmf(zosmfResponse: IZosmfTsoResponse): void

- - Defined in @zowe/zos-tso-for-zowe-sdk/src/TsoValidator.ts:125

  Validate z/OSMF response for errors

  memberof

    TsoValidator

  #### Parameters

  - ##### zosmfResponse: IZosmfTsoResponse

    object response from z/OSMF, @see {IZosmfTsoResponse}

  #### Returns void

### Static validateIssueParams

- validateIssueParams(parms: IIssueTsoParms): void

- - Defined in @zowe/zos-tso-for-zowe-sdk/src/TsoValidator.ts:53

  Validate TSO issue command parameters

  memberof

    TsoValidator

  #### Parameters

  - ##### parms: IIssueTsoParms

    object with required parameters, @see {IIssueTsoParms}

  #### Returns void

### Static validateNotEmptyString

- validateNotEmptyString(text: string, errorMsg: string): void

- - Defined in @zowe/zos-tso-for-zowe-sdk/src/TsoValidator.ts:106

  Validate supplied parameters

  static
  memberof

    TsoValidator

  #### Parameters

  - ##### text: string

    string to check if empty

  - ##### errorMsg: string

    message to show in text case validation fails

  #### Returns void

### Static validatePingParms

- validatePingParms(session: AbstractSession, text: string, errorMsg: string): void

- - Defined in @zowe/zos-tso-for-zowe-sdk/src/TsoValidator.ts:83

  Validate supplied parameters

  static
  memberof

    TsoValidator

  #### Parameters

  - ##### session: AbstractSession

    representing connection to this api

  - ##### text: string

    string to check if not empty or undefined

  - ##### errorMsg: string

    message to show in text case validation fails

  #### Returns void

### Static validatePingZosmfResponse

- validatePingZosmfResponse(parms: IZosmfPingResponse): void

- - Defined in @zowe/zos-tso-for-zowe-sdk/src/TsoValidator.ts:116

  Validate z/OSMF response

  memberof

    TsoValidator

  #### Parameters

  - ##### parms: IZosmfPingResponse

    object response from z/OSMF, @see {IZosmfPingResponse}

  #### Returns void

### Static validateSession

- validateSession(session: AbstractSession): void

- - Defined in @zowe/zos-tso-for-zowe-sdk/src/TsoValidator.ts:34

  Validate session

  static
  memberof

    TsoValidator

  #### Parameters

  - ##### session: AbstractSession

    z/OSMF connection info

  #### Returns void

### Static validateStartParams

- validateStartParams(parms: IStartTsoParms): void

- - Defined in @zowe/zos-tso-for-zowe-sdk/src/TsoValidator.ts:44

  Validate TSO start command parameters

  memberof

    TsoValidator

  #### Parameters

  - ##### parms: IStartTsoParms

    object with required parameters, @see {IStartTsoParms}

  #### Returns void

### Static validateStartZosmfResponse

- validateStartZosmfResponse(parms: IZosmfTsoResponse): void

- - Defined in @zowe/zos-tso-for-zowe-sdk/src/TsoValidator.ts:71

  Validate z/OSMF response, needed for service and filtering servlet key

  memberof

    TsoValidator

  #### Parameters

  - ##### parms: IZosmfTsoResponse

    object response from z/OSMF, @see {IZosmfTsoResponse}

  #### Returns void

### Static validateStopParams

- validateStopParams(parms: IStopTsoParms): void

- - Defined in @zowe/zos-tso-for-zowe-sdk/src/TsoValidator.ts:62

  Validate TSO stop command parameters

  memberof

    TsoValidator

  #### Parameters

  - ##### parms: IStopTsoParms

    object with required parameters, @see {IStopTsoParms}

  #### Returns void

### Static validateString

- validateString(text: string, errorMsg: string): void

- - Defined in @zowe/zos-tso-for-zowe-sdk/src/TsoValidator.ts:95

  Validate supplied parameters

  static
  memberof

    TsoValidator

  #### Parameters

  - ##### text: string

    string to check if not null or undefined

  - ##### errorMsg: string

    message to show in text case validation fails

  #### Returns void

Generated using TypeDoc