|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Project
Framework for manipulating projects
Method Summary | |
---|---|
String |
addComponent(String projectKey,
String componentName,
String description,
String leadUserName)
Adds a component to the project |
long |
addProject(String name,
String key,
String lead)
Adds a project, or if a project with that name exists, does almost nothing. |
String |
addVersion(String projectKey,
String versionName,
String description,
String releaseDate)
Adds a version to a project. |
void |
archiveVersion(String projectKey,
String versionName)
Archives a version of a project. |
void |
associateFieldConfigurationScheme(String projectName,
String newFieldConfigurationSchemeName)
Associates the specified configuration scheme with the project. |
void |
associateIssueLevelSecurityScheme(String projectName,
String newIssueLevelSecuritySchemeName)
Associates the specified configuration scheme with the project. |
void |
associateNotificationScheme(String projectName,
String notificationSchemeName)
Associates the specified notification scheme with the project. |
void |
associateWorkflowScheme(String projectName,
String workflowSchemeName)
Associates the specified workflow scheme with the project. |
void |
associateWorkflowScheme(String projectName,
String workflowSchemeName,
Map<String,String> statusMapping,
boolean wait)
Associates the specified workflow scheme with the project. |
void |
createWorkflowSchemeDraft(String projectKey)
Creates a draft workflow scheme of the project. |
void |
deleteProject(long projectId)
Delete a project |
void |
deleteProject(String project)
Delete project with the given name |
void |
deleteVersion(String projectKey,
String versionName)
Deletes a version of a project. |
void |
editComponent(String projectKey,
String componentName,
String name,
String description,
String leadUserName)
Edits a component of a project. |
void |
editProject(long projectId,
String name,
String description,
String url)
Change the parameters for the passed project. |
void |
editVersionDetails(String projectName,
String versionName,
String name,
String description,
String releaseDate)
Edits a version of a project. |
void |
editWorkflowSchemeDraft(String projectKey,
String workflowName,
String... issueTypeIds)
Edits the workflow scheme draft of the given project. |
boolean |
projectWithKeyExists(String project)
Checks whether or not the specified project exists. |
void |
publishWorkflowSchemeDraft(String projectName,
Long schemeId,
Map<String,String> statusMapping,
boolean wait)
Publishes the workflow scheme draft of the specified project. |
void |
releaseVersion(String projectKey,
String versionName,
String releaseDate)
Releases a version of a project. |
void |
setProjectLead(String projectName,
String userName)
Sets the lead for a project |
void |
unreleaseVersion(String projectKey,
String versionName,
String releaseDate)
Unreleases a version of a project. |
ProjectAdministration |
viewProject(String project)
Browses to the View Project administration screen. |
void |
waitForWorkflowMigration(long sleepTime,
int retryCount)
Waits for the asynchronous workflow migration to complete. |
Method Detail |
---|
boolean projectWithKeyExists(String project)
project
- the name of the project to check e.g. "homosapien"
long addProject(String name, String key, String lead)
name
- the name of the project.key
- the project key.lead
- the username of the project lead.
ProjectAdministration viewProject(String project)
project
- the name of the projectvoid editProject(long projectId, String name, String description, String url)
projectId
- the id of the project to change.name
- the new name of the project. Set to null to keep current setting.description
- the description of the project. Set to null to keep current setting.url
- the url for the project. Set to null to keep current setting.void deleteProject(long projectId)
projectId
- the id of the projectvoid deleteProject(String project)
project
- the project name.String addVersion(String projectKey, String versionName, String description, String releaseDate)
projectKey
- the key of the project e.g. "HSP".versionName
- the name of the version e.g. "New Version 1"description
- the new description of the version; use null to not provide a descriptionreleaseDate
- the new release date of the version; use null to not provide a release date
void archiveVersion(String projectKey, String versionName)
projectKey
- the name of the project e.g. "HSP"versionName
- the name of the version e.g. "New Version 5"void releaseVersion(String projectKey, String versionName, String releaseDate)
projectKey
- the name of the project e.g. "HSP". Must not be null.versionName
- the name of the version e.g. "New Version 5". Must not be null.releaseDate
- the release date of the version. Use null to ignore setting of this field.void unreleaseVersion(String projectKey, String versionName, String releaseDate)
projectKey
- the name of the project e.g. "HSP". Must not be null.versionName
- the name of the version e.g. "New Version 5". Must not be null.releaseDate
- the release date of the version. Use null to ignore setting of this field.void deleteVersion(String projectKey, String versionName)
projectKey
- the name of the project e.g. "HSP". Must not be null.versionName
- the name of the version e.g. "New Version 5". Must not be null.void editVersionDetails(String projectName, String versionName, String name, String description, String releaseDate)
projectName
- the name of the project e.g. "homosapien".versionName
- the name of the version e.g. "New Version 1"name
- the new name of the version; use null to retain previous valuedescription
- the new description of the version; use null to retain previous valuereleaseDate
- the new release date of the version; use null to retain previous valuevoid editComponent(String projectKey, String componentName, String name, String description, String leadUserName)
projectKey
- the key of the project e.g. "HSP".componentName
- the name of the component e.g. "New Component 1"name
- the new name of the component; use null to retain previous valuedescription
- the new description of the component; use null to retain previous valueleadUserName
- the new username of the component lead; use null to retain previous valuevoid associateFieldConfigurationScheme(String projectName, String newFieldConfigurationSchemeName)
projectName
- the name of the project to alternewFieldConfigurationSchemeName
- the name of the new field configuration scheme; use null
or
"None"
to restore the System Default Field Configuration Scheme.void associateIssueLevelSecurityScheme(String projectName, String newIssueLevelSecuritySchemeName)
projectName
- the name of the project to alternewIssueLevelSecuritySchemeName
- the name of the new issue level security scheme; use null
or
"None"
to remove the scheme.void associateWorkflowScheme(String projectName, String workflowSchemeName)
projectName
- the name of the project to alterworkflowSchemeName
- name of the workflow scheme to associate.void associateWorkflowScheme(String projectName, String workflowSchemeName, Map<String,String> statusMapping, boolean wait)
projectName
- the name of the project to alterworkflowSchemeName
- name of the workflow scheme to associate.statusMapping
- mapping for statusesvoid createWorkflowSchemeDraft(String projectKey)
projectKey
- the key of the project whose draft scheme will be createdvoid editWorkflowSchemeDraft(String projectKey, String workflowName, String... issueTypeIds)
projectKey
- the key of the project whose draft scheme will be editedworkflowName
- name of the workflow to assign issue types to.issueTypeIds
- issue types to assign.void publishWorkflowSchemeDraft(String projectName, Long schemeId, Map<String,String> statusMapping, boolean wait)
projectName
- the name of the project to alterschemeId
- statusMapping
- mapping for statusesvoid waitForWorkflowMigration(long sleepTime, int retryCount)
sleepTime
- The time to sleep before refreshing the page again and checking for the operation to
be finished.retryCount
- The number of times we will try to check for the operation to be finished.void associateNotificationScheme(String projectName, String notificationSchemeName)
projectName
- the name of the project to alternotificationSchemeName
- name of the notification scheme to associate.void setProjectLead(String projectName, String userName)
projectName
- the project to changeuserName
- the new project leadString addComponent(String projectKey, String componentName, String description, String leadUserName)
projectKey
- the key of the projectcomponentName
- the component namedescription
- the description; use null
to not set oneleadUserName
- the lead user's name; use null
to not set one
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |