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

java.lang.Object
- com.docdoku.core.product.PartRevision

All Implemented Interfaces:

Serializable, Comparable<PartRevision>
```
@Entity
public class PartRevision
extends Object
implements Serializable, Comparable<PartRevision>
```
This class stands between PartMaster and PartIteration. Its main purpose is to hold effectivities. It represents a formal revision of a part.

Since:

V1.1

Version:

1.1, 31/10/11

Author:

Florent Garin

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`PartRevision()`
`PartRevision(PartMaster pPartMaster, String pStringVersion, User pAuthor)`
`PartRevision(PartMaster pPartMaster, User pAuthor)`
`PartRevision(PartMaster pPartMaster, 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(PartRevision pPartR)`
`PartIteration`	`createNextIteration(User pUser)`
`boolean`	`equals(Object pObj)`
`List<Workflow>`	`getAbortedWorkflows()`
`ACL`	`getACL()`
`User`	`getAuthor()`
`Date`	`getCheckOutDate()`
`User`	`getCheckOutUser()`
`Date`	`getCreationDate()`
`String`	`getDescription()`
`Set<Effectivity>`	`getEffectivities()`
`PartIteration`	`getIteration(int pIteration)`
`PartRevisionKey`	`getKey()`
`PartIteration`	`getLastAccessibleIteration(User user)`
`PartIteration`	`getLastCheckedInIteration()`
`PartIteration`	`getLastIteration()`
`int`	`getLastIterationNumber()`
`String`	`getLifeCycleState()`
`int`	`getNumberOfIterations()`
`User`	`getObsoleteAuthor()`
`Date`	`getObsoleteDate()`
`StatusChange`	`getObsoleteStatusChange()`
`List<PartIteration>`	`getPartIterations()`
`PartMaster`	`getPartMaster()`
`PartMasterKey`	`getPartMasterKey()`
`String`	`getPartMasterNumber()`
`String`	`getPartMasterWorkspaceId()`
`String`	`getPartName()`
`String`	`getPartNumber()`
`User`	`getReleaseAuthor()`
`Date`	`getReleaseDate()`
`StatusChange`	`getReleaseStatusChange()`
`RevisionStatus`	`getStatus()`
`Set<Tag>`	`getTags()`
`String`	`getType()`
`String`	`getVersion()`
`Workflow`	`getWorkflow()`
`String`	`getWorkspaceId()`
`int`	`hashCode()`
`boolean`	`hasWorkflow()`
`boolean`	`isAttributesLocked()`
`boolean`	`isCheckedOut()`
`boolean`	`isObsolete()`
`boolean`	`isPublicShared()`
`boolean`	`isReleased()`
`boolean`	`markAsObsolete(User user)`
`boolean`	`release(User user)`
`boolean`	`removeEffectivity(Effectivity pEffectivity)`
`PartIteration`	`removeLastIteration()`
`boolean`	`removeTag(Tag pTag)`
`void`	`setACL(ACL acl)`
`void`	`setAuthor(User author)`
`void`	`setCheckOutDate(Date checkOutDate)`
`void`	`setCheckOutUser(User checkOutUser)`
`void`	`setCreationDate(Date creationDate)`
`void`	`setDescription(String description)`
`void`	`setEffectivities(Set<Effectivity> effectivities)`
`void`	`setObsoleteStatusChange(StatusChange statusChange)`
`void`	`setPartIterations(List<PartIteration> partIterations)`
`void`	`setPartMaster(PartMaster partMaster)`
`void`	`setPartMasterNumber(String pPartMasterNumber)`
`void`	`setPartMasterWorkspaceId(String pPartMasterWorkspaceId)`
`void`	`setPublicShared(boolean publicShared)`
`void`	`setReleaseStatusChange(StatusChange statusChange)`
`void`	`setStatus(RevisionStatus status)`
`Set<Tag>`	`setTags(Set<Tag> pTags)` Tags the PartRevision with the set of tags.
`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

PartRevision
```
public PartRevision()
```

PartRevision

public PartRevision(PartMaster pPartMaster,
                    String pStringVersion,
                    User pAuthor)

PartRevision

public PartRevision(PartMaster pPartMaster,
                    Version pVersion,
                    User pAuthor)

PartRevision

public PartRevision(PartMaster pPartMaster,
                    User pAuthor)

Method Detail

setPartMaster

public void setPartMaster(PartMaster partMaster)

getPartMaster
```
public PartMaster getPartMaster()
```

getKey
```
public PartRevisionKey getKey()
```

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

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

setAuthor
```
public void setAuthor(User author)
```

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

setCreationDate

public void setCreationDate(Date creationDate)

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

setCheckOutDate

public void setCheckOutDate(Date checkOutDate)

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

setCheckOutUser

public void setCheckOutUser(User checkOutUser)

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

setVersion

public void setVersion(String version)

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

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

setWorkflow

public void setWorkflow(Workflow pWorkflow)

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

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

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

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

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

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

Parameters:

pTags - the tag set to attach on the PartRevision

Returns:

the tags that have actually been added

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

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

getAbortedWorkflows

public List<Workflow> getAbortedWorkflows()

addAbortedWorkflows

public void addAbortedWorkflows(Workflow abortedWorkflow)

createNextIteration

public PartIteration createNextIteration(User pUser)

getPartIterations

public List<PartIteration> getPartIterations()

setPartIterations

public void setPartIterations(List<PartIteration> partIterations)

getLastIteration

public PartIteration getLastIteration()

getLastCheckedInIteration

public PartIteration getLastCheckedInIteration()

getLastIterationNumber
```
public int getLastIterationNumber()
```

removeLastIteration

public PartIteration removeLastIteration()

getIteration

public PartIteration getIteration(int pIteration)

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

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

setDescription

public void setDescription(String description)

getPartMasterKey

public PartMasterKey getPartMasterKey()

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

getPartNumber
```
public String getPartNumber()
```

getPartName
```
public String getPartName()
```

getPartMasterNumber
```
public String getPartMasterNumber()
```

setPartMasterNumber

public void setPartMasterNumber(String pPartMasterNumber)

getPartMasterWorkspaceId

public String getPartMasterWorkspaceId()

setPartMasterWorkspaceId

public void setPartMasterWorkspaceId(String pPartMasterWorkspaceId)

getEffectivities

public Set<Effectivity> getEffectivities()

setEffectivities

public void setEffectivities(Set<Effectivity> effectivities)

removeEffectivity

public boolean removeEffectivity(Effectivity pEffectivity)

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)

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(PartRevision pPartR)
```
Specified by:

