org.squashtest.tm.domain.campaign

Class Iteration

java.lang.Object

org.squashtest.tm.domain.campaign.Iteration

All Implemented Interfaces:

AttachmentHolder, BoundEntity, Identified, Copiable, NodeContainer<TestSuite>, TreeNode, MilestoneMember

@Entity
public class Iteration
extends Object
implements AttachmentHolder, NodeContainer<TestSuite>, TreeNode, Copiable, Identified, BoundEntity, MilestoneMember

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_REF_SIZE

Constructor Summary

Constructors

Constructor and Description
Iteration()

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(NodeContainerVisitor visitor)
void	accept(NodeVisitor visitor)
void	addContent(TestSuite testSuite) Adds new content to this container.
void	addContent(TestSuite testSuite, int position) Adds new content to this container at the given position.
void	addTestPlan(IterationTestPlanItem testPlan)
void	addTestSuite(TestSuite suite)
void	addTestSuite(TestSuite suite, int position)
boolean	checkSuiteNameAvailable(String name)
Iteration	createCopy() copy of iteration doesn't contain test-suites !!
Map<TestSuite,List<Integer>>	createTestSuitesPastableCopy() this method is used in case of copy paste of an iteration with test suites.
Boolean	doMilestonesAllowCreation()
Boolean	doMilestonesAllowEdition()
int	findItemIndexInTestPlan(long testPlanId) Method which returns the position of an item test plan in the current iteration
int	findTestCaseIndexInTestPlan(long testCaseId) Method which returns the position of a test case in the current iteration
Date	getActualEndDate()
Date	getActualStartDate()
AttachmentList	getAttachmentList() Should return the container for this object's attachments.
Long	getBoundEntityId()
BindableEntity	getBoundEntityType()
Campaign	getCampaign()
CampaignLibrary	getCampaignLibrary()
List<TestSuite>	getContent() The content of an iteration means its test suites.
List<String>	getContentNames()
String	getDescription()
List<Execution>	getExecutions() flattened list of the executions
String	getFullName()
Long	getId()
int	getIndexOf(IterationTestPlanItem item)
Set<Milestone>	getMilestones()
String	getName()
Collection<TestSuite>	getOrderedContent() Will return the ordered (if order there is) content nodes.
List<TestCase>	getPlannedTestCase()
Project	getProject() A node container can be a library.
String	getReference()
Date	getScheduledEndDate()
Date	getScheduledStartDate()
List<IterationTestPlanItem>	getTestPlans()
TestSuite	getTestSuiteByName(String tsName)
List<TestSuite>	getTestSuites()
boolean	hasContent()
boolean	hasTestSuites()
boolean	isActualEndAuto()
boolean	isActualStartAuto()
boolean	isContentNameAvailable(String name)
boolean	isMemberOf(Milestone milestone)
void	moveTestPlan(int currentPosition, int newPosition) Deprecated.
void	moveTestPlans(int newIndex, List<IterationTestPlanItem> movedItems)
void	removeContent(TestSuite contentToRemove)
void	removeItemFromTestPlan(IterationTestPlanItem testPlanItem)
void	removeTestSuite(TestSuite testSuite)
void	setActualEndAuto(boolean actualEndAuto)
void	setActualEndDate(Date endDate)
void	setActualStartAuto(boolean actualStartAuto)
void	setActualStartDate(Date startDate)
void	setDescription(String description)
void	setName(String name)
void	setReference(String reference)
void	setScheduledEndDate(Date endDate)
void	setScheduledStartDate(Date startDate)
void	updateAutoDates(Date newItemTestPlanDate) If the iteration have autodates set, they will be updated accordingly.
void	updateAutoDatesAfterExecutionDetach(IterationTestPlanItem iterationTestPlanItem) will update acual end and start dates if are auto and if they were driven by the execution last-executed on

Methods inherited from class java.lang.Object

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

Field Detail

MAX_REF_SIZE

public static final int MAX_REF_SIZE

See Also:

