com.adobe.livecycle.rca.common.beans
Class RCADocument

java.lang.Object
  com.adobe.livecycle.rca.common.beans.RCADocument

All Implemented Interfaces:

Serializable

public class RCADocument
extends Object
implements Serializable

A wrapper class over Document. Because it is not possible to add attributes DocumentReference object in flex, to workaround that issue. We have created this wrapper class. This class is used to send information about supporting documents to RCA apis. Supporting documents can be of type links or documents. RCADocument can be used to send information about a uri which points to any publicly accessible url. Or send represent a com.adobe.idp.Document object that will be stored in Review Zone as supporting document. If you want to attach a url as supporting document, to initiateReview or storeReviewTemplate, then you must create RCADocument object as follows: RCADocument supportingDoc = new RCADocument(); supportingDoc.setUri("http://www.adobe.com"); supportingDoc.setType(RCADocument.Type.REF); supportingDoc.setDescription("Link to adobe.com"); supportingDoc.setName("Supporting DOcument One"); if you want to to attach a Document as supporting document, to initiateReview or storeReviewTemplate, then you must create RCADocument object as follows: RCADocument supportingDoc = new RCADocument(); Document idpDoc = new Document(new File("c:\\test.pdf"), false); idpDoc.setContentType("application/pdf"); //make sure that content type is always set supportingDoc.setDocument(); supportingDoc.setType(RCADocument.Type.DOCUMENT); supportingDoc.setDescription("Link to adobe.com"); supportingDoc.setName("Supporting DOcument One");

See Also:

Serialized Form

Nested Class Summary

static class

RCADocument.Type Enumeration that defines type of RCADocument.

Constructor Summary

RCADocument()

Method Summary

String	getDescription() Gets the description of the document
com.adobe.idp.Document	getDocument() Gets com.adobe.idp.DOcument object wrapped in RCADocument
String	getName() Gets the name of the document
RCADocument.Type	getType() Get the type of RCADocument.
String	getUri() Retrieves the uri of the RCADocument.
void	setDescription(String description) Sets the description of the document
void	setDocument(com.adobe.idp.Document document) Sets com.adobe.idp.DOcument object wrapped in RCADocument.
void	setName(String name) Sets the name of the document
void	setType(RCADocument.Type type) Get the type of RCADocument.
void	setUri(String uri) Sets the uri of the RCADocument

Methods inherited from class java.lang.Object

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

Constructor Detail

RCADocument

public RCADocument()

Method Detail

getDocument

public com.adobe.idp.Document getDocument()

Gets com.adobe.idp.DOcument object wrapped in RCADocument

Returns:

com.adobe.idp.DOcument

setDocument

public void setDocument(com.adobe.idp.Document document)

Sets com.adobe.idp.DOcument object wrapped in RCADocument. DOcument should only be set if type is DOCUMENT.

getUri

public String getUri()

Retrieves the uri of the RCADocument.

Returns:

setUri

public void setUri(String uri)

Sets the uri of the RCADocument

Parameters:

uri -

getType

public RCADocument.Type getType()

Get the type of RCADocument.

Returns:

Type is an enum that can have only two values REF,DOCUMENT

setType

public void setType(RCADocument.Type type)

Get the type of RCADocument. Type is an enum that can have only two values REF,DOCUMENT

Parameters:

type - Type is an enum that can have only two values REF,DOCUMENT.

getName

public String getName()

Gets the name of the document

Returns:

setName

public void setName(String name)

Sets the name of the document

Parameters:

name - name of the document

getDescription

public String getDescription()

Gets the description of the document

Returns:

description of the document

setDescription

public void setDescription(String description)

Sets the description of the document

Parameters:

description - description of the document