DocumentRevision (docdoku-api-java 2.5-SNAPSHOT API)

java.lang.Object
- com.docdoku.core.document.DocumentRevision

All Implemented Interfaces:

Serializable, Comparable<DocumentRevision>
```
@Entity
public class DocumentRevision
extends Object
implements Serializable, Comparable<DocumentRevision>
```
This class stands between DocumentMaster and DocumentIteration. It represents a formal revision of a document and can have an attached workflow.

Since:

V2.0

Version:

2.0, 11/01/14

Author:

Florent Garin

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`DocumentRevision()`
`DocumentRevision(DocumentMaster pDocumentMaster, String pStringVersion, User pAuthor)`
`DocumentRevision(DocumentMaster pDocumentMaster, User pAuthor)`
`DocumentRevision(DocumentMaster pDocumentMaster, Version pVersion, User pAuthor)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addAbortedWorkflows(Workflow abortedWorkflow)`
`boolean`	`addTag(Tag pTag)`
`int`	`compareTo(DocumentRevision pDocR)`
`DocumentIteration`	`createNextIteration(User pUser)`
`boolean`	`equals(Object pObj)`
`List<Workflow>`	`getAbortedWorkflows()`
`ACL`	`getACL()`
`User`	`getAuthor()`
`Date`	`getCheckOutDate()`
`User`	`getCheckOutUser()`
`Date`	`getCreationDate()`
`String`	`getDescription()`
`List<DocumentIteration>`	`getDocumentIterations()`
`DocumentMaster`	`getDocumentMaster()`
`String`	`getDocumentMasterId()`
`DocumentMasterKey`	`getDocumentMasterKey()`
`String`	`getDocumentMasterWorkspaceId()`
`String`	`getId()`
`DocumentIteration`	`getIteration(int pIteration)`
`DocumentRevisionKey`	`getKey()`
`DocumentIteration`	`getLastCheckedInIteration()`
`DocumentIteration`	`getLastIteration()`
`String`	`getLifeCycleState()`
`Folder`	`getLocation()`
`int`	`getNumberOfIterations()`
`User`	`getObsoleteAuthor()`
`Date`	`getObsoleteDate()`
`StatusChange`	`getObsoleteStatusChange()`
`User`	`getReleaseAuthor()`
`Date`	`getReleaseDate()`
`StatusChange`	`getReleaseStatusChange()`
`RevisionStatus`	`getStatus()`
`Set<Tag>`	`getTags()`
`String`	`getTitle()`
`String`	`getType()`
`String`	`getVersion()`
`Workflow`	`getWorkflow()`
`Integer`	`getWorkflowId()`
`String`	`getWorkspaceId()`
`int`	`hashCode()`
`boolean`	`hasWorkflow()`
`boolean`	`isAttributesLocked()`
`boolean`	`isCheckedOut()`
`boolean`	`isCheckedOutBy(String pUser)`
`boolean`	`isCheckedOutBy(User pUser)`
`boolean`	`isObsolete()`
`boolean`	`isPublicShared()`
`boolean`	`isReleased()`
`boolean`	`markAsObsolete(User user)`
`boolean`	`release(User user)`
`void`	`removeFollowingIterations(int lastIterationWanted)` Remove the iterations following the lastIterationWanted
`DocumentIteration`	`removeLastIteration()`
`boolean`	`removeTag(Tag pTag)`
`void`	`setACL(ACL acl)`
`void`	`setAuthor(User pAuthor)`
`void`	`setCheckOutDate(Date checkOutDate)`
`void`	`setCheckOutUser(User pCheckOutUser)`
`void`	`setCreationDate(Date creationDate)`
`void`	`setDescription(String pDescription)`
`void`	`setDocumentIterations(List<DocumentIteration> documentIterations)`
`void`	`setDocumentMaster(DocumentMaster documentMaster)`
`void`	`setDocumentMasterId(String pDocumentMasterId)`
`void`	`setDocumentMasterWorkspaceId(String pDocumentMasterWorkspaceId)`
`void`	`setLocation(Folder pLocation)`
`void`	`setObsoleteStatusChange(StatusChange statusChange)`
`void`	`setPublicShared(boolean publicShared)`
`void`	`setReleaseStatusChange(StatusChange statusChange)`
`void`	`setStatus(RevisionStatus status)`
`Set<Tag>`	`setTags(Set<Tag> pTags)` Tags the DocumentRevision with the set of tags.
`void`	`setTitle(String pTitle)`
`void`	`setVersion(String version)`
`void`	`setWorkflow(Workflow pWorkflow)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentRevision
```
public DocumentRevision()
```

DocumentRevision

public DocumentRevision(DocumentMaster pDocumentMaster,
                        String pStringVersion,
                        User pAuthor)

DocumentRevision

public DocumentRevision(DocumentMaster pDocumentMaster,
                        Version pVersion,
                        User pAuthor)

DocumentRevision

public DocumentRevision(DocumentMaster pDocumentMaster,
                        User pAuthor)

Method Detail

getDocumentMaster

public DocumentMaster getDocumentMaster()

setDocumentMaster

public void setDocumentMaster(DocumentMaster documentMaster)

getKey
```
public DocumentRevisionKey getKey()
```

getCheckOutUser
```
public User getCheckOutUser()
```

setCheckOutUser

public void setCheckOutUser(User pCheckOutUser)

isCheckedOut
```
public boolean isCheckedOut()
```

isCheckedOutBy

public boolean isCheckedOutBy(String pUser)

getCheckOutDate
```
public Date getCheckOutDate()
```

setCheckOutDate

public void setCheckOutDate(Date checkOutDate)

getAuthor
```
public User getAuthor()
```

setAuthor
```
public void setAuthor(User pAuthor)
```

getCreationDate
```
public Date getCreationDate()
```

setCreationDate

public void setCreationDate(Date creationDate)

getVersion
```
public String getVersion()
```

setVersion

public void setVersion(String version)

getType
```
public String getType()
```

getWorkflow
```
public Workflow getWorkflow()
```

setWorkflow

public void setWorkflow(Workflow pWorkflow)

getWorkflowId
```
public Integer getWorkflowId()
```

hasWorkflow
```
public boolean hasWorkflow()
```

getLifeCycleState
```
public String getLifeCycleState()
```

getACL
```
public ACL getACL()
```

setACL
```
public void setACL(ACL acl)
```

getAbortedWorkflows

public List<Workflow> getAbortedWorkflows()

addAbortedWorkflows

public void addAbortedWorkflows(Workflow abortedWorkflow)

getDocumentIterations

public List<DocumentIteration> getDocumentIterations()

setDocumentIterations

public void setDocumentIterations(List<DocumentIteration> documentIterations)

getIteration

public DocumentIteration getIteration(int pIteration)

createNextIteration

public DocumentIteration createNextIteration(User pUser)

getLastIteration

public DocumentIteration getLastIteration()

getLastCheckedInIteration

public DocumentIteration getLastCheckedInIteration()

removeLastIteration

public DocumentIteration removeLastIteration()

removeFollowingIterations
```
public void removeFollowingIterations(int lastIterationWanted)
```
Remove the iterations following the lastIterationWanted

Parameters:

lastIterationWanted - The new last iteration number

getNumberOfIterations
```
public int getNumberOfIterations()
```

setDescription

public void setDescription(String pDescription)

getDescription
```
public String getDescription()
```

getDocumentMasterKey

public DocumentMasterKey getDocumentMasterKey()

getWorkspaceId
```
public String getWorkspaceId()
```

getId
```
public String getId()
```

setDocumentMasterId

public void setDocumentMasterId(String pDocumentMasterId)

setDocumentMasterWorkspaceId

public void setDocumentMasterWorkspaceId(String pDocumentMasterWorkspaceId)

getDocumentMasterId
```
public String getDocumentMasterId()
```

getDocumentMasterWorkspaceId

public String getDocumentMasterWorkspaceId()

isPublicShared
```
public boolean isPublicShared()
```

setPublicShared

public void setPublicShared(boolean publicShared)

getStatus
```
public RevisionStatus getStatus()
```

setStatus

public void setStatus(RevisionStatus status)

isReleased
```
public boolean isReleased()
```

isObsolete
```
public boolean isObsolete()
```

release
```
public boolean release(User user)
```

markAsObsolete

public boolean markAsObsolete(User user)

setTitle
```
public void setTitle(String pTitle)
```

getTitle
```
public String getTitle()
```

isCheckedOutBy

public boolean isCheckedOutBy(User pUser)

getTags
```
public Set<Tag> getTags()
```

setTags
```
public Set<Tag> setTags(Set<Tag> pTags)
```
Tags the DocumentRevision with the set of tags. Some of them may already be attached on the document.

Parameters:

pTags - the tag set to attach on the DocumentRevision

Returns:

the tags that have actually been added

addTag
```
public boolean addTag(Tag pTag)
```

removeTag
```
public boolean removeTag(Tag pTag)
```

isAttributesLocked
```
public boolean isAttributesLocked()
```

getObsoleteStatusChange

public StatusChange getObsoleteStatusChange()

setObsoleteStatusChange

public void setObsoleteStatusChange(StatusChange statusChange)

getReleaseStatusChange

public StatusChange getReleaseStatusChange()

setReleaseStatusChange

public void setReleaseStatusChange(StatusChange statusChange)

getObsoleteAuthor
```
public User getObsoleteAuthor()
```

getObsoleteDate
```
public Date getObsoleteDate()
```

getReleaseAuthor
```
public User getReleaseAuthor()
```

getReleaseDate
```
public Date getReleaseDate()
```

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(DocumentRevision pDocR)
```
Specified by:

