com.ibm.wsspi.zos.command.processing

Interface ModifyResults



  • public interface ModifyResults
    Encapsulates the results of processing a MVS modify command received by a CommandHandler.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      int getCompletionStatus()
      Return the completion status indicator.
      java.lang.Object getProperty(java.lang.String key)
      Returns the property given the key from the associated ModifyResults
      java.util.List<java.lang.String> getResponses()
      List of String Objects, each representing a command response message.
      boolean responsesContainMSGIDs()
      Indication that responses contain message identifiers or not.
      void setCompletionStatus(int completionStatus)
      Set a completion status.
      void setProperty(java.lang.String key, java.lang.Object value)
      Sets the property given the key from the associated ModifyResults
      void setResponses(java.util.List<java.lang.String> responses)
      Set List of String Objects, each representing a command response message.
      void setResponsesContainMSGIDs(boolean value)
      Set indication that responses contain message identifiers
    • Field Detail

      • PROCESSED_COMMAND

        static final int PROCESSED_COMMAND
        Completion Status indicator. Indicates that the command was successfully processed.
        See Also:
        Constant Field Values
      • UNKNOWN_COMMAND

        static final int UNKNOWN_COMMAND
        Completion Status indicator. Indicates that the command was unanticipated or unknown to the CommandHandler.
        See Also:
        Constant Field Values
      • ERROR_PROCESSING_COMMAND

        static final int ERROR_PROCESSING_COMMAND
        Completion Status indicator. Indicates that error was encountered while processing the command.
        See Also:
        Constant Field Values
    • Method Detail

      • getResponses

        java.util.List<java.lang.String> getResponses()
        List of String Objects, each representing a command response message. Message strings may be prefixed with a message identifier (Note: method responsesContainMSGIDs indicates the presence of a message identifier). The response message text must be representable in IBM-1047. The messages language should be English for consistency.

        If the responses are not prefixed with message identifier then the command processing code will prefix each response with its own message identifier.

        Returns:
        List of String Objects each representing a command response
      • setResponses

        void setResponses(java.util.List<java.lang.String> responses)
        Set List of String Objects, each representing a command response message. Message strings may be prefixed with a message identifier (Note: method responsesContainMSGIDs indicates the presence of a message identifier).

        If the responses are not prefixed with message identifier then the command processing code will prefix each response with its own message identifier.

        Parameters:
        responses - List of command response String Objects The response message text must be representable in IBM-1047. The messages language should be English for consistency.
      • setCompletionStatus

        void setCompletionStatus(int completionStatus)
        Set a completion status. Valid settings are: PROCESSED_COMMAND, UNKNOWN_COMMAND and ERROR_PROCESSING_COMMAND.
        Parameters:
        completionStatus - completion status indicator representing the results of processing the command
      • getProperty

        java.lang.Object getProperty(java.lang.String key)
        Returns the property given the key from the associated ModifyResults
        Parameters:
        key - key for the property
        Returns:
        property from the associated ModifyResults
      • setProperty

        void setProperty(java.lang.String key,
                       java.lang.Object value)
        Sets the property given the key from the associated ModifyResults
        Parameters:
        key - key for the property
        value - value for the property
      • responsesContainMSGIDs

        boolean responsesContainMSGIDs()
        Indication that responses contain message identifiers or not.
        Returns:
        true if messages start with message identifiers, false otherwise.
      • setResponsesContainMSGIDs

        void setResponsesContainMSGIDs(boolean value)
        Set indication that responses contain message identifiers
        Parameters:
        value - true indicates responses have message identifiers, false otherwise.