Interface IReplyProcessor

  • All Known Subinterfaces:
    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.
    Christopher Mindus
    • Method Detail

      • getReplyMatch

        java.lang.String getReplyMatch​(IReplyContent reply)
        Called to verify if the reply matches the reply format of this processor.
        reply - The reply contents.
        null for match, or an error message.
      • getFailureMessage

        java.lang.String getFailureMessage()
        Gets the failure message for the reply.
        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.
        appGyro - The application session gyro in the server, null for Designer.
        output - The output properties.
        reply - The reply contents.
        PropException - For property errors.