Skip navigation links

waggle.common.modules.repository.infos
Class XRepositoryDocumentInfo

java.lang.Object
waggle.core.info.XDTO
waggle.common.modules.repository.infos.XRepositoryDocumentInfo

public class XRepositoryDocumentInfo

extends XDTO

XRepositoryDocumentInfo.

A field name "Foo" basically corresponds to UCM key name "dFoo". Sometimes, when UCM is echoing back a key that was passed in to a method call, the response UCM key name is prefixed with "x" instead of "d". For example, if "dCollectionID" is passed in, then "xCollectionID" may be used in the response.

Field Summary

String	CheckoutUser The name of the User the content is checked out to.
String	CollectionID The containing Collection ID.
Date	CreateDate In my limited observation, UCM responses contain two similar keys: "dCreateDate" and "dDocCreatedDate"; and they are always set to the same value.
String	DocAccount The Account for this Document.
String	DocAuthor The Document's author.
String	DocCreator The Document's creator.
String	DocID dDocID.
String	DocName DocName is also known as the "content id".
String	DocTitle The DocTitle is a human readable document title that may contain spaces and some special characters.
String	DocType DocType can be "Document" or ... .
long	FileSize The size of this Content.
String	Format Format appears to be the mime type.
String	ID The internal content item revision identifier.
boolean	IsCheckedOut True if the content is checked out.
String	OriginalName The OriginalName is the file name used as the content source.
String	RevisionID The revision id.
int	Score Search score.
String	SecurityGroup The Document's security group.
String	Snippet Search snippet.
String	URL The appears to be the absolute path portion of an HTTP URL, without the hostname and port information.

Constructor Summary

XRepositoryDocumentInfo()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

ID

public String ID

The internal content item revision identifier. The dID is a generated reference to a specific rendition of a content item.

DocID

public String DocID

dDocID. Not sure what this is used for, but it's a different numeric value than ID (dID).

CreateDate

public Date CreateDate

In my limited observation, UCM responses contain two similar keys: "dCreateDate" and "dDocCreatedDate"; and they are always set to the same value. "dCreateDate" is the only one mentioned in the documentation, so let's use it for now.

CollectionID

public String CollectionID

The containing Collection ID.

DocAuthor

public String DocAuthor

The Document's author.

DocCreator

public String DocCreator

The Document's creator.

DocName

public String DocName

DocName is also known as the "content id". It's an alpha-numeric string (dots and underscores are allowed, but no spaces or other special characters) that must be unique and is limited in length.

DocTitle

public String DocTitle

The DocTitle is a human readable document title that may contain spaces and some special characters.

DocType

public String DocType

DocType can be "Document" or ... .

DocAccount

public String DocAccount

The Account for this Document.

FileSize

public long FileSize

The size of this Content.

Format

public String Format

Format appears to be the mime type. For example, "text/plain".

OriginalName

public String OriginalName

The OriginalName is the file name used as the content source. For example, "build.xml" or "specs.doc".

SecurityGroup

public String SecurityGroup

The Document's security group.

RevisionID

public String RevisionID

The revision id.

URL

public String URL

The appears to be the absolute path portion of an HTTP URL, without the hostname and port information. For example, "/cs/groups/public/documents/document/w24001~1.txt".

Score

public int Score

Search score.

Snippet

public String Snippet

Search snippet.

IsCheckedOut

public boolean IsCheckedOut

True if the content is checked out.

CheckoutUser

public String CheckoutUser

The name of the User the content is checked out to.

Constructor Detail

XRepositoryDocumentInfo

public XRepositoryDocumentInfo()

Skip navigation links