com.versionone.om
Class Project

java.lang.Object
  com.versionone.om.Entity
      com.versionone.om.BaseAsset
          com.versionone.om.Project

public class Project
extends BaseAsset

Represents a project or release in the VersionOne system.

Field Summary

Fields inherited from class com.versionone.om.BaseAsset

STATE_ACTIVE, STATE_CLOSED

Fields inherited from class com.versionone.om.Entity

ASSET_STATE_VALUE, ASSET_VALUE, CHANGE_DATE_UTC, CONTENT_TYPE_VALUE, CONTENT_VALUE, CREATE_DATE_UTC, DELETE_OPERATION, DESCRIPTION_VALUE, FILENAME_VALUE, NAME_VALUE

Method Summary

Defect	createDefect(java.lang.String name) Create a new Defect in this Project.
Defect	createDefect(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> attributes) Create a new Defect in this Project.
Environment	createEnvironment(java.lang.String name) Creates a new Environment in the Project.
Environment	createEnvironment(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> attributes) Creates a new Environment in the Project with additional attributes.
Epic	createEpic(java.lang.String name) Create a new Epic in this Project.
Epic	createEpic(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> attributes) Create a new Epic in this Project.
Goal	createGoal(java.lang.String name) Create a new Goal in this Project.
Goal	createGoal(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> attributes) Create a new Goal in this Project.
Issue	createIssue(java.lang.String name) Create a new Issue in this Project.
Issue	createIssue(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> attributes) Create a new Issue in this Project.
Iteration	createIteration() Create a new Iteration in the Project where the schedule is defined.
Iteration	createIteration(java.util.Map<java.lang.String,java.lang.Object> attributes) Create a new Iteration in the Project where the schedule is defined.
Iteration	createIteration(java.lang.String name, DateTime beginDate, DateTime endDate) Create a new Iteration in the Project where the schedule is defined.
Iteration	createIteration(java.lang.String name, DateTime beginDate, DateTime endDate, java.util.Map<java.lang.String,java.lang.Object> attributes) Create a new Iteration in the Project where the schedule is defined.
RegressionPlan	createRegressionPlan(java.lang.String name) Creates a new Regression Plan in the Project with additional attributes.
RegressionPlan	createRegressionPlan(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> attributes) Creates a new Regression Plan in the Project with additional attributes.
RegressionTest	createRegressionTest(java.lang.String name) Creates a new Regression Test in the Project.
RegressionTest	createRegressionTest(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> attributes) Creates a new Regression Test in the Project.
Request	createRequest(java.lang.String name) Create a new Request in this Project.
Request	createRequest(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> attributes) Create a new Request in this Project.
Retrospective	createRetrospective(java.lang.String name) Create a new Retrospective in this Project.
Retrospective	createRetrospective(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> attributes) Create a new Retrospective in this Project.
Story	createStory(java.lang.String name) Create a new Story in this Project.
Story	createStory(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> attributes)
Project	createSubProject(java.lang.String name, DateTime beginDate) Create a sub project under this project with a name and begin date.
Project	createSubProject(java.lang.String name, DateTime beginDate, Schedule schedule) Create a sub project under this project with a name, begin date, and optional schedule.
Project	createSubProject(java.lang.String name, DateTime beginDate, Schedule schedule, java.util.Map<java.lang.String,java.lang.Object> attributes)
TestSet	createTestSet(java.lang.String name, RegressionSuite suite) Create a new Test Set in the project.
TestSet	createTestSet(java.lang.String name, RegressionSuite suite, java.util.Map<java.lang.String,java.lang.Object> attributes) Create a new Test Set in the project.
Theme	createTheme(java.lang.String name) Create a new Theme in this Project.
Theme	createTheme(java.lang.String name, java.util.Map<java.lang.String,java.lang.Object> attributes) Create a new Theme in this Project.
java.util.Collection<Member>	getAssignedMembers()
DateTime	getBeginDate()
java.util.Collection<BuildProject>	getBuildProjects()
java.util.Collection<Project>	getChildProjects(ProjectFilter filter) A collection of sub-projects that belong to this project.
java.util.Collection<Project>	getChildProjects(ProjectFilter filter, boolean includeSubprojects) A collection of sub-projects that belong to this project.
java.util.Collection<Defect>	getDefects(DefectFilter filter) filter Get Defects in this Project filtered as specified in the passed in filter.
java.util.Collection<Defect>	getDefects(DefectFilter filter, boolean includeSubprojects) Get Defects in this Project filtered as specified in the passed in filter.
java.util.Collection<DefectTemplate>	getDefectTemplates()
java.util.Collection<Effort>	getEffortRecords(EffortFilter filter) A collection of Effort records that belong to this project.
java.util.Collection<Effort>	getEffortRecords(EffortFilter filter, boolean includeSubprojects) A collection of Effort records that belong to this project.
DateTime	getEndDate()
java.util.Collection<Epic>	getEpics(EpicFilter filter) Get Epics in this Project filtered as specified in the passed in filter.
java.util.Collection<Epic>	getEpics(EpicFilter filter, boolean includeSubprojects) Get Epics in this Project filtered as specified in the passed in filter.
java.util.Collection<Goal>	getGoals(GoalFilter filter) Get Goals in this Project filtered as specified in the passed in filter.
java.util.Collection<Goal>	getGoals(GoalFilter filter, boolean includeSubprojects) Get Goals in this Project filtered as specified in the passed in filter.
java.util.Collection<Issue>	getIssues(IssueFilter filter) Get Issues in this Project filtered as specified in the passed in filter.
java.util.Collection<Issue>	getIssues(IssueFilter filter, boolean includeSubprojects) Get Issues in this Project filtered as specified in the passed in filter.
java.util.Collection<Iteration>	getIterations(IterationFilter filter) Get Iterations in this Project filtered as specified in the passed in filter.
java.util.Collection<Iteration>	getIterations(IterationFilter filter, boolean includeSubprojects) Get Iterations in this Project's schedule filtered as specified in the passed in filter.
Member	getOwner()
Project	getParentProject()
java.util.Collection<PrimaryWorkitem>	getPrimaryWorkitems(PrimaryWorkitemFilter filter) Get PrimaryWorkitems in this Project filtered as specified in the passed in filter.
java.util.Collection<PrimaryWorkitem>	getPrimaryWorkitems(PrimaryWorkitemFilter filter, boolean includeSubprojects) Get PrimaryWorkitems in this Project filtered as specified in the passed in filter.
java.util.Collection<RegressionPlan>	getRegressionPlans(RegressionPlanFilter filter) A collection of regression plans that belong to this project.
java.util.Collection<RegressionPlan>	getRegressionPlans(RegressionPlanFilter filter, boolean includeSubprojects) A collection of regression plans that belong to this project.
java.util.Collection<Request>	getRequests(RequestFilter filter) Get Requests in this Project filtered as specified in the passed in filter.
java.util.Collection<Request>	getRequests(RequestFilter filter, boolean includeSubprojects) Get Requests in this Project filtered as specified in the passed in filter.
java.util.Collection<Retrospective>	getRetrospectives(RetrospectiveFilter filter) Get Retrospective in this Project filtered as specified in the passed in filter.
java.util.Collection<Retrospective>	getRetrospectives(RetrospectiveFilter filter, boolean includeSubprojects) Get Retrospective in this Project filtered as specified in the passed in filter.
Schedule	getSchedule()
java.util.Collection<SecondaryWorkitem>	getSecondaryWorkitems(SecondaryWorkitemFilter filter) Get SecondaryWorkitems in this Project filtered as specified in the passed in filter.
java.util.Collection<SecondaryWorkitem>	getSecondaryWorkitems(SecondaryWorkitemFilter filter, boolean includeSubprojects) Get SecondaryWorkitems in this Project filtered as specified in the passed in filter.
IListValueProperty	getStatus()
java.util.Collection<Story>	getStories(StoryFilter filter) Get stories in this Project filtered as specified in the passed in filter.
java.util.Collection<Story>	getStories(StoryFilter filter, boolean includeSubprojects) Get stories in this Project filtered as specified in the passed in filter.
java.util.Collection<StoryTemplate>	getStoryTemplates()
java.util.Collection<Task>	getTasks(TaskFilter filter) Get Tasks in this Project filtered as specified in the passed in filter.
java.util.Collection<Test>	getTests(TestFilter filter) Get Tests in this Project filtered as specified in the passed in filter.
java.util.Collection<TestSet>	getTestSets(TestSetFilter filter) Get test sets in this Project filtered as specified in the passed in filter.
java.util.Collection<TestSet>	getTestSets(TestSetFilter filter, boolean includeSubprojects) Get test sets in this Project filtered as specified in the passed in filter.
TestSuite	getTestSuite()
java.util.Collection<Theme>	getThemes(ThemeFilter filter) Get Themes in this Project filtered as specified in the passed in filter.
java.util.Collection<Theme>	getThemes(ThemeFilter filter, boolean includeSubprojects) Get Themes in this Project filtered as specified in the passed in filter.
java.util.Collection<Project>	getThisAndAllChildProjects() Returns a flattened collection of this project and all Projects that descend from this project.
java.lang.Double	getTotalDetailEstimate(WorkitemFilter filter) Count the total detail estimate for all workitems in this project optionally filtered.
java.lang.Double	getTotalDetailEstimate(WorkitemFilter filter, boolean includeChildProjects) Count the total detail estimate for all workitems in this project optionally filtered.
java.lang.Double	getTotalDone(WorkitemFilter filter) Retrieves the total done for all workitems in this project optionally filtered.
java.lang.Double	getTotalDone(WorkitemFilter filter, boolean includeChildProjects) Retrieves the total done for all workitems in this project optionally filtered.
java.lang.Double	getTotalEstimate(PrimaryWorkitemFilter filter) Retrieves the total estimate for all stories and defects in this project optionally filtered.
java.lang.Double	getTotalEstimate(PrimaryWorkitemFilter filter, boolean includeChildProjects) Retrieves the total estimate for all stories and defects in this project optionally filtered.
java.lang.Double	getTotalToDo(WorkitemFilter filter) Retrieves the total to do for all workitems in this project optionally filtered.
java.lang.Double	getTotalToDo(WorkitemFilter filter, boolean includeChildProjects) Retrieves the total to do for all workitems in this project optionally filtered.
void	setBeginDate(DateTime beginDate)
void	setEndDate(DateTime value)
void	setOwner(Member owner)
void	setParentProject(Project parentProject)
void	setSchedule(Schedule schedule)
void	setTestSuite(TestSuite testSuite)