Constant Field Values

Constructor Detail

Iteration

public Iteration()

Method Detail

getExecutions

public List<Execution> getExecutions()

flattened list of the executions

setName

public void setName(String name)

Specified by:

setName in interface Copiable

getName

@NotBlank
public String getName()

Specified by:

getName in interface Copiable

getReference

public String getReference()

setReference

public void setReference(String reference)

getFullName

public String getFullName()

Returns:

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

getCampaign

public Campaign getCampaign()

setDescription

public void setDescription(String description)

getDescription

public String getDescription()

setScheduledStartDate

public void setScheduledStartDate(Date startDate)

getScheduledStartDate

public Date getScheduledStartDate()

setScheduledEndDate

public void setScheduledEndDate(Date endDate)

getScheduledEndDate

public Date getScheduledEndDate()

setActualStartDate

public void setActualStartDate(Date startDate)

getActualStartDate

public Date getActualStartDate()

setActualEndDate

public void setActualEndDate(Date endDate)

getActualEndDate

public Date getActualEndDate()

isActualStartAuto

public boolean isActualStartAuto()

isActualEndAuto

public boolean isActualEndAuto()

setActualStartAuto

public void setActualStartAuto(boolean actualStartAuto)

setActualEndAuto

public void setActualEndAuto(boolean actualEndAuto)

getId

public Long getId()

Specified by:

getId in interface Identified

createCopy

public Iteration createCopy()

copy of iteration doesn't contain test-suites !!

Specified by:

createCopy in interface Copiable

Returns:

getTestPlans

public List<IterationTestPlanItem> getTestPlans()

getPlannedTestCase

public List<TestCase> getPlannedTestCase()

removeTestSuite

public void removeTestSuite(@NotNull
                   TestSuite testSuite)

removeItemFromTestPlan

public void removeItemFromTestPlan(@NotNull
                          IterationTestPlanItem testPlanItem)

addTestPlan

public void addTestPlan(@NotNull
               IterationTestPlanItem testPlan)

findTestCaseIndexInTestPlan

public int findTestCaseIndexInTestPlan(long testCaseId)

Method which returns the position of a test case in the current iteration

Parameters:

testCaseId - the id of the test case we're looking for

Returns:

the position of the test case (int)

Throws:

UnknownEntityException - if not found.

findItemIndexInTestPlan

public int findItemIndexInTestPlan(long testPlanId)

Method which returns the position of an item test plan in the current iteration

Parameters:

testPlanId - the id of the test plan we're looking for

Returns:

the position of the test plan (int)

Throws:

UnknownEntityException - if not found.

moveTestPlan

@Deprecated
public void moveTestPlan(int currentPosition,
                           int newPosition)

Deprecated.

Method which sets a test case at a new position

Parameters:

currentPosition - the current position

newPosition - the new position

moveTestPlans

public void moveTestPlans(int newIndex,
                 List<IterationTestPlanItem> movedItems)

getIndexOf

public int getIndexOf(IterationTestPlanItem item)

getTestSuites

public List<TestSuite> getTestSuites()

getTestSuiteByName

public TestSuite getTestSuiteByName(String tsName)

addTestSuite

public void addTestSuite(TestSuite suite)

addTestSuite

public void addTestSuite(TestSuite suite,
                int position)

checkSuiteNameAvailable

public boolean checkSuiteNameAvailable(String name)

hasTestSuites

public boolean hasTestSuites()

getAttachmentList

public AttachmentList getAttachmentList()

Description copied from interface: AttachmentHolder

Should return the container for this object's attachments. Should never return null.

Specified by:

getAttachmentList in interface AttachmentHolder

Returns:

the AttachmentList of this object.

getProject

public Project getProject()

Description copied from interface: NodeContainer

A node container can be a library. That can be bound to a project template.

Specified by:

getProject in interface BoundEntity

Specified by:

getProject in interface NodeContainer<TestSuite>

Specified by:

getProject in interface TreeNode

getCampaignLibrary

