org.squashtest.tm.domain.requirement

Class RequirementVersion

java.lang.Object

org.squashtest.tm.domain.resource.Resource

org.squashtest.tm.domain.requirement.RequirementVersion

All Implemented Interfaces:

AttachmentHolder, BoundEntity, Identified, MilestoneHolder, MilestoneMember

@Entity
@Indexed
@ClassBridges(value={@ClassBridge(name="attachments",store=YES,analyze=NO,impl=RequirementVersionAttachmentBridge.class),@ClassBridge(name="cufs",store=YES,impl=CUFBridge.class,params={,}),@ClassBridge(name="cufs",store=YES,analyze=NO,impl=CUFBridge.class,params={,}),@ClassBridge(name="isCurrentVersion",store=YES,analyze=NO,impl=RequirementVersionIsCurrentBridge.class),@ClassBridge(name="parent",store=YES,analyze=NO,impl=RequirementVersionHasParentBridge.class)})
public class RequirementVersion
extends Resource
implements BoundEntity, MilestoneHolder

Represents a version of a requirement.

Author:

Gregory Fouquet

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RequirementVersion.PropertiesSetter

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_REF_SIZE

Constructor Summary

Constructors

Constructor and Description
RequirementVersion()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRequirementCoverage(RequirementVersionCoverage coverage) Simply add the coverage to this.requirementVersionCoverage THIS DOES NOT SET THE coverage->version SIDE OF THE ASSOCIATION !
void	bindMilestone(Milestone milestone)
void	checkLinkable()
static RequirementVersion	createFromMemento(RequirementVersionImportMemento memento) Factory methiod which creates a RequirementVersion from a memento objet which holds the new object's target state.
RequirementVersion	createPastableCopy() Will create a copy of the requirement version with all attributes, and attachments.
List<RequirementVersionCoverage>	createRequirementVersionCoveragesForCopy(RequirementVersion copyVersion) Will create a copy of this.requirementVersionCoverages.
Boolean	doMilestonesAllowCreation()
Boolean	doMilestonesAllowEdition()
Long	getBoundEntityId()
BindableEntity	getBoundEntityType()
InfoListItem	getCategory()
RequirementCriticality	getCriticality()
String	getFullName()
Set<Milestone>	getMilestones()
Project	getProject()
RequirementVersion.PropertiesSetter	getPropertySetter()
String	getReference()
Requirement	getRequirement()
RequirementVersionCoverage	getRequirementVersionCoverageOrNullFor(TestCase testCase)
Set<RequirementVersionCoverage>	getRequirementVersionCoverages()
RequirementStatus	getStatus()
Set<TestCase>	getVerifyingTestCases() Returns an UNMODIFIABLE VIEW of the verifying test cases.
int	getVersionNumber()
boolean	isLinkable()
boolean	isMemberOf(Milestone milestone)
boolean	isModifiable() Tells if this requirement's "intrinsic" properties can be modified.
boolean	isNotObsolete()
void	removeRequirementVersionCoverage(RequirementVersionCoverage requirementVersionCoverage) Simply remove the RequirementVersionCoverage from this.requirementVersionCoverages.
void	setCategory(InfoListItem category) Set the requirement category
void	setCriticality(RequirementCriticality criticality) Set the requirement criticality
void	setDescription(String description)
void	setName(String name)
void	setReference(String reference) Set the requirement reference
void	setStatus(RequirementStatus status) Sets this object's status, following status transition rules.
void	setVersionNumber(int versionNumber)
void	unbindAllMilestones()
void	unbindMilestone(Long milestoneId)
void	unbindMilestone(Milestone milestone)

Methods inherited from class org.squashtest.tm.domain.resource.Resource

equals, getAttachmentList, getDescription, getId, getName, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.squashtest.tm.domain.Identified

getId

Field Detail

MAX_REF_SIZE

public static final int MAX_REF_SIZE

See Also:

Constant Field Values

Constructor Detail

RequirementVersion

public RequirementVersion()

Method Detail

setName

public void setName(String name)

Overrides:

setName in class Resource

setDescription

public void setDescription(String description)

Overrides:

setDescription in class Resource

getVerifyingTestCases

public Set<TestCase> getVerifyingTestCases()

Returns an UNMODIFIABLE VIEW of the verifying test cases.

checkLinkable

public void checkLinkable()

Throws:

RequirementVersionNotLinkableException

getReference

public String getReference()

Returns:

the reference of the requirement

setReference

public void setReference(String reference)

Set the requirement reference

Parameters:

reference -

getFullName

public String getFullName()

Returns:

{reference} - {name} if reference is not empty, or {name} if it is

getCriticality

public RequirementCriticality getCriticality()

