com.docdoku.core.document

Class DocumentIteration

java.lang.Object

com.docdoku.core.document.DocumentIteration

All Implemented Interfaces:

FileHolder, Serializable, Cloneable, Comparable<DocumentIteration>

@Entity
public class DocumentIteration
extends Object
implements Serializable, FileHolder, Comparable<DocumentIteration>, Cloneable

This DocumentIteration class represents the iterated part of a document. The iteration attribute indicates the order in which the modifications have been made on the document.

Since:

V1.0

Version:

1.0, 02/06/08

Author:

Florent Garin

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentIteration()
DocumentIteration(DocumentRevision pDocumentRevision, User pAuthor)

Method Summary

Modifier and Type	Method and Description
void	addFile(BinaryResource pBinaryResource)
DocumentIteration	clone() perform a deep clone operation
int	compareTo(DocumentIteration pDoc)
boolean	equals(Object pObj)
Set<BinaryResource>	getAttachedFiles()
User	getAuthor()
Date	getCheckInDate()
Date	getCreationDate()
String	getDocumentMasterId()
DocumentRevision	getDocumentRevision()
DocumentRevisionKey	getDocumentRevisionKey()
String	getId()
List<InstanceAttribute>	getInstanceAttributes()
int	getIteration()
DocumentIterationKey	getKey()
Set<DocumentLink>	getLinkedDocuments()
Date	getModificationDate()
String	getRevisionNote()
String	getTitle()
String	getVersion()
String	getWorkspaceId()
int	hashCode()
boolean	removeFile(BinaryResource pBinaryResource)
void	setAttachedFiles(Set<BinaryResource> attachedFiles)
void	setAuthor(User pAuthor)
void	setCheckInDate(Date checkInDate)
void	setCreationDate(Date creationDate)
void	setDocumentRevision(DocumentRevision documentRevision)
void	setInstanceAttributes(List<InstanceAttribute> pInstanceAttributes)
void	setIteration(int iteration)
void	setLinkedDocuments(Set<DocumentLink> pLinkedDocuments)
void	setModificationDate(Date modificationDate)
void	setRevisionNote(String pRevisionNote)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentIteration

public DocumentIteration()

DocumentIteration

public DocumentIteration(DocumentRevision pDocumentRevision,
                         User pAuthor)

Method Detail

setDocumentRevision

public void setDocumentRevision(DocumentRevision documentRevision)

getWorkspaceId

public String getWorkspaceId()

getId

public String getId()

getVersion

public String getVersion()

getDocumentMasterId

public String getDocumentMasterId()

getIteration

public int getIteration()

setRevisionNote

public void setRevisionNote(String pRevisionNote)

getRevisionNote

public String getRevisionNote()

setAttachedFiles

public void setAttachedFiles(Set<BinaryResource> attachedFiles)

setIteration

public void setIteration(int iteration)

removeFile

public boolean removeFile(BinaryResource pBinaryResource)

addFile

public void addFile(BinaryResource pBinaryResource)

getAttachedFiles

public Set<BinaryResource> getAttachedFiles()

Specified by:

getAttachedFiles in interface FileHolder

getDocumentRevisionKey

public DocumentRevisionKey getDocumentRevisionKey()

getKey

public DocumentIterationKey getKey()

setAuthor

public void setAuthor(User pAuthor)

getAuthor

public User getAuthor()

getDocumentRevision

public DocumentRevision getDocumentRevision()

setCreationDate

public void setCreationDate(Date creationDate)

getCreationDate

public Date getCreationDate()

setModificationDate

public void setModificationDate(Date modificationDate)

getModificationDate

public Date getModificationDate()

setCheckInDate

public void setCheckInDate(Date checkInDate)

getCheckInDate

public Date getCheckInDate()

getLinkedDocuments

public Set<DocumentLink> getLinkedDocuments()

setLinkedDocuments

public void setLinkedDocuments(Set<DocumentLink> pLinkedDocuments)

getInstanceAttributes

public List<InstanceAttribute> getInstanceAttributes()

setInstanceAttributes

public void setInstanceAttributes(List<InstanceAttribute> pInstanceAttributes)

getTitle

public String getTitle()

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object pObj)

Overrides:

equals in class Object

compareTo

public int compareTo(DocumentIteration pDoc)

Specified by:

compareTo in interface Comparable<DocumentIteration>

clone

public DocumentIteration clone()

perform a deep clone operation

Overrides:

clone in class Object