compareTo in interface Comparable<DocumentRevision>

getLocation
```
public Folder getLocation()
```

setLocation

public void setLocation(Folder pLocation)

Class DocumentRevision

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DocumentRevision

DocumentRevision

DocumentRevision

DocumentRevision

Method Detail

getDocumentMaster

setDocumentMaster

getKey

getCheckOutUser

setCheckOutUser

isCheckedOut

isCheckedOutBy

getCheckOutDate

setCheckOutDate

getAuthor

setAuthor

getCreationDate

setCreationDate

getVersion

setVersion

getType

getWorkflow

setWorkflow

getWorkflowId

hasWorkflow

getLifeCycleState

getACL

setACL

getAbortedWorkflows

addAbortedWorkflows

getDocumentIterations

setDocumentIterations

getIteration

createNextIteration

getLastIteration

getLastCheckedInIteration

removeLastIteration

removeFollowingIterations

getNumberOfIterations

setDescription

getDescription

getDocumentMasterKey

getWorkspaceId

getId

setDocumentMasterId

setDocumentMasterWorkspaceId

getDocumentMasterId

getDocumentMasterWorkspaceId

isPublicShared

setPublicShared

getStatus

setStatus

isReleased

isObsolete

release

markAsObsolete

setTitle

getTitle

isCheckedOutBy

getTags

setTags

addTag

removeTag

isAttributesLocked

getObsoleteStatusChange

setObsoleteStatusChange

getReleaseStatusChange

setReleaseStatusChange

getObsoleteAuthor

getObsoleteDate

getReleaseAuthor

getReleaseDate

toString

equals

hashCode