Methods inherited from class com.versionone.om.BaseAsset

canClose, canDelete, canReactivate, close, createAttachment, createAttachment, createConversation, createConversation, createLink, createLink, createNote, createNote, delete, getAttachments, getCustomDropdown, getCustomField, getDescription, getLinks, getName, getNotes, getReferencedInExpressions, getURL, isActive, isClosed, reactivate, setDescription, setName

Methods inherited from class com.versionone.om.Entity

equals, get, getChangeComment, getChangeDate, getChangedBy, getCreateComment, getCreateDate, getCreatedBy, getID, getInstance, hashCode, save, save, toString

Methods inherited from class java.lang.Object

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

Method Detail

getParentProject

public Project getParentProject()

Returns:

Parent project this project belongs to.

setParentProject

public void setParentProject(Project parentProject)

Parameters:

parentProject - Parent project this project belongs to.

getBeginDate

public DateTime getBeginDate()

Returns:

Date this project begins.

setBeginDate

public void setBeginDate(DateTime beginDate)

Parameters:

beginDate - Date this project begins.

getEndDate

public DateTime getEndDate()

Returns:

Date this project ends.

setEndDate

public void setEndDate(DateTime value)

Parameters:

value - Date this project ends.

getSchedule

public Schedule getSchedule()

Returns:

