org.squashtest.tm.domain.campaign

Class Campaign

java.lang.Object

org.squashtest.tm.domain.library.GenericLibraryNode

org.squashtest.tm.domain.campaign.CampaignLibraryNode

org.squashtest.tm.domain.campaign.Campaign

All Implemented Interfaces:

AttachmentHolder, BoundEntity, Identified, Copiable, LibraryNode, NodeContainer<Iteration>, TreeNode, MilestoneHolder, MilestoneMember, ProjectResource<Project>

@Entity
public class Campaign
extends CampaignLibraryNode
implements NodeContainer<Iteration>, BoundEntity, MilestoneHolder

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_REF_SIZE

Constructor Summary

Constructors

Constructor and Description
Campaign()

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(CampaignLibraryNodeVisitor visitor)
void	accept(NodeContainerVisitor visitor)
void	accept(NodeVisitor visitor)
void	addContent(Iteration iteration) Adds new content to this container.
void	addContent(Iteration iteration, int position) Adds new content to this container at the given position.
void	addIteration(Iteration iteration)
void	addIteration(Iteration iteration, int position)
void	addToTestPlan(CampaignTestPlanItem itemTestPlan)
void	bindMilestone(Milestone milestone) A campaign can belong to one milestone at a time.
Campaign	createCopy()
Boolean	doMilestonesAllowCreation()
Boolean	doMilestonesAllowEdition()
CampaignTestPlanItem	findTestPlanItem(TestCase testCase)
Date	getActualEndDate()
Date	getActualStartDate()
Long	getBoundEntityId()
BindableEntity	getBoundEntityType()
List<Iteration>	getContent()
List<String>	getContentNames()
String	getFullName()
List<Iteration>	getIterations()
Set<Milestone>	getMilestones()
List<Iteration>	getOrderedContent() Will return the ordered (if order there is) content nodes.
String	getReference()
Date	getScheduledEndDate()
Date	getScheduledStartDate()
List<CampaignTestPlanItem>	getTestPlan()
boolean	hasContent()
boolean	hasIterations()
boolean	isActualEndAuto()
boolean	isActualStartAuto()
boolean	isBindableToMilestone()
boolean	isContentNameAvailable(String name)
boolean	isMemberOf(Milestone milestone)
void	moveIterations(int newIndex, List<Iteration> moved)
void	moveTestPlanItems(int targetIndex, List<Long> itemIds)
void	removeContent(Iteration contentToRemove)
void	removeIteration(Iteration iteration)
void	removeTestPlanItem(CampaignTestPlanItem itemTestPlan)
void	removeTestPlanItem(long itemId)
void	removeTestPlanItems(List<Long> itemIds)
void	setActualEndAuto(boolean actualEndAuto)
void	setActualEndDate(Date actualEndDate)
void	setActualStartAuto(boolean actualStartAuto)
void	setActualStartDate(Date actualStartDate)
void	setReference(String reference)
void	setScheduledEndDate(Date endDate)
void	setScheduledStartDate(Date startDate)
boolean	testPlanContains(TestCase tc)
void	unbindAllMilestones()
void	unbindMilestone(Long milestoneId)
void	unbindMilestone(Milestone milestone)
void	updateActualEnd(Date newIterationEndDate)
void	updateActualStart(Date newIterationStartDate) If the iteration have autodates set, they will be updated accordingly.

Methods inherited from class org.squashtest.tm.domain.campaign.CampaignLibraryNode

getGenericNodeClass, getId, getLibrary

Methods inherited from class org.squashtest.tm.domain.library.GenericLibraryNode

equals, getAttachmentList, getDescription, getName, getProject, hashCode, notifyAssociatedWithProject, setDescription, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.squashtest.tm.domain.library.NodeContainer

getProject

Methods inherited from interface org.squashtest.tm.domain.customfield.BoundEntity

getProject

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

getId

Methods inherited from interface org.squashtest.tm.domain.milestone.MilestoneHolder

getProject

Field Detail

MAX_REF_SIZE

public static final int MAX_REF_SIZE

See Also:

Constant Field Values

Constructor Detail

Campaign

