com.saperion.structures

Class Description

java.lang.Object

com.saperion.structures.Description

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

DocumentInfo, LinkInfo

public class Description
extends Object
implements Serializable

Description of a database definition (DDC) related item.
An item could be a document DocumentInfo or LinkInfo and contains the descriptions for the DDC name, the meta data, a revision comment and the ACL names.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	acl
protected String	comment
protected String	ddc
protected Map<String,Object>	metadatas

Constructor Summary

Constructors

Constructor and Description
Description(String ddcName, Map<String,Object> nameValuePairs, String versionComment) Creates a new document description.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAcls()
String	getDdcName()
Map<String,Object>	getMetadatas()
String	getVersionComment()
Description	setAcls(String acls)

Methods inherited from class java.lang.Object

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

Field Detail

ddc

protected String ddc

metadatas

protected Map<String,Object> metadatas

comment

protected String comment

acl

protected String acl

Constructor Detail

Description

public Description(String ddcName,
           Map<String,Object> nameValuePairs,
           String versionComment)

Creates a new document description.

Parameters:

ddcName - The name of the database definition

documentHDoc - The ID of the document (HDOC)

nameValuePairs - A properties object containing the metadata. Only the contained properties will be updated.

content - Multiple content data. If the array is empty, all content of the document will be removed. If null, the content will not be changed. Otherwise only the contained elements will be replaced.

versionComment - The comment for the version

Method Detail

getDdcName

public String getDdcName()

Returns:

ddc name

getMetadatas

public Map<String,Object> getMetadatas()

Returns:

properties as name value pairs

getVersionComment

public String getVersionComment()

Returns:

version comment

getAcls

public String getAcls()

Returns:

ACLs

setAcls

public Description setAcls(String acls)

Parameters:

acls - acl string

Returns:

UpdateDocumentInfo