com.docdoku.core.document

Class DocumentMaster

java.lang.Object

com.docdoku.core.document.DocumentMaster

All Implemented Interfaces:

Serializable, Comparable<DocumentMaster>

@Entity
public class DocumentMaster
extends Object
implements Serializable, Comparable<DocumentMaster>

This class holds the unchanging aspects of a document. From that object, we can navigate to all the revisions and then the iterations of the document where most of the data sits.

Since:

V1.0

Version:

1.1, 23/01/12

Author:

Florent Garin

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DocumentMaster()
DocumentMaster(Workspace pWorkspace, String pId, User pAuthor)

Method Summary

Modifier and Type	Method and Description
int	compareTo(DocumentMaster pDocM)
DocumentRevision	createNextRevision(User pUser)
boolean	equals(Object pObj)
User	getAuthor()
Date	getCreationDate()
DocumentRevision	getDocumentRevision(String version)
List<DocumentRevision>	getDocumentRevisions()
String	getId()
DocumentMasterKey	getKey()
DocumentRevision	getLastRevision()
String	getType()
Workspace	getWorkspace()
String	getWorkspaceId()
int	hashCode()
boolean	isAttributesLocked()
DocumentRevision	removeLastRevision()
void	removeRevision(DocumentRevision documentRevision)
void	setAttributesLocked(boolean attributesLocked)
void	setAuthor(User pAuthor)
void	setCreationDate(Date pCreationDate)
void	setDocumentRevisions(List<DocumentRevision> documentRevisions)
void	setId(String id)
void	setType(String type)
void	setWorkspace(Workspace pWorkspace)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentMaster

public DocumentMaster()

DocumentMaster

public DocumentMaster(Workspace pWorkspace,
                      String pId,
                      User pAuthor)

Method Detail

setAuthor

public void setAuthor(User pAuthor)

getAuthor

public User getAuthor()

setCreationDate

public void setCreationDate(Date pCreationDate)

getCreationDate

public Date getCreationDate()

setId

public void setId(String id)

getId

public String getId()

getDocumentRevisions

public List<DocumentRevision> getDocumentRevisions()

setDocumentRevisions

public void setDocumentRevisions(List<DocumentRevision> documentRevisions)

getDocumentRevision

public DocumentRevision getDocumentRevision(String version)

getLastRevision

public DocumentRevision getLastRevision()

removeLastRevision

public DocumentRevision removeLastRevision()

removeRevision

public void removeRevision(DocumentRevision documentRevision)

createNextRevision

public DocumentRevision createNextRevision(User pUser)

getType

public String getType()

setType

public void setType(String type)

getKey

public DocumentMasterKey getKey()

getWorkspaceId

public String getWorkspaceId()

setWorkspace

public void setWorkspace(Workspace pWorkspace)

getWorkspace

public Workspace getWorkspace()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object pObj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(DocumentMaster pDocM)

Specified by:

compareTo in interface Comparable<DocumentMaster>

isAttributesLocked

public boolean isAttributesLocked()

setAttributesLocked

public void setAttributesLocked(boolean attributesLocked)