Package com.iizix.ws.api

Interface IReplyProcessor

All Known Subinterfaces:
IEditorReplyProcessor
All Known Implementing Classes:
EditorJSONReplyDocument, JSONReplyDocument
public interface IReplyProcessor
Reply processor interface for the Web Service output. A class can choose to match the reply contents received from the Web Service transaction for further processing. If this processor do not match the content, the next in chain will handle the reply.
Author:
Christopher Mindus

  • Method Details

    • getReplyMatch

      String getReplyMatch(IReplyContent reply)
      Called to verify if the reply matches the reply format of this processor.
      Parameters:
      reply - The reply contents.
      Returns:
      null for match, or an error message.

    • getFailureMessage

      String getFailureMessage()
      Gets the failure message for the reply.
      Returns:
      null to proceed processing, or a String as message to throw to abort the web service.

    • processReply

      void processReply(IAppSessionGyro appGyro, OutputProps output, IReplyContent reply) throws PropException
      Processes the reply contents for the Web Service.
      Parameters:
      appGyro - The application session gyro in the server, null for Designer.
      output - The output properties.
      reply - The reply contents.
      Throws:
      PropException - For property errors.