Schedule that defines how this project's iterations are spaced.

setSchedule

public void setSchedule(Schedule schedule)

Parameters:

schedule - Schedule that defines how this project's iterations are spaced.

getOwner

public Member getOwner()

Returns:

The Member who owns this Project.

setOwner

public void setOwner(Member owner)

Parameters:

owner - The Member who owns this Project.

getTestSuite

public TestSuite getTestSuite()

Returns:

TestSuite assigned to this Project.

setTestSuite

public void setTestSuite(TestSuite testSuite)

Parameters:

testSuite - TestSuite assigned to this Project.

getStatus

public IListValueProperty getStatus()

Returns:

This Project's Status.

getBuildProjects

public java.util.Collection<BuildProject> getBuildProjects()

Returns:

Build Projects associated with this Project.

createSubProject

public Project createSubProject(java.lang.String name,
                                DateTime beginDate,
                                Schedule schedule)

Create a sub project under this project with a name, begin date, and optional schedule.

Parameters:

name - Name of the new project.

beginDate - Date the schedule will begin.

schedule - The new schedule. If null, the project will inherit the parent project's schedule.

Returns:

The newly created project.

createSubProject

public Project createSubProject(java.lang.String name,
                                DateTime beginDate,
                                Schedule schedule,
                                java.util.Map<java.lang.String,java.lang.Object> attributes)

