|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface VersionClient
The client responsible for Project version(s) related operations
Method Summary | |
---|---|
Version |
createVersion(VersionInput version,
ProgressMonitor progressMonitor)
Creates a new version (which logically belongs to a project) |
int |
getNumUnresolvedIssues(URI versionUri,
ProgressMonitor progressMonitor)
Retrieves number of unresolved issues which have their Fix Version(s) field pointing to given version. |
Version |
getVersion(URI versionUri,
ProgressMonitor progressMonitor)
Retrieves full information about selected project version |
VersionRelatedIssuesCount |
getVersionRelatedIssuesCount(URI versionUri,
ProgressMonitor progressMonitor)
Retrieves basic statistics about issues which have their Fix Version(s) or Affects Version(s) field pointing to given version. |
Version |
moveVersion(URI versionUri,
VersionPosition versionPosition,
ProgressMonitor progressMonitor)
Moves selected version to another position. |
Version |
moveVersionAfter(URI versionUri,
URI afterVersionUri,
ProgressMonitor progressMonitor)
Moves selected version after another version. |
void |
removeVersion(URI versionUri,
URI moveFixIssuesToVersionUri,
URI moveAffectedIssuesToVersionUri,
ProgressMonitor progressMonitor)
Removes selected version optionally changing Fix Version(s) and/or Affects Version(s) fields of related issues. |
Version |
updateVersion(URI versionUri,
VersionInput versionInput,
ProgressMonitor progressMonitor)
Updates selected version with a new details. |
Method Detail |
---|
Version getVersion(URI versionUri, ProgressMonitor progressMonitor)
versionUri
- URI of the version to retrieve. You can get it for example from Project or it can be
referenced from an issue.progressMonitor
- progress monitor
RestClientException
- in case of problems (connectivity, malformed messages, etc.)Version createVersion(VersionInput version, ProgressMonitor progressMonitor)
version
- details about version to createprogressMonitor
- progress monitor
RestClientException
- in case of problems (connectivity, malformed messages, etc.)Version updateVersion(URI versionUri, VersionInput versionInput, ProgressMonitor progressMonitor)
versionUri
- full URI to the version to updateversionInput
- new details of the version. null
fields will be ignoredprogressMonitor
- progress monitor
RestClientException
- in case of problems (connectivity, malformed messages, etc.)void removeVersion(URI versionUri, @Nullable URI moveFixIssuesToVersionUri, @Nullable URI moveAffectedIssuesToVersionUri, ProgressMonitor progressMonitor)
versionUri
- full URI to the version to removemoveFixIssuesToVersionUri
- URI of the version to which issues should have now set their Fix Version(s)
field instead of the just removed version. Use null
to simply clear Fix Version(s) in all those issues
where the version removed was referenced.moveAffectedIssuesToVersionUri
- URI of the version to which issues should have now set their Affects Version(s)
field instead of the just removed version. Use null
to simply clear Affects Version(s) in all those issues
where the version removed was referenced.progressMonitor
- progress monitor
RestClientException
- in case of problems (connectivity, malformed messages, etc.)VersionRelatedIssuesCount getVersionRelatedIssuesCount(URI versionUri, ProgressMonitor progressMonitor)
versionUri
- full URI to the version you want to get related issues count forprogressMonitor
- progress monitor
RestClientException
- in case of problems (connectivity, malformed messages, etc.)int getNumUnresolvedIssues(URI versionUri, ProgressMonitor progressMonitor)
versionUri
- full URI to the version you want to get the number of unresolved issues forprogressMonitor
- progress monitor
RestClientException
- in case of problems (connectivity, malformed messages, etc.)Version moveVersionAfter(URI versionUri, URI afterVersionUri, ProgressMonitor progressMonitor)
afterVersionUri
) then
such call has no visual effect.
versionUri
- full URI to the version to moveafterVersionUri
- URI of the version to move selected version afterprogressMonitor
- progress monitor
RestClientException
- in case of problems (connectivity, malformed messages, etc.)Version moveVersion(URI versionUri, VersionPosition versionPosition, ProgressMonitor progressMonitor)
versionUri
- full URI to the version to moveversionPosition
- defines a new position of selected versionprogressMonitor
- progress monitor
RestClientException
- in case of problems (connectivity, malformed messages, etc.)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |