com.adobe.livecycle.connectorforibmcm.dsc.client
Class DocInfo

java.lang.Object
  com.adobe.livecycle.connectorforibmcm.dsc.client.DocInfo

All Implemented Interfaces:

java.io.Serializable

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

Class used to pass the content and attributes of IBM Content Manager (IBM CM) objects to LiveCycle clients. It has list of content objects and each content object is represented as PartInfo.

See Also:

Serialized Form

Constructor Summary

DocInfo()

Method Summary

void	addAttributeNameValue(java.lang.Object key, java.lang.Object value) Adds an key-value pair to the attribute.
void	addPartInfo(PartInfo partInfo) Adds content as partInfo.
java.util.Map	getAttributeNameValue() Retrieves an attribute's name-value pairs as a key-value pairs.
Document	getContent() Retrieves the content of a document.
java.lang.String	getObjectType() Retrieves the object type.
java.lang.String	getPid() Retrieves the PID of the IBM CM object.
java.lang.String	getVersion() Retrieves the version of the document.
boolean	isFolder()
void	setAttributeNameValue(java.util.Map attributeNameValue) Sets the name-value map pairs for an attribute.
void	setFolder(boolean isFolder)
void	setObjectType(java.lang.String objectType) Sets the object type of IBM CM object.
void	setPid(java.lang.String pid) Sets the PID of IBM CM object.
void	setVersion(java.lang.String version) Sets the version of the document to the value specified.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocInfo

public DocInfo()

Method Detail

getObjectType

public java.lang.String getObjectType()

Retrieves the object type.

Returns:

object type of the IBM CM object.

setObjectType

public void setObjectType(java.lang.String objectType)

Sets the object type of IBM CM object.

Parameters:

objectType - Object type to be set.

getPid

public java.lang.String getPid()

Retrieves the PID of the IBM CM object.

Returns:

PID of the object.

setPid

public void setPid(java.lang.String pid)

Sets the PID of IBM CM object.

Parameters:

pid - The PID to be set.

addPartInfo

public void addPartInfo(PartInfo partInfo)

Adds content as partInfo.

Parameters:

partInfo - partInfo object with content.

getAttributeNameValue

public java.util.Map getAttributeNameValue()

Retrieves an attribute's name-value pairs as a key-value pairs.

Returns:

Map of attribute name-value pairs.

addAttributeNameValue

public void addAttributeNameValue(java.lang.Object key,
                                  java.lang.Object value)

Adds an key-value pair to the attribute.

Parameters:

key - The key in the name-value pair.

value - The value in the name-value pair.

getVersion

public java.lang.String getVersion()

Retrieves the version of the document.

Returns:

Version of the document.

setVersion

public void setVersion(java.lang.String version)

Sets the version of the document to the value specified.

Parameters:

version - The version of the document.

getContent

public Document getContent()

Retrieves the content of a document.

Returns:

A Document object with contents of the document.

setAttributeNameValue

public void setAttributeNameValue(java.util.Map attributeNameValue)

Sets the name-value map pairs for an attribute.

Parameters:

attributeNameValue - A map containing name-value pairs.

isFolder

public boolean isFolder()

setFolder

public void setFolder(boolean isFolder)