|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface VersionManager
Manager responsible for JIRA versions.
Field Summary | |
---|---|
static String |
ALL_RELEASED_VERSIONS
Used to retreive all released versions |
static String |
ALL_UNRELEASED_VERSIONS
Used to retreive all unreleased versions |
static String |
NO_VERSIONS
Used to represent empty version fields |
Method Summary | |
---|---|
void |
archiveVersion(Version version,
boolean archive)
Archive/Un-archive a single version depending on the archive flag. |
void |
archiveVersions(String[] idsToArchive,
String[] idsToUnarchive)
Method used to archive and un-archive a number of versions. |
Version |
createVersion(String name,
Date releaseDate,
String description,
org.ofbiz.core.entity.GenericValue project,
Long scheduleAfterVersion)
Deprecated. now use #createVersion with projectId instead of generic value |
Version |
createVersion(String name,
Date releaseDate,
String description,
Long projectId,
Long scheduleAfterVersion)
Creates a new Version object. |
void |
decreaseVersionSequence(Version version)
Move a version to have a higher sequence number - ie make it later |
void |
deleteVersion(String actionType,
Version version,
String affectsAction,
Long affectsSwapVersionId,
String fixAction,
Long fixSwapVersionId)
Deprecated. since v3.13. Use deleteVersion(Version) instead. |
void |
deleteVersion(Version version)
Removes a specific version from the system. |
void |
editVersionDetails(Version version,
String name,
String description,
org.ofbiz.core.entity.GenericValue project)
Updates details for an existing version. |
void |
editVersionReleaseDate(Version version,
Date duedate)
Update the release date of a version. |
Collection<Version> |
getAffectedVersionsByIssue(org.ofbiz.core.entity.GenericValue issue)
|
Collection<org.ofbiz.core.entity.GenericValue> |
getAffectsIssues(Version version)
Return 'Affects' Issues |
Collection<org.ofbiz.core.entity.GenericValue> |
getAllAffectedIssues(Collection<Version> versions)
Return all Issues that are assoicated with the specified versions |
Collection<Version> |
getAllVersions()
|
Collection<Version> |
getAllVersionsReleased(boolean includeArchived)
|
Collection<Version> |
getAllVersionsUnreleased(boolean includeArchived)
|
Collection<org.ofbiz.core.entity.GenericValue> |
getFixIssues(Version version)
Return Fix Issues |
Collection<Version> |
getFixVersionsByIssue(org.ofbiz.core.entity.GenericValue issue)
|
Collection<Version> |
getOtherUnarchivedVersions(Version version)
Return all unarchived versions except this one |
Collection<Version> |
getOtherVersions(Version version)
Return all other versions in the project except this one |
Version |
getVersion(org.ofbiz.core.entity.GenericValue project,
String name)
Deprecated. Use getVersion(Long,String) instead |
Version |
getVersion(Long id)
Returns a single version. |
Version |
getVersion(Long projectId,
String versionName)
Search for a version by projectID and name. |
List<Version> |
getVersions(org.ofbiz.core.entity.GenericValue project)
Deprecated. use #getVersions(Long) |
Collection<Version> |
getVersions(List<Long> ids)
Return a collection of Version s matching the ids passed in. |
List<Version> |
getVersions(Long projectId)
Return a list of Version s for a project. |
Collection<Version> |
getVersionsArchived(org.ofbiz.core.entity.GenericValue projectGV)
Return all archived versions for a particular project. |
Collection<Version> |
getVersionsByName(String versionName)
Return a collection of Version s that have the specified name. |
Collection<Version> |
getVersionsReleased(org.ofbiz.core.entity.GenericValue project,
boolean includeArchived)
Deprecated. use getVersionsReleased(Long,boolean) instead |
Collection<Version> |
getVersionsReleased(Long projectId,
boolean includeArchived)
Gets a list of released versions for a project. |
Collection<Version> |
getVersionsReleasedDesc(org.ofbiz.core.entity.GenericValue project,
boolean includeArchived)
Deprecated. use getVersionsReleasedDesc(Long, boolean) instead |
Collection<Version> |
getVersionsReleasedDesc(Long projectId,
boolean includeArchived)
Gets a list of released versions for a project in reverse order. |
Collection<Version> |
getVersionsUnarchived(org.ofbiz.core.entity.GenericValue projectGV)
Deprecated. Use getVersionsUnarchived(Long) instead. Since v3.10 |
Collection<Version> |
getVersionsUnarchived(Long projectId)
Return all un-archived versions for a particular project |
Collection<Version> |
getVersionsUnreleased(org.ofbiz.core.entity.GenericValue project,
boolean includeArchived)
Deprecated. Use getVersionsUnreleased(Long,boolean) instead, since v3.10. |
Collection<Version> |
getVersionsUnreleased(Long projectId,
boolean includeArchived)
Gets a list of un-released versions for a particular project. |
void |
increaseVersionSequence(Version version)
Move a version to have a lower sequence number - ie make it earlier |
boolean |
isVersionOverDue(Version version)
Checks to see if a version is overdue. |
void |
moveIssuesToNewVersion(List issues,
Version currentVersion,
Version swapToVersion)
Swaps the list of issues supplied from one version to another. |
void |
moveToEndVersionSequence(Version version)
Move a version to the end of the version sequence |
void |
moveToStartVersionSequence(Version version)
Move a version to the start of the version list |
void |
moveVersionAfter(Version version,
Long scheduleAfterVersion)
Move a version after another version |
void |
releaseVersion(Version version,
boolean release)
Used to release or unrelease a version, depending on the release flag. |
void |
releaseVersions(Collection<Version> versions,
boolean release)
Used to release versions depending on the release flag. |
Field Detail |
---|
static final String NO_VERSIONS
static final String ALL_UNRELEASED_VERSIONS
static final String ALL_RELEASED_VERSIONS
Method Detail |
---|
Version createVersion(String name, Date releaseDate, String description, org.ofbiz.core.entity.GenericValue project, Long scheduleAfterVersion) throws CreateException
Version
object.
name
- releaseDate
- date of release or null if not released.description
- project
- the GenericValue of the Project of the version.scheduleAfterVersion
- id of the version after which this should be sequenced or null.
CreateException
- If there was a problem creating the version.Version createVersion(String name, Date releaseDate, String description, Long projectId, Long scheduleAfterVersion) throws CreateException
Version
object. Takes a project ID instead of a project GenericValue.
name
- releaseDate
- date of release or null if not released.description
- projectId
- the id of the Project of the version.scheduleAfterVersion
- id of the version after which this should be sequenced or null.
CreateException
- If there was a problem creating the version.void moveToStartVersionSequence(Version version) throws org.ofbiz.core.entity.GenericEntityException
version
-
org.ofbiz.core.entity.GenericEntityException
void increaseVersionSequence(Version version) throws org.ofbiz.core.entity.GenericEntityException
version
-
org.ofbiz.core.entity.GenericEntityException
void decreaseVersionSequence(Version version) throws org.ofbiz.core.entity.GenericEntityException
version
-
org.ofbiz.core.entity.GenericEntityException
void moveToEndVersionSequence(Version version) throws org.ofbiz.core.entity.GenericEntityException
version
-
org.ofbiz.core.entity.GenericEntityException
void moveVersionAfter(Version version, Long scheduleAfterVersion)
version
- version to reschedulescheduleAfterVersion
- id of the version to schedule after the given version objectvoid deleteVersion(String actionType, Version version, String affectsAction, Long affectsSwapVersionId, String fixAction, Long fixSwapVersionId) throws org.ofbiz.core.entity.GenericEntityException
deleteVersion(Version)
instead.
actionType
- See VersionKeys.DELETE_ACTION
,VersionKeys.MERGE_ACTION
version
- The version to delete.affectsAction
- Used to decide whether to move all the issues to a different 'affects' version or just remove them. See VersionKeys.REMOVE_ACTION
, VersionKeys.SWAP_ACTION
affectsSwapVersionId
- The new affects version to move issues to.fixAction
- Used to decide wether to move all the issues to a different 'fix' version or just remove them. See VersionKeys.REMOVE_ACTION
, VersionKeys.SWAP_ACTION
fixSwapVersionId
- The new fix version to move issues to.
org.ofbiz.core.entity.GenericEntityException
void deleteVersion(Version version)
version
- The version to be removed.void editVersionDetails(Version version, String name, String description, org.ofbiz.core.entity.GenericValue project) throws org.ofbiz.core.entity.GenericEntityException
version
- The version to updatename
- description
- project
- Used to check for duplicate version names in a project.
org.ofbiz.core.entity.GenericEntityException
IllegalArgumentException
- If the name is not set, or already exists.void releaseVersion(Version version, boolean release)
version
- Version to be released (or unreleased)release
- True to release a version. False to 'unrelease' a versionvoid releaseVersions(Collection<Version> versions, boolean release)
versions
- Collection of Version
srelease
- True to release a version. False to 'unrelease' a versionvoid moveIssuesToNewVersion(List issues, Version currentVersion, Version swapToVersion) throws org.ofbiz.core.entity.GenericEntityException, IndexException
issues
- currentVersion
- swapToVersion
-
org.ofbiz.core.entity.GenericEntityException
IndexException
void archiveVersions(String[] idsToArchive, String[] idsToUnarchive) throws org.ofbiz.core.entity.GenericEntityException
idsToArchive
- idsToUnarchive
-
org.ofbiz.core.entity.GenericEntityException
void archiveVersion(Version version, boolean archive)
version
- archive
- Collection<Version> getVersionsUnarchived(org.ofbiz.core.entity.GenericValue projectGV) throws org.ofbiz.core.entity.GenericEntityException
getVersionsUnarchived(Long)
instead. Since v3.10
projectGV
-
Version
s
org.ofbiz.core.entity.GenericEntityException
Collection<Version> getVersionsUnarchived(Long projectId)
projectId
- id of the project.
Version
s
org.ofbiz.core.entity.GenericEntityException
- If there's a problem retrieving versionsCollection<Version> getVersionsArchived(org.ofbiz.core.entity.GenericValue projectGV) throws org.ofbiz.core.entity.GenericEntityException
projectGV
-
Version
s
org.ofbiz.core.entity.GenericEntityException
void editVersionReleaseDate(Version version, Date duedate) throws org.ofbiz.core.entity.GenericEntityException
version
- duedate
-
org.ofbiz.core.entity.GenericEntityException
boolean isVersionOverDue(Version version)
version
-
List<Version> getVersions(org.ofbiz.core.entity.GenericValue project)
project
-
List<Version> getVersions(Long projectId)
Version
s for a project.
projectId
-
Collection<Version> getVersionsByName(String versionName)
Version
s that have the specified name.
versionName
- the name of the version (case-insensitive)
Collection<Version> getVersions(List<Long> ids)
Version
s matching the ids passed in.
ids
-
Version getVersion(Long id)
id
-
Version
object.Version getVersion(Long projectId, String versionName)
projectId
- versionName
-
Version
object.Version getVersion(org.ofbiz.core.entity.GenericValue project, String name)
getVersion(Long,String)
instead
project
- name
-
Version
object.Collection<Version> getVersionsUnreleased(org.ofbiz.core.entity.GenericValue project, boolean includeArchived)
getVersionsUnreleased(Long,boolean)
instead, since v3.10.
project
- includeArchived
-
Version
sCollection<Version> getVersionsUnreleased(Long projectId, boolean includeArchived)
projectId
- The id of the project for which to return versionsincludeArchived
- True if archived versions should be included
Version
s, never nullCollection<Version> getVersionsReleased(org.ofbiz.core.entity.GenericValue project, boolean includeArchived)
getVersionsReleased(Long,boolean)
instead
project
- project generic valueincludeArchived
- flag to indicate whether to include archived versions in the result.
Version
objectsCollection<Version> getVersionsReleased(Long projectId, boolean includeArchived)
projectId
- project idincludeArchived
- flag to indicate whether to include archived versions in the result.
Version
objectsCollection<Version> getVersionsReleasedDesc(org.ofbiz.core.entity.GenericValue project, boolean includeArchived)
getVersionsReleasedDesc(Long, boolean)
instead
project
- project generic valueincludeArchived
- flag to indicate whether to include archived versions in the result.
Version
objectsCollection<Version> getVersionsReleasedDesc(Long projectId, boolean includeArchived)
projectId
- project idincludeArchived
- flag to indicate whether to include archived versions in the result.
Version
objectsCollection<Version> getOtherVersions(Version version) throws org.ofbiz.core.entity.GenericEntityException
version
-
org.ofbiz.core.entity.GenericEntityException
Collection<Version> getOtherUnarchivedVersions(Version version) throws org.ofbiz.core.entity.GenericEntityException
version
-
org.ofbiz.core.entity.GenericEntityException
Collection<org.ofbiz.core.entity.GenericValue> getAllAffectedIssues(Collection<Version> versions) throws org.ofbiz.core.entity.GenericEntityException
versions
- a collection of Version
objects
GenericValue
s
org.ofbiz.core.entity.GenericEntityException
Collection<org.ofbiz.core.entity.GenericValue> getFixIssues(Version version) throws org.ofbiz.core.entity.GenericEntityException
version
-
GenericValue
s
org.ofbiz.core.entity.GenericEntityException
Collection<org.ofbiz.core.entity.GenericValue> getAffectsIssues(Version version) throws org.ofbiz.core.entity.GenericEntityException
version
-
GenericValue
s
org.ofbiz.core.entity.GenericEntityException
Collection<Version> getAffectedVersionsByIssue(org.ofbiz.core.entity.GenericValue issue)
issue
-
Version
s for an issue.Collection<Version> getFixVersionsByIssue(org.ofbiz.core.entity.GenericValue issue)
issue
-
Version
s for an issue.Collection<Version> getAllVersions()
Collection<Version> getAllVersionsReleased(boolean includeArchived)
includeArchived
- whether or not to include archived versions
Collection<Version> getAllVersionsUnreleased(boolean includeArchived)
includeArchived
- whether or not to include archived versions
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |