com.versionone.om
Class V1InstanceGetter

java.lang.Object
  com.versionone.om.V1InstanceGetter

public class V1InstanceGetter
extends java.lang.Object

Methods to get things

Method Summary

Attachment	attachmentByID(AssetID id) Returns an Attachment with the given ID or null if the ID is invalid.
Attachment	attachmentByID(java.lang.String sId) Returns an Attachment with the given ID or null if the ID is invalid.
java.util.Collection<Attachment>	attachments(AttachmentFilter filter) Get attachments filtered by the criteria specified in the passed in filter.
BaseAsset	baseAssetByID(AssetID id) Returns a BaseAsset with the given ID or null if the ID is invalid.
BaseAsset	baseAssetByID(java.lang.String sId) Returns a BaseAsset with the given ID or null if the ID is invalid.
java.util.Collection<BaseAsset>	baseAssets(BaseAssetFilter filter) Get assets filtered by the criteria specified in the passed in filter.
BuildProject	buildProjectByID(AssetID id) Returns a Build Project with the given ID or null if the ID is invalid.
BuildProject	buildProjectByID(java.lang.String sId) Returns a Build Project with the given ID or null if the ID is invalid.
java.util.Collection<BuildProject>	buildProjects(BuildProjectFilter filter) Get Build Projects filtered by the criteria specified in the passed in filter.
BuildRun	buildRunByID(AssetID id) Returns a Build Run with the given ID or null if the ID is invalid.
BuildRun	buildRunByID(java.lang.String sId) Returns a Build Run with the given ID or null if the ID is invalid.
java.util.Collection<BuildRun>	buildRuns(BuildRunFilter filter) Get Build Runs filtered by the criteria specified in the passed in filter.
<T extends ProjectAsset> T	byDisplayID(java.lang.Class<T> clazz, java.lang.String displayID) Returns an Entity of Type T with the given ID or null if the ID is invalid.
<T extends Entity> T	byID(java.lang.Class<T> clazz, AssetID id) Returns an Entity of Type T with the given ID or null if the ID is invalid.
ChangeSet	changeSetByID(AssetID id) Returns a ChangeSet with the given ID or null if the ID is invalid.
ChangeSet	changeSetByID(java.lang.String sId) Returns a ChangeSet with the given ID or null if the ID is invalid.
java.util.Collection<ChangeSet>	changeSets(ChangeSetFilter filter) Get ChangeSets filtered by the criteria specified in the passed in filter.
Conversation	conversationByID(AssetID id) Returns a Conversation with the given ID or null if the ID is invalid.
java.util.Collection<Conversation>	conversations(ConversationFilter filter) Get Conversation/Expression filtered by the criteria specified in the passed filter.
Defect	defectByDisplayID(java.lang.String displayID) Returns a Defect with the given ID or null if the ID is invalid.
Defect	defectByID(AssetID id) Returns a Defect with the given ID or null if the ID is invalid.
Defect	defectByID(java.lang.String sId) Returns a Defect with the given ID or null if the ID is invalid.
java.util.Collection<Defect>	defects(DefectFilter filter) Get defects filtered by the criteria specified in the passed in filter.
DefectTemplate	defectTemplateByID(AssetID id) Returns a DefectTemplate with the given ID or null if the ID is invalid.
DefectTemplate	defectTemplateByID(java.lang.String sId) Returns a DefectTemplate with the given ID or null if the ID is invalid.
Effort	effortByID(AssetID id) Returns an Effort record with the given ID or null if the ID is invalid.
Effort	effortByID(java.lang.String assetId) Returns an Effort record with the given ID or null if the ID is invalid.
java.util.Collection<Effort>	effortRecords(EffortFilter filter) Get effort records filtered by the criteria specified in the passed in filter.
Environment	environmentByID(AssetID id) Returns a Environment with the given ID or null if the ID is invalid.
java.util.Collection<Environment>	environments(EnvironmentFilter filter) Get Environment filtered by the criteria specified in the passed in filter.
Epic	epicByDisplayID(java.lang.String displayID) Returns a Epic with the given ID or null if the ID is invalid.
Epic	epicByID(AssetID id) Returns a Epic with the given ID or null if the ID is invalid.
Epic	epicByID(java.lang.String sId) Returns a Epic with the given ID or null if the ID is invalid.
java.util.Collection<Epic>	epics(EpicFilter filter) Get Epics filtered by the criteria specified in the passed in filter.
Goal	goalByDisplayID(java.lang.String displayID) Returns a Goal with the given ID or null if the ID is invalid.
Goal	goalByID(AssetID id) Returns a Goal with the given ID or null if the ID is invalid.
Goal	goalByID(java.lang.String sId) Returns a Goal with the given ID or null if the ID is invalid.
java.util.Collection<Goal>	goals(GoalFilter filter) Get Goals filtered by the criteria specified in the passed in filter.
Issue	issueByDisplayID(java.lang.String displayID) Returns an Issue with the given ID or null if the ID is invalid.
Issue	issueByID(AssetID id) Returns an Issue with the given ID or null if the ID is invalid.
java.util.Collection<Issue>	issues(IssueFilter filter) Get Issues filtered by the criteria specified in the passed in filter.
Iteration	iterationByID(AssetID id) Returns an iteration with the given ID or null if the ID is invalid.
Iteration	iterationByID(java.lang.String sId) Returns an iteration with the given ID or null if the ID is invalid.
java.util.Collection<Iteration>	iterations(IterationFilter filter) Get iterations filtered by the criteria specified in the passed in filter.
Link	linkByID(AssetID id) Returns a Link with the given ID or null if the ID is invalid.
Link	linkByID(java.lang.String sId) Returns a Link with the given ID or null if the ID is invalid.
java.util.Collection<Link>	links(LinkFilter filter) Get links filtered by the criteria specified in the passed in filter.
<T extends ListValue> java.util.Collection<T>	listTypeValues(java.lang.Class<T> valuesClass) Gets the active values of a standard list type.
Member	memberByID(AssetID id) Returns a Member with the given ID or null if the ID is invalid.
Member	memberByID(java.lang.String sId) Returns a Member with the given ID or null if the ID is invalid.
Member	memberByUserName(java.lang.String userName) Retrieves the first Member with the given user name.
java.util.Collection<Member>	members(MemberFilter filter) Get Members filtered by the criteria specified in the passed in filter.
java.util.Collection<Message>	messages(MessageFilter filter) Get Messages filtered by the criteria specified in the passed in filter.
Note	noteByID(AssetID id) Returns a Note with the given ID or null if the ID is invalid.
Note	noteByID(java.lang.String sId) Returns a Note with the given ID or null if the ID is invalid.
java.util.Collection<Note>	notes(NoteFilter filter) Get notes filtered by the criteria specified in the passed in filter.
PrimaryWorkitem	primaryWorkitemByDisplayID(java.lang.String displayID) Returns a Primary Workitem with the given ID or null if the ID is invalid.
PrimaryWorkitem	primaryWorkitemByID(AssetID id) Returns a Primary Workitem with the given ID or null if the ID is invalid.
PrimaryWorkitem	primaryWorkitemByID(java.lang.String sId) Returns a Primary Workitem with the given ID or null if the ID is invalid.
java.util.Collection<PrimaryWorkitem>	primaryWorkitems(PrimaryWorkitemFilter filter) Get primary workitems (stories and defects) filtered by the criteria specified in the passed in filter.
Project	projectByID(AssetID id) id Returns a project with the given ID or null if the ID is invalid.
Project	projectByID(java.lang.String sId) id Returns a project with the given ID or null if the ID is invalid.
Project	projectByName(java.lang.String name) Retrieves the first project with the given name or null.
java.util.Collection<Project>	projects(ProjectFilter filter) Get projects filtered by the criteria specified in the passed in filter.
RegressionPlan	regressionPlanByDisplayID(java.lang.String displayID) Returns a RegressionPlan with the given ID or null if the ID is invalid
RegressionPlan	regressionPlanByID(AssetID id) Returns a RegressionPlan with the given ID or null if the ID is invalid.
java.util.Collection<RegressionPlan>	regressionPlans(RegressionPlanFilter filter) Gets regression plans filtered by the criteria specified in the passed in filter.
RegressionSuite	regressionSuiteByID(AssetID id) Returns a Regression Suite with the given ID or null if the ID is invalid.
java.util.Collection<RegressionSuite>	regressionSuites(RegressionSuiteFilter filter) Get Regression Suite filtered by the criteria specified in the passed in filter.
RegressionTest	regressionTestByID(AssetID id) Returns a Regression Test with the given ID or null if the ID is invalid.
java.util.Collection<RegressionTest>	regressionTests(RegressionTestFilter filter) Get Regression Suite filtered by the criteria specified in the passed in filter.
Request	requestByDisplayID(java.lang.String displayID) Returns a Request with the given ID or null if the ID is invalid.
Request	requestByID(AssetID id) Returns a Request with the given ID or null if the ID is invalid.
java.util.Collection<Request>	requests(RequestFilter filter) Get Requests filtered by the criteria specified in the passed in filter.
Retrospective	retrospectiveByID(AssetID id) Returns a retrospective with the given ID or null if the ID is invalid.
Retrospective	retrospectiveByID(java.lang.String sId) Returns a retrospective with the given ID or null if the ID is invalid.
java.util.Collection<Retrospective>	retrospectives(RetrospectiveFilter filter) Get Retrospective filtered by the criteria specified in the passed in filter.
Schedule	scheduleByID(AssetID id) Returns a schedule with the given ID or null if the ID is invalid
Schedule	scheduleByName(java.lang.String name) Retrieves the first schedule with the given name or null
java.util.Collection<Schedule>	schedules(ScheduleFilter filter) Get schedules filtered by the criteria specified in the passed in filter.
SecondaryWorkitem	secondaryWorkitemByDisplayID(java.lang.String displayID) Returns a Secondary Workitem with the given ID or null if the ID is invalid.
SecondaryWorkitem	secondaryWorkitemByID(AssetID id) Returns a Secondary Workitem with the given ID or null if the ID is invalid.
SecondaryWorkitem	secondaryWorkitemByID(java.lang.String sId) Returns a Secondary Workitem with the given ID or null if the ID is invalid.
java.util.Collection<SecondaryWorkitem>	secondaryWorkitems(SecondaryWorkitemFilter filter) Get secondary workitems (tasks and tests) filtered by the criteria specified in the passed in filter.
java.util.Collection<Story>	story(StoryFilter filter) Get stories filtered by the criteria specified in the passed in filter.
Story	storyByDisplayID(java.lang.String displayID) Returns a Story with the given ID or null if the ID is invalid.
Story	storyByID(AssetID id) Returns a Story with the given ID or null if the ID is invalid.
Story	storyByID(java.lang.String sId) Returns a Story with the given ID or null if the ID is invalid.
StoryTemplate	storyTemplateByID(AssetID id) Returns a StoryTemplate with the given ID or null if the ID is invalid.
StoryTemplate	storyTemplateByID(java.lang.String sId) Returns a StoryTemplate with the given ID or null if the ID is invalid.
java.util.Collection<Task>	tasks(TaskFilter filter) Get tasks filtered by the criteria specified in the passed in filter.
Team	teamByID(AssetID id) Returns a Team with the given ID or null if the ID is invalid.
Team	teamByID(java.lang.String sId) Returns a Team with the given ID or null if the ID is invalid.
java.util.Collection<Team>	teams(TeamFilter filter) Get teams filtered by the criteria specified in the passed in filter.
java.util.Collection<Test>	tests(TestFilter filter) Get Tests filtered by the criteria specified in the passed in filter.
TestSet	testSetByDisplayID(java.lang.String displayID) Returns a TestSet with the given ID or null if the ID is invalid.
TestSet	testSetByID(AssetID id) Returns a Test Set with the given ID or null if the ID is invalid.
java.util.Collection<TestSet>	testSets(TestSetFilter filter) Get Test Sets filtered by the criteria specified in the passed in filter.
TestSuite	testSuiteByID(AssetID id) Returns a TestSuite with the given ID or null if the ID is invalid.
TestSuite	testSuiteByID(java.lang.String sId) Returns a TestSuite with the given ID or null if the ID is invalid.
Theme	themeByDisplayID(java.lang.String displayID) Returns a Theme with the given ID or null if the ID is invalid.
Theme	themeByID(AssetID id) Returns a Theme with the given ID or null if the ID is invalid.
Theme	themeByID(java.lang.String sId) Returns a Theme with the given ID or null if the ID is invalid.
java.util.Collection<Theme>	themes(ThemeFilter filter) Get themes filtered by the criteria specified in the passed in filter.
Workitem	workitemByDisplayID(java.lang.String displayID) Returns a Workitem with the given ID or null if the ID is invalid.
Workitem	workitemByID(AssetID id) Returns a Workitem with the given ID or null if the ID is invalid.
Workitem	workitemByID(java.lang.String sId) Returns a Workitem with the given ID or null if the ID is invalid.
java.util.Collection<Workitem>	workitems(WorkitemFilter filter) Get workitems (stories, defects, tasks, and tests) filtered by the criteria specified in the passed in filter.

Methods inherited from class java.lang.Object

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

Method Detail

attachments

public java.util.Collection<Attachment> attachments(AttachmentFilter filter)

Get attachments filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

notes

public java.util.Collection<Note> notes(NoteFilter filter)

Get notes filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

links

public java.util.Collection<Link> links(LinkFilter filter)

Get links filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

effortRecords

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

Get effort records filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

baseAssets

public java.util.Collection<BaseAsset> baseAssets(BaseAssetFilter filter)

Get assets filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

story

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

Get stories filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

epics

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

Get Epics filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

defects

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

Get defects filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

primaryWorkitems

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

Get primary workitems (stories and defects) filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

workitems

public java.util.Collection<Workitem> workitems(WorkitemFilter filter)

Get workitems (stories, defects, tasks, and tests) filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

secondaryWorkitems

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

Get secondary workitems (tasks and tests) filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

tasks

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

Get tasks filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

tests

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

Get Tests filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

iterations

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

Get iterations filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

projects

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

Get projects filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

teams

public java.util.Collection<Team> teams(TeamFilter filter)

Get teams filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

themes

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

Get themes filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

members

public java.util.Collection<Member> members(MemberFilter filter)

Get Members filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

requests

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

Get Requests filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

goals

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

Get Goals filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

issues

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

Get Issues filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

retrospectives

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

Get Retrospective filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

buildRuns

public java.util.Collection<BuildRun> buildRuns(BuildRunFilter filter)

Get Build Runs filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

buildProjects

public java.util.Collection<BuildProject> buildProjects(BuildProjectFilter filter)

Get Build Projects filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

changeSets

public java.util.Collection<ChangeSet> changeSets(ChangeSetFilter filter)

Get ChangeSets filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

schedules

public java.util.Collection<Schedule> schedules(ScheduleFilter filter)

Get schedules filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

ICollection of items as specified in the filter.

messages

public java.util.Collection<Message> messages(MessageFilter filter)

Get Messages filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

Collection of items as specified in the filter.

conversations

public java.util.Collection<Conversation> conversations(ConversationFilter filter)

Get Conversation/Expression filtered by the criteria specified in the passed filter.

Parameters:

filter - Limit the items returned. If null, then all items returned.

Returns:

ICollection of the items as specified in the filter.

regressionPlans

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

Gets regression plans filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items are returned.

Returns:

Collection of items as specified in the filter.

regressionSuites

public java.util.Collection<RegressionSuite> regressionSuites(RegressionSuiteFilter filter)

Get Regression Suite filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items are returned.

