org.squashtest.tm.domain.campaign

Class TestSuite

java.lang.Object

org.squashtest.tm.domain.campaign.TestSuite

All Implemented Interfaces:

AttachmentHolder, BoundEntity, Identified, Copiable, TreeNode, MilestoneMember

@Entity
@Indexed
public class TestSuite
extends Object
implements Identified, Copiable, TreeNode, BoundEntity, AttachmentHolder, MilestoneMember

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_NAME_SIZE

Constructor Summary

Constructors

Constructor and Description
TestSuite()

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(NodeVisitor visitor)
void	bindTestPlanItem(IterationTestPlanItem item)
void	bindTestPlanItems(List<IterationTestPlanItem> items) Binds the test plan items to this test suite
void	bindTestPlanItemsById(List<Long> itemIds) Binds the test plan items to this test suite using their id to retrieve them from the iteration.
TestSuite	createCopy() returns a copy of a test Suite without it's test plan.
List<IterationTestPlanItem>	createPastableCopyOfTestPlan() returns an ordered copy of the test-suite test plan -test plans items that are not linked to a test case are not copied -the copy of a test plan item is done using IterationTestPlanItem.createCopy()
Boolean	doMilestonesAllowCreation()
Boolean	doMilestonesAllowEdition()
IterationTestPlanItem	findFirstExecutableTestPlanItem()
IterationTestPlanItem	findFirstExecutableTestPlanItem(String testerLogin)
IterationTestPlanItem	findNextExecutableTestPlanItem(long testPlanItemId) finds next item (that last execution has unexecuted step) or (has no execution and is not test case deleted) can return item linked to test-case with no step
IterationTestPlanItem	findNextExecutableTestPlanItem(long testPlanItemId, String testerLogin) finds next item (that last execution has unexecuted step) or (has no execution and is not test case deleted) and that is assigned to the current user if he is a tester.
AttachmentList	getAttachmentList() Should return the container for this object's attachments.
Long	getBoundEntityId()
BindableEntity	getBoundEntityType()
String	getDescription()
IterationTestPlanItem	getFirstTestPlanItem()
IterationTestPlanItem	getFirstTestPlanItem(String testerLogin)
Long	getId()
Iteration	getIteration()
Set<Milestone>	getMilestones()
String	getName()
Project	getProject()
List<IterationTestPlanItem>	getTestPlan()
boolean	isFirstExecutableTestPlanItem(long itemId) Determines if the item is the first of the test plan of the test suite
boolean	isFirstExecutableTestPlanItem(long itemId, String testerLogin) Determines if the item is the first of the test plan of the test suite
boolean	isLastExecutableTestPlanItem(long itemId)
boolean	isLastExecutableTestPlanItem(long itemId, String userLogin)
boolean	isMemberOf(Milestone milestone)
void	rename(String newName)
void	reorderTestPlan(int newIndex, List<IterationTestPlanItem> movedItems) Since the test plan of a TestSuite is merely a view on the backing iteration, we will reorder here the test plan accordingly.
void	setDescription(String description)
void	setName(String name)
void	setTestPlan(List<IterationTestPlanItem> testPlan)
void	unBindTestPlan(IterationTestPlanItem item)
void	unBindTestPlan(List<IterationTestPlanItem> items)

Methods inherited from class java.lang.Object

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

Field Detail

MAX_NAME_SIZE

public static final int MAX_NAME_SIZE

See Also:

Constant Field Values

Constructor Detail

TestSuite

public TestSuite()

Method Detail

getId

public Long getId()

Specified by:

getId in interface Identified

getName

public String getName()

Specified by:

getName in interface Copiable

setName

public void setName(String name)

Specified by:

setName in interface Copiable

rename

public void rename(String newName)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getIteration

public Iteration getIteration()

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.

getFirstTestPlanItem

public IterationTestPlanItem getFirstTestPlanItem()

getFirstTestPlanItem

public IterationTestPlanItem getFirstTestPlanItem(String testerLogin)

bindTestPlanItems

public void bindTestPlanItems(List<IterationTestPlanItem> items)

Binds the test plan items to this test suite

bindTestPlanItem

public void bindTestPlanItem(IterationTestPlanItem item)

unBindTestPlan

public void unBindTestPlan(List<IterationTestPlanItem> items)

unBindTestPlan

public void unBindTestPlan(IterationTestPlanItem item)

bindTestPlanItemsById

public void bindTestPlanItemsById(List<Long> itemIds)

Binds the test plan items to this test suite using their id to retrieve them from the iteration.

reorderTestPlan

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

Since the test plan of a TestSuite is merely a view on the backing iteration, we will reorder here the test plan accordingly. For instance if the newIndex is x in the TS test plan, Ix being the item at position x in the TS test plan, we will place the moved items at position y in Iteration test plan where y is the position of Ix in the Iteration test plan.

createPastableCopyOfTestPlan

public List<IterationTestPlanItem> createPastableCopyOfTestPlan()

returns an ordered copy of the test-suite test plan
-test plans items that are not linked to a test case are not copied
-the copy of a test plan item is done using IterationTestPlanItem.createCopy()

Returns:

an ordered copy of the test-suite test plan

createCopy

public TestSuite createCopy()

returns a copy of a test Suite without it's test plan.
a copy of the test plan can be found at createPastableCopyOfTestPlan()

Specified by:

createCopy in interface Copiable

Returns:

returns a copy of a test Suite

isLastExecutableTestPlanItem

public boolean isLastExecutableTestPlanItem(long itemId)

isLastExecutableTestPlanItem

public boolean isLastExecutableTestPlanItem(long itemId,
                                   String userLogin)

isFirstExecutableTestPlanItem

public boolean isFirstExecutableTestPlanItem(long itemId)

Determines if the item is the first of the test plan of the test suite

isFirstExecutableTestPlanItem

public boolean isFirstExecutableTestPlanItem(long itemId,
                                    String testerLogin)

Determines if the item is the first of the test plan of the test suite

Parameters:

itemId - : the id of the item to determine if it is the first executable test plan item

testerLogin - : the id of the current user if he is a Test runner

findNextExecutableTestPlanItem

public IterationTestPlanItem findNextExecutableTestPlanItem(long testPlanItemId)

finds next item (that last execution has unexecuted step) or (has no execution and is not test case deleted) can return item linked to test-case with no step

Throws:

TestPlanItemNotExecutableException - if no item is found

IllegalArgumentException - if id does not correspond to an item of the test suite

findNextExecutableTestPlanItem

public IterationTestPlanItem findNextExecutableTestPlanItem(long testPlanItemId,
                                                   String testerLogin)

finds next item (that last execution has unexecuted step) or (has no execution and is not test case deleted) and that is assigned to the current user if he is a tester.
NB: can return item linked to test-case with no step

Parameters:

testerLogin - : the login of the connected user if he is a Test Runner

Throws:

TestPlanItemNotExecutableException - if no item is found

IllegalArgumentException - if id does not correspond to an item of the test suite

findFirstExecutableTestPlanItem

public IterationTestPlanItem findFirstExecutableTestPlanItem()

findFirstExecutableTestPlanItem

public IterationTestPlanItem findFirstExecutableTestPlanItem(String testerLogin)

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 TreeNode

accept

public void accept(NodeVisitor visitor)

Specified by:

accept in interface TreeNode

getTestPlan

public List<IterationTestPlanItem> getTestPlan()

setTestPlan

public void setTestPlan(List<IterationTestPlanItem> testPlan)

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