public CampaignLibrary getCampaignLibrary()

updateAutoDates

public void updateAutoDates(Date newItemTestPlanDate)

If the iteration have autodates set, they will be updated accordingly.

Parameters:

newItemTestPlanDate -

createTestSuitesPastableCopy

public Map<TestSuite,List<Integer>> createTestSuitesPastableCopy()

this method is used in case of copy paste of an iteration with test suites.

Returns:

A map of test suite and indexes
One entry-set contains

• a copied test suite (without it's test plan)
• and the indexes of the copied test plan that are to be linked with it (taking into account test_plan_items that are test_case deleted)

updateAutoDatesAfterExecutionDetach

public void updateAutoDatesAfterExecutionDetach(IterationTestPlanItem iterationTestPlanItem)

will update acual end and start dates if are auto and if they were driven by the execution last-executed on

getBoundEntityId

public Long getBoundEntityId()

Specified by:

getBoundEntityId in interface BoundEntity

getBoundEntityType

public BindableEntity getBoundEntityType()

Specified by:

getBoundEntityType in interface BoundEntity

accept

public void accept(NodeVisitor visitor)

Specified by:

accept in interface TreeNode

accept

public void accept(NodeContainerVisitor visitor)

Specified by:

accept in interface NodeContainer<TestSuite>

addContent

public void addContent(@NotNull
              TestSuite testSuite)
                throws DuplicateNameException,
                       org.squashtest.tm.core.foundation.exception.NullArgumentException

Description copied from interface: NodeContainer

Adds new content to this container. Should refuse to add null content, should refuse to add content with duplicate name.

Specified by:

addContent in interface NodeContainer<TestSuite>

Throws:

DuplicateNameException

org.squashtest.tm.core.foundation.exception.NullArgumentException

addContent

public void addContent(@NotNull
              TestSuite testSuite,
              int position)
                throws DuplicateNameException,
                       org.squashtest.tm.core.foundation.exception.NullArgumentException

Description copied from interface: NodeContainer

Adds new content to this container at the given position. Should refuse to add null content, should refuse to add content with duplicate name.

Specified by:

addContent in interface NodeContainer<TestSuite>

Throws:

DuplicateNameException

org.squashtest.tm.core.foundation.exception.NullArgumentException

isContentNameAvailable

public boolean isContentNameAvailable(String name)

Specified by:

isContentNameAvailable in interface NodeContainer<TestSuite>

getContent

public List<TestSuite> getContent()

The content of an iteration means its test suites.

Specified by:

getContent in interface NodeContainer<TestSuite>

See Also:

NodeContainer.getContent()

getOrderedContent

public Collection<TestSuite> getOrderedContent()

Description copied from interface: NodeContainer

Will return the ordered (if order there is) content nodes.

Specified by:

getOrderedContent in interface NodeContainer<TestSuite>

Returns:

hasContent

public boolean hasContent()

Specified by:

hasContent in interface NodeContainer<TestSuite>

Returns:

true if there are test suites

See Also:

NodeContainer.hasContent()

removeContent

public void removeContent(TestSuite contentToRemove)
                   throws org.squashtest.tm.core.foundation.exception.NullArgumentException

Specified by:

removeContent in interface NodeContainer<TestSuite>

Throws:

org.squashtest.tm.core.foundation.exception.NullArgumentException

getContentNames

public List<String> getContentNames()

Specified by:

getContentNames in interface NodeContainer<TestSuite>

getMilestones

public Set<Milestone> getMilestones()

Specified by:

getMilestones in interface MilestoneMember

isMemberOf

public boolean isMemberOf(Milestone milestone)

Specified by:

isMemberOf in interface MilestoneMember

doMilestonesAllowCreation

public Boolean doMilestonesAllowCreation()

Specified by:

doMilestonesAllowCreation in interface MilestoneMember

doMilestonesAllowEdition

public Boolean doMilestonesAllowEdition()

Specified by:

doMilestonesAllowEdition in interface MilestoneMember