Returns:

Collection of items as specified in the filter.

testSets

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

Get Test Sets filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items are returned.

Returns:

Collection of items as specified in the filter.

environments

public java.util.Collection<Environment> environments(EnvironmentFilter filter)

Get Environment filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items are returned.

Returns:

Collection of items as specified in the filter.

regressionTests

public java.util.Collection<RegressionTest> regressionTests(RegressionTestFilter filter)

Get Regression Suite filtered by the criteria specified in the passed in filter.

Parameters:

filter - Limit the items returned. If null, then all items are returned.

Returns:

Collection of items as specified in the filter.

projectByID

public Project projectByID(AssetID id)

id Returns a project with the given ID or null if the ID is invalid.

Parameters:

id - id of the project to retrieve.

Returns:

an instance of a Project or null if ID is invalid.

projectByID

public Project projectByID(java.lang.String sId)

id Returns a project with the given ID or null if the ID is invalid.

Parameters:

sId - id of the project to retrieve (string have to be token for AssetId class).

Returns:

an instance of a Project or null if ID is invalid.

See Also:

AssetID.AssetID(String).

iterationByID

public Iteration iterationByID(AssetID id)

Returns an iteration with the given ID or null if the ID is invalid.

Parameters:

id - ID of the iteration to retrieve.

Returns:

an instance of an Iteration or null if ID is invalid.

iterationByID

public Iteration iterationByID(java.lang.String sId)