public Campaign()

Method Detail

accept

public void accept(CampaignLibraryNodeVisitor visitor)

Specified by:

accept in class CampaignLibraryNode

accept

public void accept(NodeContainerVisitor visitor)

Specified by:

accept in interface NodeContainer<Iteration>

setScheduledStartDate

public void setScheduledStartDate(Date startDate)

getScheduledStartDate

public Date getScheduledStartDate()

setScheduledEndDate

public void setScheduledEndDate(Date endDate)

getScheduledEndDate

public Date getScheduledEndDate()

getActualStartDate

public Date getActualStartDate()

setActualStartDate

public void setActualStartDate(Date actualStartDate)

getActualEndDate

public Date getActualEndDate()

getTestPlan

public List<CampaignTestPlanItem> getTestPlan()

setActualEndDate

public void setActualEndDate(Date actualEndDate)

isActualStartAuto

public boolean isActualStartAuto()

isActualEndAuto

public boolean isActualEndAuto()

setActualStartAuto

public void setActualStartAuto(boolean actualStartAuto)

setActualEndAuto

public void setActualEndAuto(boolean actualEndAuto)

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

findTestPlanItem

public CampaignTestPlanItem findTestPlanItem(TestCase testCase)

Parameters:

testCase -

Returns:

the test plan item which references the given test case, if any.

addToTestPlan

public void addToTestPlan(@NotNull
                 CampaignTestPlanItem itemTestPlan)

Parameters:

itemTestPlan -

removeTestPlanItem

public void removeTestPlanItem(@NotNull
                      CampaignTestPlanItem itemTestPlan)

removeTestPlanItem

public void removeTestPlanItem(long itemId)

removeTestPlanItems

public void removeTestPlanItems(List<Long> itemIds)

removeIteration

public void removeIteration(@NotNull
                   Iteration iteration)

moveIterations

public void moveIterations(int newIndex,
                  List<Iteration> moved)

getIterations

public List<Iteration> getIterations()

addIteration

public void addIteration(@NotNull
                Iteration iteration)

addIteration

public void addIteration(@NotNull
                Iteration iteration,
                int position)

createCopy

public Campaign createCopy()

Specified by:

createCopy in interface Copiable

isContentNameAvailable

public boolean isContentNameAvailable(String name)

Specified by:

isContentNameAvailable in interface NodeContainer<Iteration>

updateActualStart

public void updateActualStart(Date newIterationStartDate)

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

Parameters:

newIterationStartDate -

updateActualEnd

public void updateActualEnd(Date newIterationEndDate)

testPlanContains

public boolean testPlanContains(@NotNull
                       TestCase tc)

hasIterations

public boolean hasIterations()

moveTestPlanItems

public void moveTestPlanItems(int targetIndex,
                     List<Long> itemIds)

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

getContent

public List<Iteration> getContent()

Specified by:

getContent in interface NodeContainer<Iteration>

getOrderedContent

public List<Iteration> getOrderedContent()

Description copied from interface: NodeContainer

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

Specified by:

getOrderedContent in interface NodeContainer<Iteration>

Returns:

hasContent

public boolean hasContent()

Specified by:

hasContent in interface NodeContainer<Iteration>

addContent

public void addContent(Iteration iteration)
                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<Iteration>

Throws:

DuplicateNameException

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

addContent

public void addContent(Iteration iteration,
              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<Iteration>

Throws:

DuplicateNameException

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

removeContent

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

Specified by:

removeContent in interface NodeContainer<Iteration>

Throws:

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

getContentNames

public List<String> getContentNames()

Specified by:

getContentNames in interface NodeContainer<Iteration>

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)

A campaign can belong to one milestone at a time. When a milestone is bound to a campaign, the previous milestone will be unbound.

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()

isBindableToMilestone

public boolean isBindableToMilestone()

doMilestonesAllowCreation

public Boolean doMilestonesAllowCreation()

Specified by:

doMilestonesAllowCreation in interface MilestoneMember

doMilestonesAllowEdition

public Boolean doMilestonesAllowEdition()

Specified by:

doMilestonesAllowEdition in interface MilestoneMember