createSubProject

public Project createSubProject(java.lang.String name,
                                DateTime beginDate)

Create a sub project under this project with a name and begin date.

Parameters:

name - Name of the new project.

beginDate - Date the schedule will begin.

Returns:

The newly created project.

createEpic

public Epic createEpic(java.lang.String name)

Create a new Epic in this Project.

Parameters:

name - The initial name of the Epic.

Returns:

A new Epic.

createEpic

public Epic createEpic(java.lang.String name,
                       java.util.Map<java.lang.String,java.lang.Object> attributes)

Create a new Epic in this Project.

Parameters:

name - The initial name of the Epic.

attributes - additional attributes for the Epic.

Returns:

A new Epic.

createStory

public Story createStory(java.lang.String name)

Create a new Story in this Project.

Parameters:

name - The initial name of the Story.

Returns:

A new Story.

createStory

public Story createStory(java.lang.String name,
                         java.util.Map<java.lang.String,java.lang.Object> attributes)

createDefect

public Defect createDefect(java.lang.String name)

Create a new Defect in this Project.

Parameters:

name - The initial name of the Defect.

Returns:

A new Defect.

createDefect

public Defect createDefect(java.lang.String name,
                           java.util.Map<java.lang.String,java.lang.Object> attributes)

Create a new Defect in this Project.

Parameters:

name - The initial name of the Defect.

attributes - additional attributes for defect

Returns:

A new Defect.

createTheme

public Theme createTheme(java.lang.String name)

Create a new Theme in this Project.

Parameters:

name - The initial name of the Theme.

Returns:

A new Theme.

createTheme

public Theme createTheme(java.lang.String name,
                         java.util.Map<java.lang.String,java.lang.Object> attributes)

Create a new Theme in this Project.

Parameters:

name - The initial name of the Theme.

attributes - additional attributes for Theme.

Returns:

A new Theme.

createGoal

public Goal createGoal(java.lang.String name)

Create a new Goal in this Project.

Parameters:

name - The initial name of the Goal.

Returns:

A new Goal.

createGoal

public Goal createGoal(java.lang.String name,
                       java.util.Map<java.lang.String,java.lang.Object> attributes)

Create a new Goal in this Project.

Parameters:

name - The initial name of the Goal.

attributes - additional attributes for the Goal.

Returns:

A new Goal.

createRequest

public Request createRequest(java.lang.String name)

Create a new Request in this Project.

Parameters:

name - The initial name of the Request.

Returns:

A new Request.

createRequest

public Request createRequest(java.lang.String name,
                             java.util.Map<java.lang.String,java.lang.Object> attributes)

Create a new Request in this Project.

Parameters:

name - The initial name of the Request.

attributes - additional attributes for the Request.

Returns:

A new Request.

createIssue

public Issue createIssue(java.lang.String name)

Create a new Issue in this Project.

Parameters:

name - The initial name of the Issue.

Returns:

A new Issue.

createIssue

public Issue createIssue(java.lang.String name,
                         java.util.Map<java.lang.String,java.lang.Object> attributes)

Create a new Issue in this Project.