Returns an iteration with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the iteration to retrieve (string have to be token for AssetId class).

Returns:

an instance of an Iteration or null if ID is invalid

See Also:

AssetID.AssetID(String).

retrospectiveByID

public Retrospective retrospectiveByID(AssetID id)

Returns a retrospective with the given ID or null if the ID is invalid.

Parameters:

id - ID of the iteration to retrieve.

Returns:

an instance of a retrospective or null if ID is invalid.

retrospectiveByID

public Retrospective retrospectiveByID(java.lang.String sId)

Returns a retrospective with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the iteration to retrieve (string have to be token for AssetId class).

Returns:

an instance of a retrospective or null if ID is invalid.

memberByID

public Member memberByID(AssetID id)

Returns a Member with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Member to retrieve.

Returns:

an instance of a Member or null if ID is invalid.

memberByID

public Member memberByID(java.lang.String sId)

Returns a Member with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the Member to retrieve (string have to be token for AssetId class).

Returns:

an instance of a Member or null if ID is invalid

See Also:

AssetID.AssetID(String).

teamByID

public Team teamByID(AssetID id)

Returns a Team with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Team to retrieve.

Returns:

an instance of a Team or null if ID is invalid.

teamByID

public Team teamByID(java.lang.String sId)

Returns a Team with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the Team to retrieve (string have to be token for AssetId class).

Returns:

an instance of a Team or null if ID is invalid

See Also:

AssetID.AssetID(String).

storyByID

public Story storyByID(AssetID id)

Returns a Story with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Story to retrieve.

Returns:

an instance of a story or null if ID is invalid.

storyByID

public Story storyByID(java.lang.String sId)

Returns a Story with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the Story to retrieve (string have to be token for AssetId class).

Returns:

an instance of a story or null if ID is invalid

See Also:

AssetID.AssetID(String).

defectByID

public Defect defectByID(AssetID id)

Returns a Defect with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Defect to retrieve.

Returns:

an instance of a Defect or null if ID is invalid.

defectByID

public Defect defectByID(java.lang.String sId)

Returns a Defect with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the Defect to retrieve (string have to be token for AssetId class).

Returns:

an instance of a Defect or null if ID is invalid

See Also:

AssetID.AssetID(String).

issueByID

public Issue issueByID(AssetID id)

Returns an Issue with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Issue to retrieve.

Returns:

an instance of a Issue or null if ID is invalid.

requestByID

public Request requestByID(AssetID id)

Returns a Request with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Request to retrieve.

Returns:

an instance of a Request or null if ID is invalid.

themeByID

public Theme themeByID(AssetID id)

Returns a Theme with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Theme to retrieve.

Returns:

an instance of a Theme or null if ID is invalid.

themeByID

public Theme themeByID(java.lang.String sId)

Returns a Theme with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the Theme to retrieve(string have to be token for AssetId class).

Returns:

an instance of a Theme or null if ID is invalid.

goalByID

public Goal goalByID(AssetID id)

Returns a Goal with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Goal to retrieve.

Returns:

an instance of a Goal or null if ID is invalid.

goalByID

public Goal goalByID(java.lang.String sId)

Returns a Goal with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the Goal to retrieve.

Returns:

an instance of a Goal or null if ID is invalid.

epicByID

public Epic epicByID(AssetID id)

Returns a Epic with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Epic to retrieve(string have to be token for AssetId class).

Returns:

an instance of a Epic or null if ID is invalid.

epicByID

public Epic epicByID(java.lang.String sId)

Returns a Epic with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the Epic to retrieve(string have to be token for AssetId class).

Returns:

an instance of a Epic or null if ID is invalid.

storyTemplateByID

public StoryTemplate storyTemplateByID(AssetID id)

Returns a StoryTemplate with the given ID or null if the ID is invalid.

Parameters:

id - ID of the StoryTemplate to retrieve.

Returns:

an instance of a StoryTemplate or null if ID is invalid.

storyTemplateByID

public StoryTemplate storyTemplateByID(java.lang.String sId)

Returns a StoryTemplate with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the StoryTemplate to retrieve(string have to be token for AssetId class).

Returns:

an instance of a StoryTemplate or null if ID is invalid.

defectTemplateByID

public DefectTemplate defectTemplateByID(AssetID id)

Returns a DefectTemplate with the given ID or null if the ID is invalid.

Parameters:

