com.adobe.livecycle.signatures.client.spi.types
Class SignResponse

java.lang.Object
  com.adobe.livecycle.signatures.client.spi.types.SignResponse

All Implemented Interfaces:

java.io.Serializable

public class SignResponse
extends java.lang.Object
implements java.io.Serializable

A SignResponse object is returned by the Signature service when a document is signed using a signature handler. This object specifies whether the sign request was successful.

For information about creating a signature handler, see the Creating Signature Handlers section in Programming with LiveCycle ES4.

See Also:

Serialized Form

Constructor Summary

SignResponse()

SignResponse(Result result, SignatureObject signatureObject, java.lang.String requestID, int sigSize)
A constructor that creates a SignResponse object.

Method Summary

java.lang.String	getRequestID() Retrieves the request identifier value.
Result	getResult() Retrieves the result of the sign request.
SignatureObject	getSignatureObject() Retrieves the resultant signature or timestamp, if the sign request succeeds.
int	getSignatureSize() Returns the signature size in bytes.
void	setRequestID(java.lang.String requestID) Sets the request identifier value.
void	setResult(Result result) Sets the result of the sign request.
void	setSignatureObject(SignatureObject signatureObject) Sets the resultant signature or timestamp.
void	setSignatureSize(int signatureSize) Sets the signature size in bytes.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SignResponse

public SignResponse(Result result,
                    SignatureObject signatureObject,
                    java.lang.String requestID,
                    int sigSize)

A constructor that creates a SignResponse object. This object is created by the Signature service.

Parameters:

result - A Result object that specifies the status of the sign request.

signatureObject - A SignatureObject object that represents the resultant signature or timestamp, if the request succeeds.

requestID - A string value that specifies the request identifier value.

sigSize - Specifiies a size that is used if the predictSize run-time value is used.

SignResponse

public SignResponse()

Method Detail

getRequestID

public java.lang.String getRequestID()

Retrieves the request identifier value. When this value is present in a sign request, it is returned in a sign reponse.

Returns:

A string value that specifies the request identifier value.

setRequestID

public void setRequestID(java.lang.String requestID)

Sets the request identifier value.

Parameters:

requestID - A string value that specifies the request identifier value.

getResult

public Result getResult()

Retrieves the result of the sign request.

Returns:

A Result object that specifies the result of the sign request.

setResult

public void setResult(Result result)

Sets the result of the sign request.

Parameters:

result - A Result object that specifies the result of the sign request.

getSignatureObject

public SignatureObject getSignatureObject()

Retrieves the resultant signature or timestamp, if the sign request succeeds.

Returns:

A SignatureObject object that represents the resultant signature or timestamp.

setSignatureObject

public void setSignatureObject(SignatureObject signatureObject)

Sets the resultant signature or timestamp.

Parameters:

signatureObject - A SignatureObject object that represents the resultant signature or timestamp.

getSignatureSize

public int getSignatureSize()

Returns the signature size in bytes. The Signature service does not use this function to calculate the signature size. It determines the signature size by checking the length of the the signature bytes.

Returns:

An integer value that specifies the byte size of the signauture.

setSignatureSize

public void setSignatureSize(int signatureSize)

Sets the signature size in bytes.

Parameters:

signatureSize - An integer value that specifies the byte size of the signauture.