Parameters:

name - The initial name of the Issue.

attributes - additional attributes for the Issue.

Returns:

A new Issue.

createRetrospective

public Retrospective createRetrospective(java.lang.String name)

Create a new Retrospective in this Project.

Parameters:

name - The initial name of the Retrospective.

Returns:

A new Retrospective.

createRetrospective

public Retrospective createRetrospective(java.lang.String name,
                                         java.util.Map<java.lang.String,java.lang.Object> attributes)

Create a new Retrospective in this Project.

Parameters:

name - The initial name of the Retrospective.

attributes - additional attributes for Retrospective.

Returns:

A new Retrospective.

createIteration

public Iteration createIteration()

Create a new Iteration in the Project where the schedule is defined. Use the suggested system values for the new iteration.

Returns:

A new Iteration.

createIteration

public Iteration createIteration(java.util.Map<java.lang.String,java.lang.Object> attributes)

Create a new Iteration in the Project where the schedule is defined. Use the suggested system values for the new iteration.

Parameters:

attributes - additional attributes for the Iteration.

Returns:

A new Iteration.

createIteration

public Iteration createIteration(java.lang.String name,
                                 DateTime beginDate,
                                 DateTime endDate)

Create a new Iteration in the Project where the schedule is defined.

Parameters:

name - The initial name of the Iteration.

beginDate - The begin date of the Iteration.

endDate - The end date of the Iteration.

Returns:

A new Iteration.

createIteration

public Iteration createIteration(java.lang.String name,
                                 DateTime beginDate,
                                 DateTime endDate,
                                 java.util.Map<java.lang.String,java.lang.Object> attributes)

Create a new Iteration in the Project where the schedule is defined.

Parameters:

name - The initial name of the Iteration.

beginDate - The begin date of the Iteration.

endDate - The end date of the Iteration.

attributes - additional attributes for Iteration.

Returns:

A new Iteration.

createRegressionPlan

public RegressionPlan createRegressionPlan(java.lang.String name)

Creates a new Regression Plan in the Project with additional attributes.

Parameters:

name - Regression Plan title.

Returns:

A new Regression Plan

createRegressionPlan

public RegressionPlan createRegressionPlan(java.lang.String name,
                                           java.util.Map<java.lang.String,java.lang.Object> attributes)

Creates a new Regression Plan in the Project with additional attributes.

Parameters:

name - Regression Plan title.

attributes - Additional attributes for initialization Regression Plan

Returns:

A new Regression Plan

createTestSet

public TestSet createTestSet(java.lang.String name,
                             RegressionSuite suite,
                             java.util.Map<java.lang.String,java.lang.Object> attributes)

Create a new Test Set in the project.

Parameters:

name - Test Set name

suite - Parent Regression suite

attributes - Additional attributes

Returns:

Newly created test set

createTestSet

public TestSet createTestSet(java.lang.String name,
                             RegressionSuite suite)

Create a new Test Set in the project.

Parameters:

name - Test Set name

suite - Parent Regression suite

Returns:

Newly created test set

createEnvironment

public Environment createEnvironment(java.lang.String name)

Creates a new Environment in the Project.

Parameters:

name - Environment title.

Returns:

A new Environment.

createEnvironment

public Environment createEnvironment(java.lang.String name,
                                     java.util.Map<java.lang.String,java.lang.Object> attributes)

Creates a new Environment in the Project with additional attributes.

Parameters:

name - Environment title.

attributes - Additional attributes for initialization Environment.

Returns:

A new Environment.

createRegressionTest

public RegressionTest createRegressionTest(java.lang.String name)

Creates a new Regression Test in the Project.

Parameters:

name - Name of Regression Test.

Returns:

A new Regression Test.

createRegressionTest

public RegressionTest createRegressionTest(java.lang.String name,
                                           java.util.Map<java.lang.String,java.lang.Object> attributes)

Creates a new Regression Test in the Project.

Parameters:

name - Name of Regression Test.

attributes - Additional attributes for initialization RegressionTest.

Returns:

A new Regression Test.

getAssignedMembers

public java.util.Collection<Member> getAssignedMembers()