id - ID of the DefectTemplate to retrieve.

Returns:

an instance of a DefectTemplate or null if ID is invalid.

defectTemplateByID

public DefectTemplate defectTemplateByID(java.lang.String sId)

Returns a DefectTemplate with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the DefectTemplate to retrieve(string have to be token for AssetId class).

Returns:

an instance of a DefectTemplate or null if ID is invalid.

noteByID

public Note noteByID(AssetID id)

Returns a Note with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Note to retrieve.

Returns:

an instance of a Note or null if ID is invalid.

noteByID

public Note noteByID(java.lang.String sId)

Returns a Note with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the Note to retrieve(string have to be token for AssetId class).

Returns:

an instance of a Note or null if ID is invalid.

See Also:

AssetID.AssetID(String).

linkByID

public Link linkByID(AssetID id)

Returns a Link with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Link to retrieve.

Returns:

an instance of a Link or null if ID is invalid.

linkByID

public Link linkByID(java.lang.String sId)

Returns a Link with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the Link to retrieve(string have to be token for AssetId class).

Returns:

an instance of a Link or null if ID is invalid.

See Also:

AssetID.AssetID(String).

attachmentByID

public Attachment attachmentByID(AssetID id)

Returns an Attachment with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Attachment to retrieve.

Returns:

an instance of an Attachment or null if ID is invalid.

attachmentByID

public Attachment attachmentByID(java.lang.String sId)

Returns an Attachment with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the Attachment to retrieve (string have to be token for AssetId class).

Returns:

an instance of an Attachment or null if ID is invalid.

testSuiteByID

public TestSuite testSuiteByID(AssetID id)

Returns a TestSuite with the given ID or null if the ID is invalid.

Parameters:

id - ID of the TestSuite to retrieve.

Returns:

an instance of a TestSuite or null if ID is invalid.

testSuiteByID

public TestSuite testSuiteByID(java.lang.String sId)

Returns a TestSuite with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the TestSuite to retrieve (string have to be token for AssetId class).

Returns:

an instance of a TestSuite or null if ID is invalid.

effortByID

public Effort effortByID(AssetID id)

Returns an Effort record with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Effort record to retrieve.

Returns:

an instance of an Effort record or null if ID is invalid.

effortByID

public Effort effortByID(java.lang.String assetId)

Returns an Effort record with the given ID or null if the ID is invalid.

Parameters:

assetId - ID of the Effort record to retrieve. (string have to be token for AssetId class).

Returns:

an instance of an Effort record or null if ID is invalid.

primaryWorkitemByID

public PrimaryWorkitem primaryWorkitemByID(AssetID id)

Returns a Primary Workitem with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Primary Workitem to retrieve.

Returns:

an instance of a Primary Workitem or null if ID is invalid.

primaryWorkitemByID

public PrimaryWorkitem primaryWorkitemByID(java.lang.String sId)

Returns a Primary Workitem with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the Primary Workitem to retrieve(string have to be token for AssetId class).

Returns:

an instance of a Primary Workitem or null if ID is invalid.

secondaryWorkitemByID

public SecondaryWorkitem secondaryWorkitemByID(AssetID id)

Returns a Secondary Workitem with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Secondary Workitem to retrieve.

Returns:

an instance of a Secondary Workitem or null if ID is invalid.

secondaryWorkitemByID

public SecondaryWorkitem secondaryWorkitemByID(java.lang.String sId)

Returns a Secondary Workitem with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the Secondary Workitem to retrieve(string have to be token for AssetId class).

Returns:

an instance of a Secondary Workitem or null if ID is invalid.

workitemByID

public Workitem workitemByID(AssetID id)

Returns a Workitem with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Workitem to retrieve.

Returns:

an instance of a Workitem or null if ID is invalid.

workitemByID

public Workitem workitemByID(java.lang.String sId)

Returns a Workitem with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the Workitem to retrieve(string have to be token for AssetId class).

Returns:

an instance of a Workitem or null if ID is invalid.

baseAssetByID

public BaseAsset baseAssetByID(AssetID id)

Returns a BaseAsset with the given ID or null if the ID is invalid.

Parameters:

id - ID of the BaseAsset to retrieve.

Returns:

an instance of a BaseAsset or null if ID is invalid.

baseAssetByID

public BaseAsset baseAssetByID(java.lang.String sId)