Returns:

the requirement criticality

setCriticality

public void setCriticality(RequirementCriticality criticality)

Set the requirement criticality

Parameters:

criticality -

getCategory

public InfoListItem getCategory()

Returns:

the requirement category

setCategory

public void setCategory(InfoListItem category)

Set the requirement category

Parameters:

category -

setStatus

public void setStatus(RequirementStatus status)

Sets this object's status, following status transition rules.

Parameters:

status -

getStatus

public RequirementStatus getStatus()

isLinkable

public boolean isLinkable()

Returns:

true if this requirement can be (un)linked by new verifying testcases

isModifiable

public boolean isModifiable()

Tells if this requirement's "intrinsic" properties can be modified. The following are not considered as "intrinsic" properties" : #verifyingTestCases are governed by the isLinkable() state, status is governed by itself.

Returns:

true if this requirement's properties can be modified.

getRequirement

public Requirement getRequirement()

Returns:

the requirement

getVersionNumber

public int getVersionNumber()

Returns:

the versionNumber

setVersionNumber

public void setVersionNumber(int versionNumber)

createPastableCopy

public RequirementVersion createPastableCopy()

Will create a copy of the requirement version with all attributes, and attachments. Does not copy requirementVersionCoverages.

Returns:

the requirement-version copy.

isNotObsolete

public boolean isNotObsolete()

createFromMemento

public static RequirementVersion createFromMemento(@NotNull
                                   RequirementVersionImportMemento memento)

Factory methiod which creates a RequirementVersion from a memento objet which holds the new object's target state. This method overrides any RequirementStatus workflow check.

Parameters:

memento -

Returns:

getBoundEntityId

public Long getBoundEntityId()

Specified by:

getBoundEntityId in interface BoundEntity

getBoundEntityType

public BindableEntity getBoundEntityType()

Specified by:

getBoundEntityType in interface BoundEntity

getProject

public Project getProject()

Specified by:

getProject in interface BoundEntity

Specified by:

getProject in interface MilestoneHolder

addRequirementCoverage

public void addRequirementCoverage(RequirementVersionCoverage coverage)

Simply add the coverage to this.requirementVersionCoverage THIS DOES NOT SET THE coverage->version SIDE OF THE ASSOCIATION ! ONE SHOULD RATHER CALL coverage.setVerifiedRequirementVersion(..)

Parameters:

coverage -

getRequirementVersionCoverageOrNullFor

public RequirementVersionCoverage getRequirementVersionCoverageOrNullFor(TestCase testCase)

removeRequirementVersionCoverage

public void removeRequirementVersionCoverage(RequirementVersionCoverage requirementVersionCoverage)

Simply remove the RequirementVersionCoverage from this.requirementVersionCoverages.

Parameters:

requirementVersionCoverage - : the entity to remove from this requirement version's RequirementVersionCoverages list.

Throws:

RequirementVersionNotLinkableException

createRequirementVersionCoveragesForCopy

public List<RequirementVersionCoverage> createRequirementVersionCoveragesForCopy(RequirementVersion copyVersion)

Will create a copy of this.requirementVersionCoverages. Each RequirementVersionCoverage having, instead of this the copyVersion param as their verifiedRequirementVersion.

Parameters:

copyVersion -

Returns:

the copies of RequirementVersionCoverages

Throws:

RequirementVersionNotLinkableException

RequirementAlreadyVerifiedException

getRequirementVersionCoverages

public Set<RequirementVersionCoverage> getRequirementVersionCoverages()

getMilestones

public Set<Milestone> getMilestones()

Specified by:

getMilestones in interface MilestoneMember

isMemberOf

public boolean isMemberOf(Milestone milestone)

Specified by:

isMemberOf in interface MilestoneMember

bindMilestone

public void bindMilestone(Milestone milestone)

Specified by:

bindMilestone in interface MilestoneHolder

unbindMilestone

public void unbindMilestone(Milestone milestone)

Specified by:

unbindMilestone in interface MilestoneHolder

unbindMilestone

public void unbindMilestone(Long milestoneId)

Specified by:

unbindMilestone in interface MilestoneHolder

unbindAllMilestones

public void unbindAllMilestones()

Specified by:

unbindAllMilestones in interface MilestoneHolder

See Also:

MilestoneHolder.unbindAllMilestones()

doMilestonesAllowCreation

public Boolean doMilestonesAllowCreation()

Specified by:

doMilestonesAllowCreation in interface MilestoneMember

doMilestonesAllowEdition

public Boolean doMilestonesAllowEdition()

Specified by:

doMilestonesAllowEdition in interface MilestoneMember

getPropertySetter

public RequirementVersion.PropertiesSetter getPropertySetter()