Returns:

Members assigned to this project.

getStoryTemplates

public java.util.Collection<StoryTemplate> getStoryTemplates()

Returns:

A read-only collection of StoryTemplates in this Project.

getDefectTemplates

public java.util.Collection<DefectTemplate> getDefectTemplates()

Returns:

A read-only collection of DefectTemplates in the Project.

getThisAndAllChildProjects

public java.util.Collection<Project> getThisAndAllChildProjects()

Returns a flattened collection of this project and all Projects that descend from this project.

Returns:

read-only collection.

getChildProjects

public java.util.Collection<Project> getChildProjects(ProjectFilter filter)

A collection of sub-projects that belong to this project.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all child projects in the project are returned.

Returns:

A collection projects that belong to this project filtered by the passed in filter.

getChildProjects

public java.util.Collection<Project> getChildProjects(ProjectFilter filter,
                                                      boolean includeSubprojects)

A collection of sub-projects that belong to this project.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all child projects in the project are returned.

includeSubprojects - Specifies whether to include items from sub-project or not. This only adds open subprojects.

Returns:

A collection projects that belong to this project filtered by the passed in filter.

getEffortRecords

public java.util.Collection<Effort> getEffortRecords(EffortFilter filter)

A collection of Effort records that belong to this project.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all effort records in the project are returned.

Returns:

A collection efforts that belong to this project filtered by the passed in filter.

getEffortRecords

public java.util.Collection<Effort> getEffortRecords(EffortFilter filter,
                                                     boolean includeSubprojects)

A collection of Effort records that belong to this project.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all effort records in the project are returned.

includeSubprojects - Specifies whether to include items from sub project or not. This only adds open subprojects.

Returns:

A collection efforts that belong to this project filtered by the passed in filter.

getEpics

public java.util.Collection<Epic> getEpics(EpicFilter filter)

Get Epics in this Project filtered as specified in the passed in filter. Does not include subprojects.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all epics in the project are returned.

Returns:

A read only Collection of Epic.

getEpics

public java.util.Collection<Epic> getEpics(EpicFilter filter,
                                           boolean includeSubprojects)

Get Epics in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all epics in the project are returned.

includeSubprojects - Specifies whether to include items from sub project or not. This only adds open subprojects.

Returns:

A read only Collection of Epic.

getStories

public java.util.Collection<Story> getStories(StoryFilter filter)

Get stories in this Project filtered as specified in the passed in filter. Does not include subprojects.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all stories in the project are returned.

Returns:

An Collection of Story.

getStories

public java.util.Collection<Story> getStories(StoryFilter filter,
                                              boolean includeSubprojects)

Get stories in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all stories in the project are returned.

includeSubprojects - Specifies whether to include items from sub project or not. This only adds open subprojects.

Returns:

An Collection of Story.

getDefects

public java.util.Collection<Defect> getDefects(DefectFilter filter)

filter Get Defects in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all defects in the project are returned.

Returns:

An Collection of Defect.

getDefects

public java.util.Collection<Defect> getDefects(DefectFilter filter,
                                               boolean includeSubprojects)

Get Defects in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all defects in the project are returned.

includeSubprojects - Specifies whether to include items from sub project or not. This only adds open subprojects.

Returns:

An Collection of Defect.

getTestSets

public java.util.Collection<TestSet> getTestSets(TestSetFilter filter)

Get test sets in this Project filtered as specified in the passed in filter. Does not include subprojects.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all test sets in the project are returned.

getTestSets

public java.util.Collection<TestSet> getTestSets(TestSetFilter filter,
                                                 boolean includeSubprojects)

Get test sets in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all test sets in the project are returned.

includeSubprojects - Specifies whether to include items from sub project or not. This only adds open subprojects.

Returns:

Collection of Test Sets

getPrimaryWorkitems

public java.util.Collection<PrimaryWorkitem> getPrimaryWorkitems(PrimaryWorkitemFilter filter)

Get PrimaryWorkitems in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all stories and defects in the project are returned.

Returns:

An Collection of PrimaryWorkitem.

getPrimaryWorkitems