Returns a BaseAsset with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the BaseAsset to retrieve(string have to be token for AssetId class).

Returns:

an instance of a BaseAsset or null if ID is invalid

See Also:

AssetID.AssetID(String).

buildRunByID

public BuildRun buildRunByID(AssetID id)

Returns a Build Run with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Build Run to retrieve.

Returns:

an instance of a Build Run or null if ID is invalid.

buildRunByID

public BuildRun buildRunByID(java.lang.String sId)

Returns a Build Run with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the Build Run to retrieve(string have to be token for AssetId class).

Returns:

an instance of a Build Run or null if ID is invalid

See Also:

AssetID.AssetID(String).

buildProjectByID

public BuildProject buildProjectByID(AssetID id)

Returns a Build Project with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Build Project to retrieve.

Returns:

an instance of a Build Project or null if ID is invalid.

buildProjectByID

public BuildProject buildProjectByID(java.lang.String sId)

Returns a Build Project with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the Build Project to retrieve(string have to be token for AssetId class).

Returns:

an instance of a Build Project or null if ID is invalid.

See Also:

AssetID.AssetID(String).

changeSetByID

public ChangeSet changeSetByID(AssetID id)

Returns a ChangeSet with the given ID or null if the ID is invalid.

Parameters:

id - ID of the ChangeSet to retrieve.

Returns:

an instance of a ChangeSet or null if ID is invalid.

changeSetByID

public ChangeSet changeSetByID(java.lang.String sId)

Returns a ChangeSet with the given ID or null if the ID is invalid.

Parameters:

sId - ID of the ChangeSet to retrieve(string have to be token for AssetId class).

Returns:

an instance of a ChangeSet or null if ID is invalid.

See Also:

AssetID.AssetID(String).

conversationByID

public Conversation conversationByID(AssetID id)

Returns a Conversation with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Conversation to retrieve.

Returns:

an instance of an Conversation or null if ID is invalid.

byID

public <T extends Entity> T byID(java.lang.Class<T> clazz,
                                 AssetID id)

Returns an Entity of Type T with the given ID or null if the ID is invalid.

Type Parameters:

T - Entity Type to retrieve.

Parameters:

clazz - - T Class.

id - ID of the Entity to retrieve.

Returns:

an instance of an Entity of Type T or null if ID is invalid.

byDisplayID

public <T extends ProjectAsset> T byDisplayID(java.lang.Class<T> clazz,
                                              java.lang.String displayID)
                                   throws SDKException

Returns an Entity of Type T with the given ID or null if the ID is invalid.

Parameters:

clazz - Entity Type to retrieve.

displayID - DisplayID of the Entity to retrieve.

Returns:

an instance of an Entity of Type T or null if ID is invalid.

Throws:

SDKException - if there is a problem executing the query

storyByDisplayID

public Story storyByDisplayID(java.lang.String displayID)

Returns a Story with the given ID or null if the ID is invalid.

Parameters:

displayID - DisplayID of the Story to retrieve.

Returns:

an instance of a story or null if ID is invalid.

defectByDisplayID

public Defect defectByDisplayID(java.lang.String displayID)

Returns a Defect with the given ID or null if the ID is invalid.

Parameters:

displayID - DisplayID of the Defect to retrieve.

Returns:

an instance of a Defect or null if ID is invalid.

issueByDisplayID

public Issue issueByDisplayID(java.lang.String displayID)

Returns an Issue with the given ID or null if the ID is invalid.

Parameters:

displayID - DisplayID of the Issue to retrieve.

Returns:

an instance of a Issue or null if ID is invalid.

requestByDisplayID

public Request requestByDisplayID(java.lang.String displayID)

Returns a Request with the given ID or null if the ID is invalid.

Parameters:

displayID - DisplayID of the Request to retrieve.

Returns:

an instance of a Request or null if ID is invalid.

themeByDisplayID

public Theme themeByDisplayID(java.lang.String displayID)

Returns a Theme with the given ID or null if the ID is invalid.

Parameters:

displayID - DisplayID of the Theme to retrieve.

Returns:

an instance of a Theme or null if ID is invalid.

goalByDisplayID

public Goal goalByDisplayID(java.lang.String displayID)

Returns a Goal with the given ID or null if the ID is invalid.

Parameters:

displayID - DisplayID of the Goal to retrieve.

Returns:

an instance of a Goal or null if ID is invalid.

