com.logicaldoc.core.document

Class Version

java.lang.Object

com.logicaldoc.core.PersistentObject

com.logicaldoc.core.ExtensibleObject

com.logicaldoc.core.document.AbstractDocument

com.logicaldoc.core.document.Version

All Implemented Interfaces:

TransactionalObject, Comparable<Version>

public class Version
extends AbstractDocument
implements Comparable<Version>

This class represents versions.

Version:

1.0

Author:

Marco Meschieri - Logical Objects

Field Summary

Fields

Modifier and Type	Field and Description
static String	EVENT_CHANGED
static String	EVENT_CHECKIN
static String	EVENT_MOVED
static String	EVENT_RENAMED
static String	EVENT_STORED

Fields inherited from class com.logicaldoc.core.document.AbstractDocument

BARCODE_PROCESSED, BARCODE_SKIP, BARCODE_TO_PROCESS, DOC_CHECKED_OUT, DOC_LOCKED, DOC_UNLOCKED, EXPORT_LOCKED, EXPORT_UNLOCKED, INDEX_INDEXED, INDEX_SKIP, INDEX_TO_INDEX

Constructor Summary

Constructors

Constructor and Description
Version()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Version other) for sorting a list of Version objects by the version number
static Version	create(Document document, User user, String comment, String event, boolean release) Factory method that creates a Version and replicate all given document's properties.
String	getCreator()
long	getCreatorId()
long	getDocId()
String	getEvent()
long	getFolderId()
String	getFolderName()
Long	getTemplateId()
String	getTemplateName()
long	getUserId()
String	getUsername()
Date	getVersionDate()
void	setCreator(String creator)
void	setCreatorId(long creatorId)
void	setDocId(long docId)
void	setEvent(String event)
void	setFolderId(long folderId)
void	setFolderName(String folderName)
void	setTemplateId(Long templateId)
void	setTemplateName(String templateName)
void	setUserId(long userId)
void	setUsername(String username)
void	setVersionDate(Date versionDate)
String	toString()

Methods inherited from class com.logicaldoc.core.document.AbstractDocument

addTag, clearTags, getBarcoded, getComment, getCoverage, getCreation, getCustomId, getDate, getDeleteUserId, getDigest, getDocRef, getExportId, getExportName, getExportStatus, getExportVersion, getExtResId, getFileExtension, getFileName, getFileSize, getFileVersion, getFolder, getIcon, getImmutable, getIndexed, getLanguage, getLocale, getLockUserId, getObject, getPublished, getPublisher, getPublisherId, getRating, getRecipient, getSigned, getSource, getSourceAuthor, getSourceDate, getSourceId, getSourceType, getStartPublishing, getStatus, getStopPublishing, getTags, getTagsString, getTemplate, getTgs, getTitle, getTransactionId, getType, getVersion, getWorkflowStatus, isPublishing, isToIndex, setBarcoded, setComment, setCoverage, setCreation, setCustomId, setDate, setDeleteUserId, setDigest, setDocRef, setExportId, setExportName, setExportStatus, setExportVersion, setExtResId, setFileName, setFileSize, setFileVersion, setFolder, setImmutable, setIndexed, setLanguage, setLocale, setLockUserId, setObject, setPublished, setPublisher, setPublisherId, setRating, setRecipient, setSigned, setSource, setSourceAuthor, setSourceDate, setSourceId, setSourceType, setStartPublishing, setStatus, setStopPublishing, setTags, setTemplate, setTgs, setTitle, setTransactionId, setType, setVersion, setWorkflowStatus

Methods inherited from class com.logicaldoc.core.ExtensibleObject

getAttributeAtPosition, getAttributeNames, getAttributes, getExtendedAttribute, getValue, removeAttribute, setAttributes, setValue

Methods inherited from class com.logicaldoc.core.PersistentObject

equals, getDeleted, getId, getLastModified, hashCode, setDeleted, setId, setLastModified

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

EVENT_STORED

public static final String EVENT_STORED

See Also:

Constant Field Values

EVENT_CHANGED

public static final String EVENT_CHANGED

See Also:

Constant Field Values

EVENT_CHECKIN

public static final String EVENT_CHECKIN

See Also:

Constant Field Values

EVENT_RENAMED

public static final String EVENT_RENAMED

See Also:

Constant Field Values

EVENT_MOVED

public static final String EVENT_MOVED

See Also:

Constant Field Values

Constructor Detail

Version

public Version()

Method Detail

getUserId

public long getUserId()

setUserId

public void setUserId(long userId)

getUsername

public String getUsername()

See Also:

getUsername()

setUsername

public void setUsername(String username)

See Also:

setUsername(java.lang.String)

compareTo

public int compareTo(Version other)

for sorting a list of Version objects by the version number

Specified by:

compareTo in interface Comparable<Version>

toString

public String toString()

Overrides:

toString in class PersistentObject

getVersionDate

public Date getVersionDate()

setVersionDate

public void setVersionDate(Date versionDate)

getFolderId

public long getFolderId()

setFolderId

public void setFolderId(long folderId)

getFolderName

public String getFolderName()

setFolderName

public void setFolderName(String folderName)

getTemplateId

public Long getTemplateId()

setTemplateId

public void setTemplateId(Long templateId)

getTemplateName

public String getTemplateName()

setTemplateName

public void setTemplateName(String templateName)

create

public static Version create(Document document,
             User user,
             String comment,
             String event,
             boolean release)

Factory method that creates a Version and replicate all given document's properties.
The new version and fileVersion will be set in both Document and Version

Important: The created Version is not persistent

Parameters:

document - The document to be versioned

user - The user who made the changes

comment - The version comment

event - The event that caused the new release

release - True if this is a new release(eg: 2.0) rather than a subversion(eg: 1.1)

initial - True if this is an initial release

Returns:

The newly created version

getEvent

public String getEvent()

setEvent

public void setEvent(String event)

getCreator

public String getCreator()

Overrides:

getCreator in class AbstractDocument

setCreator

public void setCreator(String creator)

Overrides:

setCreator in class AbstractDocument

getCreatorId

public long getCreatorId()

Overrides:

getCreatorId in class AbstractDocument

setCreatorId

public void setCreatorId(long creatorId)

Overrides:

setCreatorId in class AbstractDocument

getDocId

public long getDocId()

setDocId

public void setDocId(long docId)