public java.util.Collection<PrimaryWorkitem> getPrimaryWorkitems(PrimaryWorkitemFilter filter,
                                                                 boolean includeSubprojects)

Get PrimaryWorkitems in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all stories and defects in the project are returned.

includeSubprojects - Specifies whether to include items from sub project or not. This only adds open subprojects.

Returns:

An Collection of PrimaryWorkitem.

getIterations

public java.util.Collection<Iteration> getIterations(IterationFilter filter)

Get Iterations in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all iterations in the project are returned.

Returns:

A read only Collection of Iteration.

getIterations

public java.util.Collection<Iteration> getIterations(IterationFilter filter,
                                                     boolean includeSubprojects)

Get Iterations in this Project's schedule filtered as specified in the passed in filter. This returns iterations even if the schedule is defined in a parent project.

Parameters:

filter - Criteria to filter on. Schedule will be set automatically. If null, all iterations in the project are returned.

includeSubprojects - Specifies whether to include items from sub project or not. This only adds open subprojects.

Returns:

A read only Collection of Iteration.

getThemes

public java.util.Collection<Theme> getThemes(ThemeFilter filter)

Get Themes in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all themes in the project are returned.

Returns:

A read only Collection of Theme.

getThemes

public java.util.Collection<Theme> getThemes(ThemeFilter filter,
                                             boolean includeSubprojects)

Get Themes in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all themes in the project are returned.

includeSubprojects - Specifies whether to include items from sub project or not. This only adds open subprojects.

Returns:

A read only Collection of Theme.

getSecondaryWorkitems

public java.util.Collection<SecondaryWorkitem> getSecondaryWorkitems(SecondaryWorkitemFilter filter)

Get SecondaryWorkitems in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all tasks and tests in the project are returned.

Returns:

An Collection of SecondaryWorkitem.

getSecondaryWorkitems

public java.util.Collection<SecondaryWorkitem> getSecondaryWorkitems(SecondaryWorkitemFilter filter,
                                                                     boolean includeSubprojects)

Get SecondaryWorkitems in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all tasks and tests in the project are returned.

includeSubprojects - Specifies whether to include items from sub project or not. This only adds open subprojects.

Returns:

An Collection of SecondaryWorkitem.

getTasks

public java.util.Collection<Task> getTasks(TaskFilter filter)

Get Tasks in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all tasks in the project are returned.

Returns:

An Collection of SecondaryWorkitem.

getTests

public java.util.Collection<Test> getTests(TestFilter filter)

Get Tests in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all tests in the project are returned.

Returns:

An Collection of Tests.

getRequests

public java.util.Collection<Request> getRequests(RequestFilter filter)

Get Requests in this Project filtered as specified in the passed in filter. Does not include subprojects.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all Requests in the project are returned.

Returns:

An Collection of Requests.

getRequests

public java.util.Collection<Request> getRequests(RequestFilter filter,
                                                 boolean includeSubprojects)

Get Requests in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all Requests in the project are returned.

includeSubprojects - Specifies whether to include items from sub project or not. This only adds open sub projects.

Returns:

A read only Collection of Request.

getGoals

public java.util.Collection<Goal> getGoals(GoalFilter filter)

Get Goals in this Project filtered as specified in the passed in filter. Does not include subprojects.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all Goals in the project are returned.

Returns:

An Collection of Goals.

getGoals

public java.util.Collection<Goal> getGoals(GoalFilter filter,
                                           boolean includeSubprojects)

Get Goals in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all Goals in the project are returned.

includeSubprojects - Specifies whether to include items from sub project or not. This only adds open sub projects.

Returns:

An Collection of Goals.

getRetrospectives

public java.util.Collection<Retrospective> getRetrospectives(RetrospectiveFilter filter)

Get Retrospective in this Project filtered as specified in the passed in filter. Does not include sub projects.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all Retrospective in the project are returned.

Returns:

A read only Collection of Retrospective.

getRetrospectives

public java.util.Collection<Retrospective> getRetrospectives(RetrospectiveFilter filter,
                                                             boolean includeSubprojects)

Get Retrospective in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all Retrospective in the project are returned.

