com.adobe.icc.dbforms.obj
Class PortfolioDocument

java.lang.Object
  com.adobe.icc.dbforms.obj.Asset
      com.adobe.icc.dbforms.obj.PortfolioDocument

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ConditionalDocument

public class PortfolioDocument
extends Asset
implements Serializable

POJO representation of a Document that is part of a Portfolio.
A Document may either be a file or a Letter template, determined by the docSource.
If it is a file, the docContent determines the content of the Document, else the letter reference determines the final content for the Document.

See Also:

Serialized Form

Nested Class Summary

static class

PortfolioDocument.DocumentSource Enum to specify the source of this document.

Field Summary

static String	ASSOCIATION_CUTPOINT
static String	FIRST_LEVEL_CUTPOINT
static String	HIERARCHY_CUTPOINT
static String	PD_CLASS

Fields inherited from class com.adobe.icc.dbforms.obj.Asset

ASSET_CLASS

Constructor Summary

PortfolioDocument()
Default constructor

PortfolioDocument(String id, String name, String desc, String comment, int state, PortfolioDocument.DocumentSource docSource, byte[] docContent, String docReference, Category ucat, Category lcat, int version, Date activeStartDate, Date activeEndDate, String lastChangeBy, String mimeType)
Constructor from parameters.

Method Summary

byte[]	getDocContent() Get the content (byte array) of the Document.
String	getDocReference() Get the reference (Letter GUID) of the Document (only if docSource is CTD).
PortfolioDocument.DocumentSource	getDocSource() Get the source of the Document.
Letter	getLetter() Get the associated Letter template for the Document (only if docSource is CTD).
String	getMimeType() Get the mime type of the Document.
void	setDocContent(byte[] docContent) Sets the content (byte array) of the Document.
void	setDocReference(String docReference) Sets the reference (Letter GUID) of the Document (only if docSource is CTD).
void	setDocSource(PortfolioDocument.DocumentSource docSource) Sets the source of the Document.
void	setLetter(Letter letter) Sets the associated Letter template for the Document (only if docSource is CTD).
void	setMimeType(String mimeType) Sets the mime type of the Document.

Methods inherited from class com.adobe.icc.dbforms.obj.Asset

getActiveEndDate, getActiveStartDate, getComment, getDesc, getExtendedProperties, getId, getLastChangeBy, getLastPublishDate, getLastUpdateDate, getLcat, getName, getState, getUcat, getUpdatedBy, getVersion, setActiveEndDate, setActiveStartDate, setComment, setDesc, setExtendedProperties, setId, setLastChangeBy, setLastPublishDate, setLastUpdateDate, setLcat, setName, setState, setUcat, setUpdatedBy, setVersion

Methods inherited from class java.lang.Object

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

Field Detail

PD_CLASS

public static final String PD_CLASS

ASSOCIATION_CUTPOINT

public static final String ASSOCIATION_CUTPOINT

HIERARCHY_CUTPOINT

public static final String HIERARCHY_CUTPOINT

FIRST_LEVEL_CUTPOINT

public static final String FIRST_LEVEL_CUTPOINT

Constructor Detail

PortfolioDocument

public PortfolioDocument()

Default constructor

PortfolioDocument

public PortfolioDocument(String id,
                         String name,
                         String desc,
                         String comment,
                         int state,
                         PortfolioDocument.DocumentSource docSource,
                         byte[] docContent,
                         String docReference,
                         Category ucat,
                         Category lcat,
                         int version,
                         Date activeStartDate,
                         Date activeEndDate,
                         String lastChangeBy,
                         String mimeType)

Constructor from parameters.

Parameters:

id - unique identifier of the Document.

name - name of the Document.

desc - description of the Document.

comment - comment for the Document.

state - state of the Document.

docSource - data source of the Document.

docContent - content of of the Document if the docSource is FILE.

docReference - id of the Letter, if the docSource is CTD.

ucat - Category of the Document.

lcat - Subcategory of the Document.

version - version of the Document.

activeStart - activation start date of the Document.

activeEnd - activation end date of the Document.

lastChangeBy - user creating the Document.

mimeType - mime type of the Document.

Method Detail

getDocSource

public PortfolioDocument.DocumentSource getDocSource()

Get the source of the Document.

Returns:

The source of the Document.

See Also:

PortfolioDocument.DocumentSource

setDocSource

public void setDocSource(PortfolioDocument.DocumentSource docSource)

Sets the source of the Document.

Parameters:

docSource - The source of the Document.

getDocContent

public byte[] getDocContent()

Get the content (byte array) of the Document.

Returns:

The content (byte array) of the Document.

setDocContent

public void setDocContent(byte[] docContent)

Sets the content (byte array) of the Document.

Parameters:

docContent - The content (byte array) of the Document.

getDocReference

public String getDocReference()

Get the reference (Letter GUID) of the Document (only if docSource is CTD).

Returns:

The reference (Letter GUID) of the Document

setDocReference

public void setDocReference(String docReference)

Sets the reference (Letter GUID) of the Document (only if docSource is CTD).

Parameters:

docReference - The reference (Letter GUID) of the Document

getMimeType

public String getMimeType()

Get the mime type of the Document.

Returns:

The mime type of the Document.

setMimeType

public void setMimeType(String mimeType)

Sets the mime type of the Document.

Parameters:

mimeType - The mime type of the Document.

getLetter

public Letter getLetter()

Get the associated Letter template for the Document (only if docSource is CTD).

Returns:

The associated Letter template for the Document.

setLetter

public void setLetter(Letter letter)

Sets the associated Letter template for the Document (only if docSource is CTD).

Parameters:

letter - The associated Letter template for the Document.