Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ZosTsoBaseHandler

Hierarchy

  • ZosmfBaseHandler
    • ZosTsoBaseHandler

Implements

  • ICommandHandler

Index

Properties

Protected mArguments

mArguments: ICommandArguments

Command line arguments passed

Protected mHandlerParams

mHandlerParams: IHandlerParameters

Full set of command handler parameters from imperative

Protected mSession

mSession: AbstractSession

The session creating from the command line arguments / profile

Protected mTsoStart

mTsoStart: IStartTsoParms

The parameter object required to issue start commands

Protected mZosmfLoadedProfile

mZosmfLoadedProfile: IProfileLoaded

Loaded z/OSMF profile with meta information

Protected mZosmfProfile

mZosmfProfile: IProfile

Loaded z/OSMF profile if needed

Accessors

console

  • get console(): IHandlerResponseConsoleApi
  • Returns the console interface for the command handler

    Returns IHandlerResponseConsoleApi

data

  • get data(): IHandlerResponseDataApi
  • Returns the format interface for the command handler

    Returns IHandlerResponseDataApi

format

  • get format(): IHandlerFormatOutputApi
  • Returns the format interface for the command handler

    Returns IHandlerFormatOutputApi

progress

  • get progress(): IHandlerProgressApi
  • Returns the format interface for the command handler

    Returns IHandlerProgressApi

Methods

fail

  • fail(err: IImperativeError): void
  • Fail the command with an imperative error

    Parameters

    • err: IImperativeError

      the imperative error parameters

    Returns void

process

  • process(params: IHandlerParameters): Promise<void>
  • This will grab the arguments and create the tso parameter object for APIs before invoking the actual TSO handler. {@link ZosmfBaseHandler#processWithSession} method.

    Parameters

    • params: IHandlerParameters

      Command parameters sent by imperative.

    Returns Promise<void>

Abstract processCmd

  • processCmd(commandParameters: IHandlerParameters): Promise<void>
  • This is called by the {@link ZosmfBaseHandler#process} after it creates a session.

    Parameters

    • commandParameters: IHandlerParameters

      Command parameters sent to the handler.

    Returns Promise<void>

Generated using TypeDoc