includeSubprojects - Specifies whether to include items from sub project or not. This only adds open sub projects.

Returns:

A read only Collection of Retrospective.

getIssues

public java.util.Collection<Issue> getIssues(IssueFilter filter)

Get Issues in this Project filtered as specified in the passed in filter. Does not include subprojects.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all Issues in the project are returned.

Returns:

A read only Collection of Issues.

getIssues

public java.util.Collection<Issue> getIssues(IssueFilter filter,
                                             boolean includeSubprojects)

Get Issues in this Project filtered as specified in the passed in filter.

Parameters:

filter - Criteria to filter on. Project will be set automatically. If null, all Issues in the project are returned.

includeSubprojects - Specifies whether to include items from sub project or not. This only adds open sub projects.

Returns:

A read only Collection of Issues.

getRegressionPlans

public java.util.Collection<RegressionPlan> getRegressionPlans(RegressionPlanFilter filter,
                                                               boolean includeSubprojects)

A collection of regression plans that belong to this project.

Parameters:

filter - Criteria to filter on. Project(s) will be set automatically. If null, all related regression items in the project are returned.

includeSubprojects - Specifies whether to include items from sub-project or not. This only adds open subprojects.

Returns:

RegressionPlan.

getRegressionPlans

public java.util.Collection<RegressionPlan> getRegressionPlans(RegressionPlanFilter filter)

A collection of regression plans that belong to this project.

Parameters:

filter - Criteria to filter on. Project(s) will be set automatically. If null, all related regression items in the project are returned.

Returns:

RegressionPlan.

getTotalEstimate

public java.lang.Double getTotalEstimate(PrimaryWorkitemFilter filter,
                                         boolean includeChildProjects)

Retrieves the total estimate for all stories and defects in this project optionally filtered.

Parameters:

filter - Criteria to filter stories and defects on.

includeChildProjects - If true, include open sub projects, otherwise only include this project.

Returns:

total estimate of selected Workitems.

getTotalEstimate

public java.lang.Double getTotalEstimate(PrimaryWorkitemFilter filter)

Retrieves the total estimate for all stories and defects in this project optionally filtered.

Parameters:

filter - Criteria to filter stories and defects on.

Returns:

total estimate of selected Workitems.

getTotalDetailEstimate

public java.lang.Double getTotalDetailEstimate(WorkitemFilter filter,
                                               boolean includeChildProjects)

Count the total detail estimate for all workitems in this project optionally filtered.

Parameters:

filter - Criteria to filter workitems on.

includeChildProjects - If true, include open sub projects, otherwise only include this project.

Returns:

total detail estimate for all workitems in this project optionally filtered.

getTotalDetailEstimate

public java.lang.Double getTotalDetailEstimate(WorkitemFilter filter)

Count the total detail estimate for all workitems in this project optionally filtered.

Parameters:

filter - Criteria to filter workitems on.

Returns:

total detail estimate for all workitems in this project optionally filtered.

getTotalToDo

public java.lang.Double getTotalToDo(WorkitemFilter filter,
                                     boolean includeChildProjects)

Retrieves the total to do for all workitems in this project optionally filtered.

Parameters:

filter - Criteria to filter workitems on.

includeChildProjects - If true, include open sub projects, otherwise only include this project.

Returns:

total to do of selected Workitems.

getTotalToDo

public java.lang.Double getTotalToDo(WorkitemFilter filter)

Retrieves the total to do for all workitems in this project optionally filtered.

Parameters:

filter - Criteria to filter workitems on.

Returns:

total to do for selected workitems.

getTotalDone

public java.lang.Double getTotalDone(WorkitemFilter filter,
                                     boolean includeChildProjects)

Retrieves the total done for all workitems in this project optionally filtered.

Parameters:

filter - Criteria to filter workitems on.

includeChildProjects - If true, include open sub projects, otherwise only include this project.

Returns:

total done for selected workitems.

getTotalDone

public java.lang.Double getTotalDone(WorkitemFilter filter)

Retrieves the total done for all workitems in this project optionally filtered.

Parameters:

filter - Criteria to filter workitems on.

Returns:

total done for selected workitems.