epicByDisplayID

public Epic epicByDisplayID(java.lang.String displayID)

Returns a Epic with the given ID or null if the ID is invalid.

Parameters:

displayID - DisplayID of the Epic to retrieve.

Returns:

an instance of a Epic or null if ID is invalid.

primaryWorkitemByDisplayID

public PrimaryWorkitem primaryWorkitemByDisplayID(java.lang.String displayID)

Returns a Primary Workitem with the given ID or null if the ID is invalid.

Parameters:

displayID - DisplayID of the Primary Workitem to retrieve.

Returns:

an instance of a Primary Workitem or null if ID is invalid.

secondaryWorkitemByDisplayID

public SecondaryWorkitem secondaryWorkitemByDisplayID(java.lang.String displayID)

Returns a Secondary Workitem with the given ID or null if the ID is invalid.

Parameters:

displayID - DisplayID of the Secondary Workitem to retrieve.

Returns:

an instance of a Secondary Workitem or null if ID is invalid.

workitemByDisplayID

public Workitem workitemByDisplayID(java.lang.String displayID)

Returns a Workitem with the given ID or null if the ID is invalid.

Parameters:

displayID - DisplayID of the Workitem to retrieve.

Returns:

an instance of a Workitem or null if ID is invalid.

regressionPlanByID

public RegressionPlan regressionPlanByID(AssetID id)

Returns a RegressionPlan with the given ID or null if the ID is invalid.

Parameters:

id - ID of the RegressionPlan to retrieve.

Returns:

an instance of a RegressionPlan or null if ID is invalid.

regressionPlanByDisplayID

public RegressionPlan regressionPlanByDisplayID(java.lang.String displayID)

Returns a RegressionPlan with the given ID or null if the ID is invalid

Parameters:

displayID - DisplayID of the RegressionPlan to retrieve

Returns:

an instance of a RegressionPlan or null if ID is invalid

regressionSuiteByID

public RegressionSuite regressionSuiteByID(AssetID id)

Returns a Regression Suite with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Regression Suite to retrieve.

Returns:

an instance of a Regression Suite or null if ID is invalid.

testSetByID

public TestSet testSetByID(AssetID id)

Returns a Test Set with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Test Set to retrieve.

Returns:

an instance of a Test Set or null if ID is invalid.

testSetByDisplayID

public TestSet testSetByDisplayID(java.lang.String displayID)

Returns a TestSet with the given ID or null if the ID is invalid.

Parameters:

displayID - DisplayID of the TestSet to retrieve.

Returns:

an instance of a TestSet or null if ID is invalid.

environmentByID

public Environment environmentByID(AssetID id)

Returns a Environment with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Environment to retrieve.

Returns:

an instance of a Environment or null if ID is invalid.

regressionTestByID

public RegressionTest regressionTestByID(AssetID id)

Returns a Regression Test with the given ID or null if the ID is invalid.

Parameters:

id - ID of the Regression Test to retrieve.

Returns:

an instance of a Regression Test or null if ID is invalid.

projectByName

public Project projectByName(java.lang.String name)
                      throws SDKException

Retrieves the first project with the given name or null.

Parameters:

name - name of the project to retrieve.

Returns:

the first instance of a Project that matches name or null.

Throws:

SDKException - if there is a problem executing the query

memberByUserName

public Member memberByUserName(java.lang.String userName)
                        throws SDKException

Retrieves the first Member with the given user name.

Parameters:

userName - The user name the user or member uses to login to the VersionOne system.

Returns:

The first Member with the given user name, or null if none found.

Throws:

SDKException - if there is a problem executing the query

listTypeValues

public <T extends ListValue> java.util.Collection<T> listTypeValues(java.lang.Class<T> valuesClass)

Gets the active values of a standard list type.

Type Parameters:

T - The type of Entity that represents the V1 List Type.

Parameters:

valuesClass - T Class.

Returns:

A list of active values for this list type.

scheduleByID

public Schedule scheduleByID(AssetID id)

Returns a schedule with the given ID or null if the ID is invalid

Parameters:

id - ID of the schedule to retrieve

Returns:

an instance of a Schedule or null if ID is invalid

scheduleByName

public Schedule scheduleByName(java.lang.String name)

Retrieves the first schedule with the given name or null

Parameters:

name - name of the schedule to retrieve

Returns:

the first instance of a Schedule that matches name or null