com.adobe.icc.dbforms.obj
Class Portfolio

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

All Implemented Interfaces:

ILocalizable, ILocalizationResourceContainer, java.io.Serializable

public final class Portfolio
extends Asset
implements java.io.Serializable

POJO representation of a Portfolio template.

A Portfolio template would contain a navigator, cover page, rootFolder. The rootFolder is of type PortfolioFolder, that would in-turn have sub-PortfolioFolders and PortfolioDocuments in it.

See Also:

Serialized Form

Field Summary

static java.lang.String	ASSOCIATION_CUTPOINT For internal use.
static java.lang.String	FIRST_LEVEL_CUTPOINT For internal use.
static java.lang.String	HIERARCHY_CUTPOINT For internal use.
static java.lang.String	PF_CLASS For internal use.

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

ASSET_CLASS, FIRST_LEVEL_WITH_CAT_NAMES_CUTPOINT

Constructor Summary

Portfolio()
Default constructor

Portfolio(java.lang.String id, java.lang.String name, java.lang.String desc, java.lang.String comment, int state, Category ucat, Category lcat, int version, java.util.Date activeStartDate, java.util.Date activeEndDate, java.lang.String lastChangeBy, PortfolioDocument navigator, PortfolioDocument cover, PortfolioFolder rootFolder)
Constructor from parameters.

Method Summary

PortfolioDocument	getCover() Get the cover page document of the Portfolio.
java.lang.String	getDataDictionaryRef() This method retrieves the first data dictionary reference from the list of DataDictionaryRef's
java.util.List	getDataDictionaryRefs() Get the DataDictionary references(names) for the Portfolio.
PortfolioDocument	getNavigator() Get the navigator of the Portfolio.
PortfolioFolder	getRootFolder() Get the root folder of the Portfolio.
java.util.Set	getVariableAssignments() Get the VariableAssignments for the Portfolio.
void	setCover(PortfolioDocument cover) Sets the cover page document of the Portfolio.
void	setDataDictionaryRef(java.lang.String dataDictionary) This method sets the data dictionary reference at the first index in DataDictionaryRef list
void	setDataDictionaryRefs(java.util.List dataDictionaryRefs) Sets the DataDictionary references(names) for the Portfolio.
void	setNavigator(PortfolioDocument navigator) Sets the navigator of the Portfolio.
void	setRootFolder(PortfolioFolder root) Sets the root folder of the Portfolio.
void	setVariableAssignments(java.util.Set variableAssignments) Sets the VariableAssignments for the Portfolio.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

PF_CLASS

public static final java.lang.String PF_CLASS

For internal use.

ASSOCIATION_CUTPOINT

public static final java.lang.String ASSOCIATION_CUTPOINT

For internal use.

HIERARCHY_CUTPOINT

public static final java.lang.String HIERARCHY_CUTPOINT

For internal use.

FIRST_LEVEL_CUTPOINT

public static final java.lang.String FIRST_LEVEL_CUTPOINT

For internal use.

Constructor Detail

Portfolio

public Portfolio()

Default constructor

Portfolio

public Portfolio(java.lang.String id,
                 java.lang.String name,
                 java.lang.String desc,
                 java.lang.String comment,
                 int state,
                 Category ucat,
                 Category lcat,
                 int version,
                 java.util.Date activeStartDate,
                 java.util.Date activeEndDate,
                 java.lang.String lastChangeBy,
                 PortfolioDocument navigator,
                 PortfolioDocument cover,
                 PortfolioFolder rootFolder)

Constructor from parameters.

Parameters:

id - unique identifier of the Portfolio.

name - name of the Portfolio.

desc - description of the Portfolio.

comment - comment for the Portfolio.

state - state of the Portfolio.

ucat - Category of the Portfolio.

lcat - Subcategory of the Portfolio.

version - version of the Portfolio.

activeStart - activation start date of the Portfolio.

activeEnd - activation end date of the Portfolio.

lastChangeBy - user creating the Portfolio.

nav - navigator of the Portfolio.

cover - cover document of the Portfolio.

rootFolder - root folder for the Portfolio. May contain sub-folders and Documents.

Method Detail

getNavigator

public PortfolioDocument getNavigator()

Get the navigator of the Portfolio.

Returns:

The navigator of the Portfolio.

setNavigator

public void setNavigator(PortfolioDocument navigator)

Sets the navigator of the Portfolio.

Parameters:

navigator - The navigator of the Portfolio.

getCover

public PortfolioDocument getCover()

Get the cover page document of the Portfolio.

Returns:

The cover page document of the Portfolio.

setCover

public void setCover(PortfolioDocument cover)

Sets the cover page document of the Portfolio.

Parameters:

cover - The cover page document of the Portfolio.

getRootFolder

public PortfolioFolder getRootFolder()

Get the root folder of the Portfolio.

Returns:

The root folder of the Portfolio.

setRootFolder

public void setRootFolder(PortfolioFolder root)

Sets the root folder of the Portfolio.

Parameters:

root - The root folder of the Portfolio.

getDataDictionaryRef

public java.lang.String getDataDictionaryRef()

This method retrieves the first data dictionary reference from the list of DataDictionaryRef's

Returns:

the dataDictionaryRef

setDataDictionaryRef

public void setDataDictionaryRef(java.lang.String dataDictionary)

This method sets the data dictionary reference at the first index in DataDictionaryRef list

Parameters:

dataDictionary - the dataDictionary to set

getVariableAssignments

public java.util.Set getVariableAssignments()

Get the VariableAssignments for the Portfolio.

Returns:

The VariableAssignments for the Portfolio.

setVariableAssignments

public void setVariableAssignments(java.util.Set variableAssignments)

Sets the VariableAssignments for the Portfolio.

Parameters:

variableAssignments - The VariableAssignments for the Portfolio.

getDataDictionaryRefs

public java.util.List getDataDictionaryRefs()

Get the DataDictionary references(names) for the Portfolio.

Returns:

The DataDictionary references(names) for the Portfolio.

setDataDictionaryRefs

public void setDataDictionaryRefs(java.util.List dataDictionaryRefs)

Sets the DataDictionary references(names) for the Portfolio.

Parameters:

dataDictionaryRefs - The DataDictionary references(names) for the Portfolio.