compareTo in interface Comparable<PartRevision>

getLastAccessibleIteration

public PartIteration getLastAccessibleIteration(User user)

Class PartRevision

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PartRevision

PartRevision

PartRevision

PartRevision

Method Detail

setPartMaster

getPartMaster

getKey

isCheckedOut

getAuthor

setAuthor

getCreationDate

setCreationDate

getCheckOutDate

setCheckOutDate

getCheckOutUser

setCheckOutUser

getVersion

setVersion

getType

getWorkflow

setWorkflow

getLifeCycleState

hasWorkflow

getACL

setACL

getTags

setTags

addTag

removeTag

getAbortedWorkflows

addAbortedWorkflows

createNextIteration

getPartIterations

setPartIterations

getLastIteration

getLastCheckedInIteration

getLastIterationNumber

removeLastIteration

getIteration

getNumberOfIterations

getDescription

setDescription

getPartMasterKey

getWorkspaceId

getPartNumber

getPartName

getPartMasterNumber

setPartMasterNumber

getPartMasterWorkspaceId

setPartMasterWorkspaceId

getEffectivities

setEffectivities

removeEffectivity

isPublicShared

setPublicShared

getStatus

setStatus

isReleased

isObsolete

release

markAsObsolete

isAttributesLocked

getObsoleteStatusChange

setObsoleteStatusChange

getReleaseStatusChange

setReleaseStatusChange

getObsoleteAuthor

getObsoleteDate

getReleaseAuthor

getReleaseDate

toString

equals

hashCode

compareTo