Interface ServerOperation.Request<P>

  • Type Parameters:
    P - Type of the configuration parameter that can be retrieved from this request
    Enclosing interface:
    ServerOperation<P extends ServerOperationParameters<M>,​M extends ServerOperationMessage>

    public static interface ServerOperation.Request<P>
    The client request including operation specific configuration:
    • Method Detail

      • getDocument

        @Deprecated
        Document getDocument()
        Deprecated.
        the functionality to transport multiple documents was added and therefore getDocuments() should be used instead.
        Retrieves a the first or only server side Document that was updated with the client's document state. Please note that this Document instance is actually a copy of the existing server side document in order to cause as little side effects as possible.

        BUT: Changes to the PageSegments (e.g. deleting or adding annotations) will be performed on the original PageSegments (respectively on the original annotations).

        Returns:
        the first or only server side document representing the propagated client document's state
      • getDocuments

        List<Document> getDocuments()
        Retrieves a list of server side Documents that where updated with the client's document state. Please note that the Document instances are actually copies of the existing server side documents in order to cause as little side effects as possible.

        BUT: Changes to the PageSegments (e.g. deleting or adding annotations) will be performed on the original PageSegments (respectively on the original annotations).

        Returns:
        server side documents representing the propagated client document's state
      • getParameters

        P getParameters()
        Retrieves the configuration parameters for this request:
        Returns:
        the configuration parameters for this request
      • isCancelled

        boolean isCancelled()
        Signals whether this ServerOperation.Request was aborted by the client:
        Returns:
        true, if the request was canceled by the client, false else