|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.rpc.soap.JiraSoapServiceImpl
public class JiraSoapServiceImpl
Constructor Summary | |
---|---|
JiraSoapServiceImpl(TokenManager tokenManager,
ProjectService projectService,
IssueService issueService,
UserService userService,
SchemeService schemeService,
AdminService adminService,
SearchService searchService,
ProjectRoleService projectRoleService,
IssueConstantsService issueConstantsService)
|
Method Summary | |
---|---|
void |
addActorsToProjectRole(java.lang.String token,
java.lang.String[] actors,
RemoteProjectRole projectRole,
RemoteProject project,
java.lang.String actorType)
|
boolean |
addAttachmentsToIssue(java.lang.String token,
java.lang.String issueKey,
java.lang.String[] fileNames,
byte[][] attachments)
Add attachments to an issue. |
boolean |
addBase64EncodedAttachmentsToIssue(java.lang.String token,
java.lang.String issueKey,
java.lang.String[] fileNames,
java.lang.String[] base64EncodedAttachmentData)
An alternative mechanism for adding attachments to an issue. |
void |
addComment(java.lang.String token,
java.lang.String issueKey,
RemoteComment remoteComment)
Adds a comment to the specified issue |
void |
addDefaultActorsToProjectRole(java.lang.String token,
java.lang.String[] actorNames,
RemoteProjectRole projectRole,
java.lang.String type)
|
RemotePermissionScheme |
addPermissionTo(java.lang.String token,
RemotePermissionScheme permissionScheme,
RemotePermission permission,
RemoteEntity remoteEntity)
|
void |
addUserToGroup(java.lang.String token,
RemoteGroup group,
RemoteUser ruser)
Adds the specified user to the specified group |
RemoteVersion |
addVersion(java.lang.String token,
java.lang.String projectKey,
RemoteVersion remoteVersion)
Addsa a new version to the specified project. |
RemoteWorklog |
addWorklogAndAutoAdjustRemainingEstimate(java.lang.String token,
java.lang.String issueKey,
RemoteWorklog remoteWorklog)
Adds a worklog to the given issue. |
RemoteWorklog |
addWorklogAndRetainRemainingEstimate(java.lang.String token,
java.lang.String issueKey,
RemoteWorklog remoteWorklog)
Adds a worklog to the given issue but leaves the issue's remaining estimate field unchanged. |
RemoteWorklog |
addWorklogWithNewRemainingEstimate(java.lang.String token,
java.lang.String issueKey,
RemoteWorklog remoteWorklog,
java.lang.String newRemainingEstimate)
Adds a worklog to the given issue and sets the issue's remaining estimate field to the given value. |
void |
archiveVersion(java.lang.String token,
java.lang.String projectKey,
java.lang.String versionName,
boolean archive)
|
RemoteGroup |
createGroup(java.lang.String token,
java.lang.String groupName,
RemoteUser firstUser)
Creates a group with the given name optionally adding the given user to it. |
RemoteIssue |
createIssue(java.lang.String token,
RemoteIssue rIssue)
This will create an issue based on the passed in details. |
RemoteIssue |
createIssueWithParent(java.lang.String token,
RemoteIssue rIssue,
java.lang.String parentIssueKey)
This will create an issue based on the passed in details and make it a child (eg subtask) of the specified parent issue. |
RemoteIssue |
createIssueWithParentWithSecurityLevel(java.lang.String token,
RemoteIssue rIssue,
java.lang.String parentIssueKey,
java.lang.Long securityLevelId)
This will create an issue based on the passed in details and use the security level and make it a child (eg subtask) of the specified parent issue. |
RemoteIssue |
createIssueWithSecurityLevel(java.lang.String token,
RemoteIssue rIssue,
java.lang.Long securityLevelId)
This will create an issue based on the passed in details and use the security level See also JiraSoapService.createIssue(String, com.atlassian.jira.rpc.soap.beans.RemoteIssue) |
RemotePermissionScheme |
createPermissionScheme(java.lang.String token,
java.lang.String name,
java.lang.String description)
|
RemoteProject |
createProject(java.lang.String token,
java.lang.String key,
java.lang.String name,
java.lang.String description,
java.lang.String url,
java.lang.String lead,
RemotePermissionScheme permissionScheme,
RemoteScheme notificationScheme,
RemoteScheme issueSecurityScheme)
Creates a project based on the passed in details. |
RemoteProject |
createProjectFromObject(java.lang.String token,
RemoteProject rproject)
Creates a project based on the passed in details. |
RemoteProjectRole |
createProjectRole(java.lang.String token,
RemoteProjectRole projectRole)
|
RemoteUser |
createUser(java.lang.String token,
java.lang.String username,
java.lang.String password,
java.lang.String fullName,
java.lang.String email)
Creates a user in JIRA with the specified user details. |
void |
deleteGroup(java.lang.String token,
java.lang.String groupName,
java.lang.String swapGroupName)
Deletes the specified group by name |
void |
deleteIssue(java.lang.String token,
java.lang.String issueKey)
This will delete an issue with the specified issue key |
RemotePermissionScheme |
deletePermissionFrom(java.lang.String token,
RemotePermissionScheme permissionSchemeName,
RemotePermission permission,
RemoteEntity remoteEntity)
|
void |
deletePermissionScheme(java.lang.String token,
java.lang.String permissionSchemeName)
|
void |
deleteProject(java.lang.String token,
java.lang.String projectKey)
This will delete a project with the specified project key |
void |
deleteProjectAvatar(java.lang.String token,
long avatarId)
Deletes the given custom Avatar from the system. |
void |
deleteProjectRole(java.lang.String token,
RemoteProjectRole projectRole,
boolean confirm)
|
void |
deleteUser(java.lang.String token,
java.lang.String username)
Deletes a user in JIRA with the specified username. |
void |
deleteWorklogAndAutoAdjustRemainingEstimate(java.lang.String token,
java.lang.String worklogId)
Deletes the worklog with the given id and updates the remaining estimate field on the isssue by increasing it by the time spent amount on the worklog being deleted. |
void |
deleteWorklogAndRetainRemainingEstimate(java.lang.String token,
java.lang.String worklogId)
Deletes the worklog with the given id but leaves the remaining estimate field on the isssue unchanged. |
void |
deleteWorklogWithNewRemainingEstimate(java.lang.String token,
java.lang.String worklogId,
java.lang.String newRemainingEstimate)
Deletes the worklog with the given id and sets the remaining estimate field on the isssue to the given value. |
RemoteComment |
editComment(java.lang.String token,
RemoteComment remoteComment)
Allows a comment to be edited |
RemotePermission[] |
getAllPermissions(java.lang.String token)
|
RemoteScheme[] |
getAssociatedNotificationSchemes(java.lang.String token,
RemoteProjectRole projectRole)
|
RemoteScheme[] |
getAssociatedPermissionSchemes(java.lang.String token,
RemoteProjectRole projectRole)
|
RemoteAttachment[] |
getAttachmentsFromIssue(java.lang.String token,
java.lang.String issueKey)
Returns the attachments that are associated with an issue |
RemoteNamedObject[] |
getAvailableActions(java.lang.String token,
java.lang.String issueKey)
Returns the available actions that can be applied to an issue. |
RemoteComment |
getComment(java.lang.String token,
java.lang.Long id)
Gets a specific comment by comment id |
RemoteComment[] |
getComments(java.lang.String token,
java.lang.String issueKey)
Gets the comments for an issue |
RemoteComponent[] |
getComponents(java.lang.String token,
java.lang.String projectKey)
Returns an array of all the components for the specified project key. |
RemoteConfiguration |
getConfiguration(java.lang.String token)
Returns information about the current configuration of JIRA. |
RemoteField[] |
getCustomFields(java.lang.String token)
Returns all the custom fields available |
RemoteRoleActors |
getDefaultRoleActors(java.lang.String token,
RemoteProjectRole projectRole)
|
RemoteFilter[] |
getFavouriteFilters(java.lang.String token)
This retreives a list of the currently logged in user's favourite fitlers. |
RemoteField[] |
getFieldsForAction(java.lang.String token,
java.lang.String issueKey,
java.lang.String actionIdString)
Returns the fields that are shown during an issue action. |
RemoteField[] |
getFieldsForCreate(java.lang.String token,
java.lang.String projectKey,
java.lang.Long issueTypeId)
Returns the fields that are shown during an issue creation. |
RemoteField[] |
getFieldsForEdit(java.lang.String token,
java.lang.String issueKey)
Returns the fields that are shown during an issue edit. |
RemoteGroup |
getGroup(java.lang.String token,
java.lang.String groupName)
Find the group with the specified name in JIRA. |
RemoteIssue |
getIssue(java.lang.String token,
java.lang.String issueKey)
Returns information about the specific issue as identified by the issue key |
RemoteIssue |
getIssueById(java.lang.String token,
java.lang.String issueId)
Returns information about the specific issue as identified by the issue id |
long |
getIssueCountForFilter(java.lang.String token,
java.lang.String filterId)
Returns the count of issues that would be returned for a given filter |
RemoteIssue[] |
getIssuesFromFilter(java.lang.String token,
java.lang.String filterId)
Returns issues that match the saved filter specified by the filterId. |
RemoteIssue[] |
getIssuesFromFilterWithLimit(java.lang.String token,
java.lang.String filterId,
int offSet,
int maxNumResults)
Returns issues that match the saved filter specified by the filterId. |
RemoteIssue[] |
getIssuesFromJqlSearch(java.lang.String token,
java.lang.String jqlSearch,
int maxNumResults)
Execute a specified JQL query and return the resulting issues. |
RemoteIssue[] |
getIssuesFromTextSearch(java.lang.String token,
java.lang.String searchTerms)
Returns issues containing searchTerms. |
RemoteIssue[] |
getIssuesFromTextSearchWithLimit(java.lang.String token,
java.lang.String searchTerms,
int offSet,
int maxNumResults)
Returns issues containing searchTerms. |
RemoteIssue[] |
getIssuesFromTextSearchWithProject(java.lang.String token,
java.lang.String[] projectKeys,
java.lang.String searchTerms,
int maxNumResults)
Returns issues containing searchTerms that are within the specified projects. |
RemoteIssueType[] |
getIssueTypes(java.lang.String token)
Returns an array of all the issue types for all projects in JIRA. |
RemoteIssueType[] |
getIssueTypesForProject(java.lang.String token,
java.lang.String projectId)
Returns an array of all the (non-sub task) issue types for the specified project id. |
RemoteScheme[] |
getNotificationSchemes(java.lang.String token)
|
RemotePermissionScheme[] |
getPermissionSchemes(java.lang.String token)
|
RemotePriority[] |
getPriorities(java.lang.String token)
Returns an array of all the issue priorities in JIRA. |
RemoteAvatar |
getProjectAvatar(java.lang.String token,
java.lang.String projectKey)
Retrieves the current avatar for the given project. |
RemoteAvatar[] |
getProjectAvatars(java.lang.String token,
java.lang.String projectKey,
boolean includeSystemAvatars)
Retrieves avatars for the given project. |
RemoteProject |
getProjectById(java.lang.String token,
java.lang.Long projectId)
Returns the Project with the matching id (if the user has permission to browse it). |
RemoteProject |
getProjectByKey(java.lang.String token,
java.lang.String projectKey)
Returns the Project with the matching key (if the user has permission to browse it). |
RemoteProjectRole |
getProjectRole(java.lang.String token,
java.lang.Long id)
|
RemoteProjectRoleActors |
getProjectRoleActors(java.lang.String token,
RemoteProjectRole projectRole,
RemoteProject project)
|
RemoteProjectRole[] |
getProjectRoles(java.lang.String token)
|
RemoteProject[] |
getProjectsNoSchemes(java.lang.String token)
Returns an array of all the Projects defined in JIRA. |
RemoteProject |
getProjectWithSchemesById(java.lang.String token,
java.lang.Long projectId)
Returns the Project with the matching id (if the user has permission to browse it) with notification, issue security and permission schemes attached. |
java.util.Date |
getResolutionDateById(java.lang.String token,
java.lang.Long issueId)
Given an issue id, this method returns the resolution date for this issue. |
java.util.Date |
getResolutionDateByKey(java.lang.String token,
java.lang.String issueKey)
Given an issue key, this method returns the resolution date for this issue. |
RemoteResolution[] |
getResolutions(java.lang.String token)
Returns an array of all the issue resolutions in JIRA. |
RemoteFilter[] |
getSavedFilters(java.lang.String token)
This retrieves a list of the currently logged in user's favourite fitlers. |
RemoteSecurityLevel |
getSecurityLevel(java.lang.String token,
java.lang.String issueKey)
Returns the current security level for given issue |
RemoteSecurityLevel[] |
getSecurityLevels(java.lang.String token,
java.lang.String projectKey)
Returns an array of all security levels for a given project. |
RemoteScheme[] |
getSecuritySchemes(java.lang.String token)
|
RemoteServerInfo |
getServerInfo(java.lang.String token)
Returns information about the server JIRA is running on including build number and base URL. |
RemoteStatus[] |
getStatuses(java.lang.String token)
Returns an array of all the issue statuses in JIRA. |
RemoteIssueType[] |
getSubTaskIssueTypes(java.lang.String token)
Returns an array of all the sub task issue types in JIRA. |
RemoteIssueType[] |
getSubTaskIssueTypesForProject(java.lang.String token,
java.lang.String projectId)
Returns an array of all the sub task issue types for the specified project id. |
int |
getTokenParameterIndex(java.lang.String operationName)
This is called to work out which parameter the token is given a method name |
RemoteUser |
getUser(java.lang.String token,
java.lang.String username)
Returns information about a user defined to JIRA. |
RemoteVersion[] |
getVersions(java.lang.String token,
java.lang.String projectKey)
Returns an array of all the versions for the specified project key. |
RemoteWorklog[] |
getWorklogs(java.lang.String token,
java.lang.String issueKey)
Returns all worklogs for the given issue. |
boolean |
hasPermissionToCreateWorklog(java.lang.String token,
java.lang.String issueKey)
Determines if the user has the permission to add worklogs to the specified issue, that timetracking is enabled in JIRA and that the specified issue is in an editable workflow state. |
boolean |
hasPermissionToDeleteWorklog(java.lang.String token,
java.lang.String worklogId)
Determine whether the current user has the permission to delete the supplied worklog, that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state. |
boolean |
hasPermissionToEditComment(java.lang.String token,
RemoteComment remoteComment)
Returns true if the user has permission to edit a comment |
boolean |
hasPermissionToUpdateWorklog(java.lang.String token,
java.lang.String worklogId)
Determine whether the current user has the permission to update the supplied worklog, that timetracking is enabled in JIRA and that the associated issue is in an editable workflow state. |
boolean |
isProjectRoleNameUnique(java.lang.String token,
java.lang.String name)
|
java.lang.String |
login(java.lang.String username,
java.lang.String password)
This will authenticate the user in JIRA and returned a authentication token that can then be used on all other SOAP methods. |
boolean |
logout(java.lang.String token)
Cleans up an authentication token that was previously created with a call to JiraSoapService.login(String, String) |
RemoteIssue |
progressWorkflowAction(java.lang.String token,
java.lang.String issueKey,
java.lang.String actionIdString,
RemoteFieldValue[] actionParams)
This will progress an issue through a workflow. |
void |
refreshCustomFields(java.lang.String token)
Refreshes the internal representation of all the custom fields available |
void |
releaseVersion(java.lang.String token,
java.lang.String projectKey,
RemoteVersion remoteVersion)
|
void |
removeActorsFromProjectRole(java.lang.String token,
java.lang.String[] actors,
RemoteProjectRole projectRole,
RemoteProject project,
java.lang.String actorType)
|
void |
removeAllRoleActorsByNameAndType(java.lang.String token,
java.lang.String name,
java.lang.String type)
|
void |
removeAllRoleActorsByProject(java.lang.String token,
RemoteProject project)
|
void |
removeDefaultActorsFromProjectRole(java.lang.String token,
java.lang.String[] actors,
RemoteProjectRole projectRole,
java.lang.String actorType)
|
void |
removeUserFromGroup(java.lang.String token,
RemoteGroup group,
RemoteUser ruser)
Removes the specified user to the specified group |
java.lang.String |
resolveTokenToUserName(java.lang.String token)
This ability to resolve a token into a user name is used by the JIRA logging and is not exposed on the SOAP service interface itself but rather via JiraSoapTokenResolver . |
void |
setNewProjectAvatar(java.lang.String token,
java.lang.String projectKey,
java.lang.String contentType,
java.lang.String base64ImageData)
Creates a new custom avatar for the given project and sets it to be current for the project. |
void |
setProjectAvatar(java.lang.String token,
java.lang.String projectKey,
java.lang.Long avatarId)
Sets the current avatar for the given project to that with the given id. |
void |
setTokenManager(TokenManager tokenManager)
|
void |
setUserPassword(java.lang.String token,
RemoteUser ruser,
java.lang.String newPassword)
Sets the password for a specified user |
RemoteGroup |
updateGroup(java.lang.String token,
RemoteGroup group)
Updates the details of a group |
RemoteIssue |
updateIssue(java.lang.String token,
java.lang.String issueKey,
RemoteFieldValue[] actionParams)
This will update an issue with new values. |
RemoteProject |
updateProject(java.lang.String token,
RemoteProject rProject)
Updates a project based on the passed in details. |
void |
updateProjectRole(java.lang.String token,
RemoteProjectRole projectRole)
|
RemoteUser |
updateUser(java.lang.String token,
RemoteUser ruser)
Updates the details about a user |
void |
updateWorklogAndAutoAdjustRemainingEstimate(java.lang.String token,
RemoteWorklog remoteWorklog)
Modifies the worklog with the id of the given worklog, updating its fields to match the given worklog and changes the remaining estimate field on the relevant issue to the value obtained by adding the previous time spent amount of the worklog and subtracting the new time spent amount. |
void |
updateWorklogAndRetainRemainingEstimate(java.lang.String token,
RemoteWorklog remoteWorklog)
Modifies the worklog with the id of the given worklog, updating its fields to match the given worklog but leaves the remaining estimate field on the relevant issue unchanged. |
void |
updateWorklogWithNewRemainingEstimate(java.lang.String token,
RemoteWorklog remoteWorklog,
java.lang.String newRemainingEstimate)
Modifies the worklog with the id of the given worklog, updating its fields to match the given worklog and sets the remaining estimate field on the relevant issue to the given value. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public JiraSoapServiceImpl(TokenManager tokenManager, ProjectService projectService, IssueService issueService, UserService userService, SchemeService schemeService, AdminService adminService, SearchService searchService, ProjectRoleService projectRoleService, IssueConstantsService issueConstantsService)
Method Detail |
---|
public void setTokenManager(TokenManager tokenManager)
public java.lang.String resolveTokenToUserName(java.lang.String token)
JiraSoapTokenResolver
.
resolveTokenToUserName
in interface com.atlassian.jira.soap.axis.JiraSoapTokenResolver
token
- the given out previously via login(String, String)
public int getTokenParameterIndex(java.lang.String operationName)
getTokenParameterIndex
in interface com.atlassian.jira.soap.axis.JiraSoapTokenResolver
operationName
- the name of the SOAP operation
public java.lang.String login(java.lang.String username, java.lang.String password) throws RemoteException
JiraSoapService
login
in interface JiraSoapService
username
- the JIRA user name to authenticatepassword
- the password of the JIRA user
RemoteException
- If there was some problem preventing the operation from working.
RemoteAuthenticationException
- If the username and password is an invalid combinationpublic boolean logout(java.lang.String token)
JiraSoapService
JiraSoapService.login(String, String)
logout
in interface JiraSoapService
token
- the SOAP authentication token
public RemoteServerInfo getServerInfo(java.lang.String token)
JiraSoapService
getServerInfo
in interface JiraSoapService
token
- the SOAP authentication token.
RemoteServerInfo
objectpublic RemoteProject[] getProjectsNoSchemes(java.lang.String token) throws RemoteException
JiraSoapService
getProjectsNoSchemes
in interface JiraSoapService
token
- the SOAP authentication token.
RemoteProject
objects.
RemoteException
- If there was some problem preventing the operation from working.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed outpublic RemoteProject getProjectById(java.lang.String token, java.lang.Long projectId) throws RemoteException
JiraSoapService
getProjectById
in interface JiraSoapService
token
- the SOAP authentication token.projectId
- the id of the requested project
RemotePermissionException
- if the User does not have permission to BROWSE the project.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteException
public RemoteProject getProjectWithSchemesById(java.lang.String token, java.lang.Long projectId) throws RemoteException
JiraSoapService
getProjectWithSchemesById
in interface JiraSoapService
token
- the SOAP authentication token.projectId
- the id of the requested project
RemotePermissionException
- if the User does not have permission to BROWSE the project.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteException
- if something dramatic happens during this operationpublic RemoteProject getProjectByKey(java.lang.String token, java.lang.String projectKey) throws RemoteException
JiraSoapService
getProjectByKey
in interface JiraSoapService
token
- the SOAP authentication token.projectKey
- the key of the requested project
RemotePermissionException
- if the User does not have permission to BROWSE the project.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteException
- if something dramatic happens during this operationpublic RemoteVersion addVersion(java.lang.String token, java.lang.String projectKey, RemoteVersion remoteVersion) throws RemoteException
JiraSoapService
addVersion
in interface JiraSoapService
token
- the SOAP authentication token.projectKey
- the key of the project to add the new version toremoteVersion
- the new version details
RemoteException
- If something dramatic happened during the execution of the operationpublic RemoteVersion[] getVersions(java.lang.String token, java.lang.String projectKey) throws RemoteException
JiraSoapService
getVersions
in interface JiraSoapService
token
- the SOAP authentication token.projectKey
- the key of the requested project
RemoteVersion
objects
RemoteException
- If there was some problem preventing the operation from working.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed outpublic RemoteComponent[] getComponents(java.lang.String token, java.lang.String projectKey) throws RemoteException
JiraSoapService
getComponents
in interface JiraSoapService
token
- the SOAP authentication token.projectKey
- the key of the requested project
RemoteComponent
objects
RemoteException
- If there was some problem preventing the operation from working.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed outpublic RemoteIssueType[] getIssueTypesForProject(java.lang.String token, java.lang.String projectId) throws RemotePermissionException, RemoteAuthenticationException
JiraSoapService
getIssueTypesForProject
in interface JiraSoapService
token
- the SOAP authentication token.projectId
- id of the project
RemoteIssueType
objects
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed outpublic RemoteIssueType[] getSubTaskIssueTypesForProject(java.lang.String token, java.lang.String projectId) throws RemotePermissionException, RemoteAuthenticationException
JiraSoapService
getSubTaskIssueTypesForProject
in interface JiraSoapService
token
- the SOAP authentication token.projectId
- id of the project
RemoteIssueType
objects
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed outpublic RemoteIssueType[] getIssueTypes(java.lang.String token) throws RemotePermissionException, RemoteAuthenticationException
JiraSoapService
getIssueTypes
in interface JiraSoapService
token
- the SOAP authentication token.
RemoteIssueType
objects
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed outpublic RemoteIssueType[] getSubTaskIssueTypes(java.lang.String token) throws RemotePermissionException, RemoteAuthenticationException
JiraSoapService
getSubTaskIssueTypes
in interface JiraSoapService
token
- the SOAP authentication token.
RemoteIssueType
objects
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed outpublic RemotePriority[] getPriorities(java.lang.String token) throws RemotePermissionException, RemoteAuthenticationException
JiraSoapService
getPriorities
in interface JiraSoapService
token
- the SOAP authentication token.
RemotePriority
objects
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed outpublic RemoteStatus[] getStatuses(java.lang.String token) throws RemotePermissionException, RemoteAuthenticationException
JiraSoapService
getStatuses
in interface JiraSoapService
token
- the SOAP authentication token.
RemoteStatus
objects
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed outpublic RemoteResolution[] getResolutions(java.lang.String token) throws RemotePermissionException, RemoteAuthenticationException
JiraSoapService
getResolutions
in interface JiraSoapService
token
- the SOAP authentication token.
RemoteResolution
objects
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed outpublic RemoteGroup getGroup(java.lang.String token, java.lang.String groupName) throws RemoteException
JiraSoapService
getGroup
in interface JiraSoapService
token
- the SOAP authentication token.groupName
- the name of the group to find.
RemoteGroup
object for the found group or null if it cant be found.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.
RemoteException
public RemoteGroup createGroup(java.lang.String token, java.lang.String groupName, RemoteUser firstUser) throws RemoteException
JiraSoapService
createGroup
in interface JiraSoapService
token
- the SOAP authentication token.groupName
- the name of the group to create.firstUser
- the user to add to the group (if null, no user will be added).
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If there is a problem with the group name, such as if the group name
exists.
RemoteException
public void addUserToGroup(java.lang.String token, RemoteGroup group, RemoteUser ruser) throws RemoteException
JiraSoapService
addUserToGroup
in interface JiraSoapService
token
- the SOAP authentication token.group
- the name of the group to add the user to.ruser
- the name of the user to add
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If there is a problem with the operation.
RemoteException
public void removeUserFromGroup(java.lang.String token, RemoteGroup group, RemoteUser ruser) throws RemoteException
JiraSoapService
removeUserFromGroup
in interface JiraSoapService
token
- the SOAP authentication token.group
- the name of the group to remove the user from.ruser
- the name of the user to remove
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If there is a problem with the operation.
RemoteException
public RemoteGroup updateGroup(java.lang.String token, RemoteGroup group) throws RemoteException
JiraSoapService
updateGroup
in interface JiraSoapService
token
- the SOAP authentication token.group
- the to be updated group
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If there is a problem with the operation.
RemoteException
public void deleteGroup(java.lang.String token, java.lang.String groupName, java.lang.String swapGroupName) throws RemoteException
JiraSoapService
deleteGroup
in interface JiraSoapService
token
- the SOAP authentication token.groupName
- the name of the group to delete.swapGroupName
- identifies the group to change comment and worklog visibility to.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If there is a problem with the operation.
RemoteException
public RemoteUser getUser(java.lang.String token, java.lang.String username) throws RemotePermissionException, RemoteAuthenticationException
JiraSoapService
getUser
in interface JiraSoapService
token
- the SOAP authentication token.username
- the user name to look up
RemoteUser
or null if it cant be found
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed outpublic RemoteUser createUser(java.lang.String token, java.lang.String username, java.lang.String password, java.lang.String fullName, java.lang.String email) throws RemoteException
JiraSoapService
createUser
in interface JiraSoapService
token
- the SOAP authentication token.username
- the user name to createpassword
- the password for the new userfullName
- the full name of the new useremail
- the email of the new user
RemoteUser
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.
RemoteException
public RemoteUser updateUser(java.lang.String token, RemoteUser ruser) throws RemotePermissionException, RemoteAuthenticationException, RemoteValidationException, RemoteException
JiraSoapService
updateUser
in interface JiraSoapService
token
- the SOAP authentication token.ruser
- the ruser details to update
RemotePermissionException
- If the ruser is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.
RemoteException
public void setUserPassword(java.lang.String token, RemoteUser ruser, java.lang.String newPassword) throws RemotePermissionException, RemoteAuthenticationException, RemoteValidationException, RemoteException
JiraSoapService
setUserPassword
in interface JiraSoapService
token
- the SOAP authentication token.ruser
- the ruser to updatenewPassword
- the new password for that user
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.
RemoteException
public void deleteUser(java.lang.String token, java.lang.String username) throws RemoteException
JiraSoapService
deleteUser
in interface JiraSoapService
token
- the SOAP authentication token.username
- the user name to delete
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.
RemoteException
public RemoteFilter[] getSavedFilters(java.lang.String token) throws RemoteException
JiraSoapService
getSavedFilters
in interface JiraSoapService
token
- the SOAP authentication token.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If there is a problem with the group name, such as if the group name
exists.
RemoteException
public RemoteFilter[] getFavouriteFilters(java.lang.String token) throws RemoteException
JiraSoapService
getFavouriteFilters
in interface JiraSoapService
token
- the SOAP authentication token.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If there is a problem with the group name, such as if the group name
exists.
RemoteException
public RemoteNamedObject[] getAvailableActions(java.lang.String token, java.lang.String issueKey) throws RemoteException
JiraSoapService
getAvailableActions
in interface JiraSoapService
token
- the SOAP authentication token.issueKey
- the issue to get actions for.
RemoteException
- if something dramatic happens during this operationpublic RemoteField[] getFieldsForAction(java.lang.String token, java.lang.String issueKey, java.lang.String actionIdString) throws RemoteException
JiraSoapService
getFieldsForAction
in interface JiraSoapService
token
- the SOAP authentication token.issueKey
- the issue to update.actionIdString
- the id of issue action to be executed
RemoteException
- if something dramatic happens during this operationpublic RemoteIssue progressWorkflowAction(java.lang.String token, java.lang.String issueKey, java.lang.String actionIdString, RemoteFieldValue[] actionParams) throws RemoteException
JiraSoapService
progressWorkflowAction
in interface JiraSoapService
token
- the SOAP authentication token.issueKey
- the issue to update.actionIdString
- the workflow action to progress toactionParams
- the list of issue fields to change in this workflow step
RemoteException
- if the issue cannot be updatedpublic RemoteIssue getIssue(java.lang.String token, java.lang.String issueKey) throws RemoteException
JiraSoapService
getIssue
in interface JiraSoapService
token
- the SOAP authentication token.issueKey
- the key of the issue to return
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteException
- if the issue does not exist or your dont have permission to see itpublic java.util.Date getResolutionDateByKey(java.lang.String token, java.lang.String issueKey) throws RemotePermissionException, RemoteAuthenticationException, RemoteException
JiraSoapService
getResolutionDateByKey
in interface JiraSoapService
token
- the SOAP authentication tokenissueKey
- the key of the issue
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteException
public java.util.Date getResolutionDateById(java.lang.String token, java.lang.Long issueId) throws RemotePermissionException, RemoteAuthenticationException, RemoteException
JiraSoapService
getResolutionDateById
in interface JiraSoapService
token
- the SOAP authentication tokenissueId
- the id of the issue
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteException
public RemoteIssue createIssue(java.lang.String token, RemoteIssue rIssue) throws RemoteException
JiraSoapService
createIssue
in interface JiraSoapService
token
- the SOAP authentication tokenrIssue
- the new issue details to create
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If the data cannot be validated
RemoteException
- If the issue does not exist or your dont have permission to see itpublic RemoteIssue createIssueWithSecurityLevel(java.lang.String token, RemoteIssue rIssue, java.lang.Long securityLevelId) throws RemoteException
JiraSoapService
JiraSoapService.createIssue(String, com.atlassian.jira.rpc.soap.beans.RemoteIssue)
createIssueWithSecurityLevel
in interface JiraSoapService
token
- the SOAP authentication tokenrIssue
- the new issue details to createsecurityLevelId
- the id of the required security level
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If the data cannot be validated
RemoteException
- If the issue does not exist or your dont have permission to see itpublic RemoteIssue createIssueWithParent(java.lang.String token, RemoteIssue rIssue, java.lang.String parentIssueKey) throws RemoteException
JiraSoapService
JiraSoapService.createIssue(String, com.atlassian.jira.rpc.soap.beans.RemoteIssue)
createIssueWithParent
in interface JiraSoapService
token
- the SOAP authentication tokenrIssue
- the new issue details to createparentIssueKey
- the key of the parent issue
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If the data cannot be validated
RemoteException
- If the issue does not exist or your dont have permission to see itpublic RemoteIssue createIssueWithParentWithSecurityLevel(java.lang.String token, RemoteIssue rIssue, java.lang.String parentIssueKey, java.lang.Long securityLevelId) throws RemoteException
JiraSoapService
JiraSoapService.createIssue(String, com.atlassian.jira.rpc.soap.beans.RemoteIssue)
createIssueWithParentWithSecurityLevel
in interface JiraSoapService
token
- the SOAP authentication tokenrIssue
- the new issue details to createparentIssueKey
- the key of the parent issuesecurityLevelId
- the id of the required security level
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If the data cannot be validated
RemoteException
- If the issue does not exist or your dont have permission to see itpublic boolean addAttachmentsToIssue(java.lang.String token, java.lang.String issueKey, java.lang.String[] fileNames, byte[][] attachments) throws RemoteException
JiraSoapService
addAttachmentsToIssue
in interface JiraSoapService
token
- the SOAP authentication token.issueKey
- the issue to attach tofileNames
- an array of filenames; each element names an attachment to be uploadedattachments
- an array of byte arrays; each element contains the data of the attachment to be uploaded
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If the data cannot be validated
RemoteException
public boolean addBase64EncodedAttachmentsToIssue(java.lang.String token, java.lang.String issueKey, java.lang.String[] fileNames, java.lang.String[] base64EncodedAttachmentData) throws RemoteException
JiraSoapService
addBase64EncodedAttachmentsToIssue
in interface JiraSoapService
token
- the SOAP authentication token.issueKey
- the issue to attach tofileNames
- an array of filenames; each element names an attachment to be uploadedbase64EncodedAttachmentData
- an array of Base 64 encoded Strings; each element contains the data of the
attachment to be uploaded
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If the data cannot be validated
RemoteException
JiraSoapService.addAttachmentsToIssue(String, String, String[], byte[][])
public RemoteAttachment[] getAttachmentsFromIssue(java.lang.String token, java.lang.String issueKey) throws RemoteException
JiraSoapService
getAttachmentsFromIssue
in interface JiraSoapService
token
- the SOAP authentication token.issueKey
- the issue to find attachments for
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If the data cannot be validated
RemoteException
- If the issue does not exist or your dont have permission to see itpublic RemoteIssue updateIssue(java.lang.String token, java.lang.String issueKey, RemoteFieldValue[] actionParams) throws RemoteException
JiraSoapService
JiraSoapService.progressWorkflowAction(String, String, String, com.atlassian.jira.rpc.soap.beans.RemoteFieldValue[])
to progress the issue status into a new workflow state.
If you are updating Select or Multi-Select custom fields, note that you should be passing in the Option Ids,
as opposed to the actual Option values. If you pass in the Option values, we will attempt to do an automatic
conversion from Option value to an Option Id if we find that none of the values passed in can be parsed to an
Option Id for the field.
In the case where an Option has a value that is also a valid Option Id for the field, and the supplied value
matches this Option value, we assume the supplied value is an OptionId.
If any automatic conversion fails, the original values are passed through and cause an exception with the valid
Option Ids for the field to be thrown.
updateIssue
in interface JiraSoapService
token
- the SOAP authentication token.issueKey
- the issue to update.actionParams
- the list of issue fields to change
RemoteException
- if the issue cannot be updatedpublic void deleteIssue(java.lang.String token, java.lang.String issueKey) throws RemoteException
JiraSoapService
deleteIssue
in interface JiraSoapService
token
- the SOAP authentication tokenissueKey
- the issue to delete
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteException
- If the issue does not exist or your dont have permission to see itpublic RemoteField[] getFieldsForCreate(java.lang.String token, java.lang.String projectKey, java.lang.Long issueTypeId) throws RemoteException
JiraSoapService
getFieldsForCreate
in interface JiraSoapService
token
- the SOAP authentication token.projectKey
- the project to create the issue in.issueTypeId
- the type of issue to create
RemoteException
- if something dramatic happens during this operationpublic RemoteField[] getFieldsForEdit(java.lang.String token, java.lang.String issueKey) throws RemoteException
JiraSoapService
getFieldsForEdit
in interface JiraSoapService
token
- the SOAP authentication token.issueKey
- the issue to update.
RemoteException
- if something dramatic happens during this operationpublic RemoteProject createProject(java.lang.String token, java.lang.String key, java.lang.String name, java.lang.String description, java.lang.String url, java.lang.String lead, RemotePermissionScheme permissionScheme, RemoteScheme notificationScheme, RemoteScheme issueSecurityScheme) throws RemoteException
JiraSoapService
createProject
in interface JiraSoapService
token
- the SOAP authentication tokenkey
- the new project keyname
- the new project namedescription
- the description of the new projecturl
- the new project URLlead
- the user who is trhe project leadpermissionScheme
- the permission to use for the new projectnotificationScheme
- the notification scheme to use on the new projectissueSecurityScheme
- the issue security scheme to use on the new project
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If the data cannot be validated
RemoteException
- If something dramatic happened during the execution of the operationpublic RemoteProject createProjectFromObject(java.lang.String token, RemoteProject rproject) throws RemoteException
JiraSoapService
createProjectFromObject
in interface JiraSoapService
token
- the SOAP authentication tokenrproject
- the object representation of the new project
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If the data cannot be validated
RemoteException
- If something dramatic happened during the execution of the operationpublic RemoteProject updateProject(java.lang.String token, RemoteProject rProject) throws RemoteException
JiraSoapService
updateProject
in interface JiraSoapService
token
- the SOAP authentication tokenrProject
- the object representation of the updated project
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteValidationException
- If the data cannot be validated
RemoteException
- If something dramatic happened during the execution of the operationpublic void deleteProject(java.lang.String token, java.lang.String projectKey) throws RemoteException
JiraSoapService
deleteProject
in interface JiraSoapService
token
- the SOAP authentication tokenprojectKey
- the project to delete
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteException
- If something dramatic happened during the execution of the operationpublic RemoteComment getComment(java.lang.String token, java.lang.Long id) throws RemoteException
JiraSoapService
getComment
in interface JiraSoapService
token
- the SOAP authentication tokenid
- the id of the comment to retrieve
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteException
- if the comment does not exist or your dont have permission to see itpublic RemoteComment[] getComments(java.lang.String token, java.lang.String issueKey) throws RemoteException
JiraSoapService
getComments
in interface JiraSoapService
token
- the SOAP authentication tokenissueKey
- the key of the issue to get comments for
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteException
- if the issue does not exist or your dont have permission to see itpublic void addComment(java.lang.String token, java.lang.String issueKey, RemoteComment remoteComment) throws RemoteException
JiraSoapService
addComment
in interface JiraSoapService
token
- the SOAP authentication tokenissueKey
- the key of the issue to add a comment toremoteComment
- the new comment to add
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteException
- If the issue does not exist or your dont have permission to see itpublic boolean hasPermissionToEditComment(java.lang.String token, RemoteComment remoteComment) throws RemoteException
JiraSoapService
hasPermissionToEditComment
in interface JiraSoapService
token
- the SOAP authentication tokenremoteComment
- the comment to edit
RemoteException
- if something dramatic happens during this operationpublic RemoteComment editComment(java.lang.String token, RemoteComment remoteComment) throws RemoteException
JiraSoapService
editComment
in interface JiraSoapService
token
- the SOAP authentication tokenremoteComment
- the new comment details
RemoteException
- if something dramatic happens during this operationpublic RemoteScheme[] getNotificationSchemes(java.lang.String token) throws RemoteException
getNotificationSchemes
in interface JiraSoapService
RemoteException
public RemotePermissionScheme[] getPermissionSchemes(java.lang.String token) throws RemoteException
getPermissionSchemes
in interface JiraSoapService
RemoteException
public RemoteScheme[] getSecuritySchemes(java.lang.String token) throws RemoteException
getSecuritySchemes
in interface JiraSoapService
RemoteException
public RemotePermission[] getAllPermissions(java.lang.String token) throws RemoteException
getAllPermissions
in interface JiraSoapService
RemoteException
public RemotePermissionScheme createPermissionScheme(java.lang.String token, java.lang.String name, java.lang.String description) throws RemoteException
createPermissionScheme
in interface JiraSoapService
RemoteException
public RemotePermissionScheme addPermissionTo(java.lang.String token, RemotePermissionScheme permissionScheme, RemotePermission permission, RemoteEntity remoteEntity) throws RemoteException
addPermissionTo
in interface JiraSoapService
RemoteException
public RemotePermissionScheme deletePermissionFrom(java.lang.String token, RemotePermissionScheme permissionSchemeName, RemotePermission permission, RemoteEntity remoteEntity) throws RemoteException
deletePermissionFrom
in interface JiraSoapService
RemoteException
public void deletePermissionScheme(java.lang.String token, java.lang.String permissionSchemeName) throws RemoteException
deletePermissionScheme
in interface JiraSoapService
RemoteException
public RemoteField[] getCustomFields(java.lang.String token) throws RemoteException
JiraSoapService
getCustomFields
in interface JiraSoapService
token
- the SOAP authentication token.
RemoteException
- If something dramatic happened during the execution of the operationpublic void refreshCustomFields(java.lang.String token) throws RemoteException
JiraSoapService
refreshCustomFields
in interface JiraSoapService
token
- the SOAP authentication token.
RemoteException
- If something dramatic happened during the execution of the operationpublic RemoteIssue[] getIssuesFromFilter(java.lang.String token, java.lang.String filterId) throws RemoteException
JiraSoapService
getIssuesFromFilter
in interface JiraSoapService
token
- the SOAP authentication token.filterId
- identifies the saved filter to use for the search.
RemoteException
- If there was some problem preventing the operation from working.public RemoteIssue[] getIssuesFromFilterWithLimit(java.lang.String token, java.lang.String filterId, int offSet, int maxNumResults) throws RemoteException
JiraSoapService
getIssuesFromFilterWithLimit
in interface JiraSoapService
token
- the SOAP authentication token.filterId
- identifies the saved filter to use for the search.offSet
- the place in the result set to use as the first result returnedmaxNumResults
- the maximum number of results that this method will return.
RemoteException
- If there was some problem preventing the operation from working.public RemoteIssue[] getIssuesFromTextSearch(java.lang.String token, java.lang.String searchTerms) throws RemoteException
JiraSoapService
getIssuesFromTextSearch
in interface JiraSoapService
token
- the SOAP authentication token.searchTerms
- search terms
RemoteException
- If there was some problem preventing the operation from working.JiraSoapService.getIssuesFromJqlSearch(String, String, int)
public RemoteIssue[] getIssuesFromTextSearchWithLimit(java.lang.String token, java.lang.String searchTerms, int offSet, int maxNumResults) throws RemoteException
JiraSoapService
getIssuesFromTextSearchWithLimit
in interface JiraSoapService
token
- the SOAP authentication token.searchTerms
- search termsoffSet
- the place in the result set to use as the first result returnedmaxNumResults
- the maximum number of results that this method will return.
RemoteException
- If there was some problem preventing the operation from working.JiraSoapService.getIssuesFromJqlSearch(String, String, int)
public RemoteIssue[] getIssuesFromTextSearchWithProject(java.lang.String token, java.lang.String[] projectKeys, java.lang.String searchTerms, int maxNumResults) throws RemoteException
JiraSoapService
getIssuesFromTextSearchWithProject
in interface JiraSoapService
token
- the SOAP authentication token.projectKeys
- an array of project keys to search withinsearchTerms
- search termsmaxNumResults
- the maximum number of results that this method will return.
RemoteException
- If there was some problem preventing the operation from working.JiraSoapService.getIssuesFromJqlSearch(String, String, int)
public RemoteIssue[] getIssuesFromJqlSearch(java.lang.String token, java.lang.String jqlSearch, int maxNumResults) throws RemoteException
JiraSoapService
getIssuesFromJqlSearch
in interface JiraSoapService
token
- the SOAP authentication tokenjqlSearch
- JQL query string to executemaxNumResults
- the maximum number of results that this method will return
RemoteException
- If there was a JQL parse error or an error occurs during the searchpublic long getIssueCountForFilter(java.lang.String token, java.lang.String filterId) throws RemoteException
JiraSoapService
getIssueCountForFilter
in interface JiraSoapService
token
- the SOAP authentication token.filterId
- the id of the search filter
RemoteException
- if something dramatic happens during this operationpublic RemoteIssue getIssueById(java.lang.String token, java.lang.String issueId) throws RemoteException
JiraSoapService
getIssueById
in interface JiraSoapService
token
- the SOAP authentication token.issueId
- the id of the issue to return
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed out
RemoteException
- if the issue does not exist or your dont have permission to see itpublic RemoteConfiguration getConfiguration(java.lang.String token) throws RemoteException
JiraSoapService
getConfiguration
in interface JiraSoapService
token
- the SOAP authentication token.
RemoteConfiguration
object which contains information about
the current configuration of JIRA.
RemoteException
- If there was some problem preventing the operation from working.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteAuthenticationException
- If the token is invalid or the SOAP session has timed outpublic RemoteProjectRole[] getProjectRoles(java.lang.String token) throws RemoteException
getProjectRoles
in interface JiraSoapService
RemoteException
public RemoteProjectRole getProjectRole(java.lang.String token, java.lang.Long id) throws RemoteException
getProjectRole
in interface JiraSoapService
RemoteException
public RemoteProjectRole createProjectRole(java.lang.String token, RemoteProjectRole projectRole) throws RemoteException
createProjectRole
in interface JiraSoapService
RemoteException
public boolean isProjectRoleNameUnique(java.lang.String token, java.lang.String name) throws RemoteException
isProjectRoleNameUnique
in interface JiraSoapService
RemoteException
public void deleteProjectRole(java.lang.String token, RemoteProjectRole projectRole, boolean confirm) throws RemoteException
deleteProjectRole
in interface JiraSoapService
RemoteException
public void addActorsToProjectRole(java.lang.String token, java.lang.String[] actors, RemoteProjectRole projectRole, RemoteProject project, java.lang.String actorType) throws RemoteException
addActorsToProjectRole
in interface JiraSoapService
RemoteException
public void removeActorsFromProjectRole(java.lang.String token, java.lang.String[] actors, RemoteProjectRole projectRole, RemoteProject project, java.lang.String actorType) throws RemoteException
removeActorsFromProjectRole
in interface JiraSoapService
RemoteException
public void updateProjectRole(java.lang.String token, RemoteProjectRole projectRole) throws RemoteException
updateProjectRole
in interface JiraSoapService
RemoteException
public RemoteProjectRoleActors getProjectRoleActors(java.lang.String token, RemoteProjectRole projectRole, RemoteProject project) throws RemoteException
getProjectRoleActors
in interface JiraSoapService
RemoteException
public RemoteRoleActors getDefaultRoleActors(java.lang.String token, RemoteProjectRole projectRole) throws RemoteException
getDefaultRoleActors
in interface JiraSoapService
RemoteException
public void addDefaultActorsToProjectRole(java.lang.String token, java.lang.String[] actorNames, RemoteProjectRole projectRole, java.lang.String type) throws RemoteException
addDefaultActorsToProjectRole
in interface JiraSoapService
RemoteException
public void removeDefaultActorsFromProjectRole(java.lang.String token, java.lang.String[] actors, RemoteProjectRole projectRole, java.lang.String actorType) throws RemoteException
removeDefaultActorsFromProjectRole
in interface JiraSoapService
RemoteException
public void removeAllRoleActorsByNameAndType(java.lang.String token, java.lang.String name, java.lang.String type) throws RemoteException
removeAllRoleActorsByNameAndType
in interface JiraSoapService
RemoteException
public void removeAllRoleActorsByProject(java.lang.String token, RemoteProject project) throws RemoteException
removeAllRoleActorsByProject
in interface JiraSoapService
RemoteException
public RemoteScheme[] getAssociatedNotificationSchemes(java.lang.String token, RemoteProjectRole projectRole) throws RemoteException
getAssociatedNotificationSchemes
in interface JiraSoapService
RemoteException
public RemoteScheme[] getAssociatedPermissionSchemes(java.lang.String token, RemoteProjectRole projectRole) throws RemoteException
getAssociatedPermissionSchemes
in interface JiraSoapService
RemoteException
public void releaseVersion(java.lang.String token, java.lang.String projectKey, RemoteVersion remoteVersion) throws RemoteException
releaseVersion
in interface JiraSoapService
RemoteException
public void archiveVersion(java.lang.String token, java.lang.String projectKey, java.lang.String versionName, boolean archive) throws RemoteException
archiveVersion
in interface JiraSoapService
RemoteException
public RemoteWorklog addWorklogAndAutoAdjustRemainingEstimate(java.lang.String token, java.lang.String issueKey, RemoteWorklog remoteWorklog) throws RemoteException
JiraSoapService
addWorklogAndAutoAdjustRemainingEstimate
in interface JiraSoapService
token
- the SOAP authentication token.issueKey
- the key of the issue.remoteWorklog
- the worklog to add.
RemoteException
- If there was some problem preventing the operation from working.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.public RemoteWorklog addWorklogAndRetainRemainingEstimate(java.lang.String token, java.lang.String issueKey, RemoteWorklog remoteWorklog) throws RemoteException
JiraSoapService
addWorklogAndRetainRemainingEstimate
in interface JiraSoapService
token
- the SOAP authentication token.issueKey
- the key of the issue.remoteWorklog
- the worklog to add.
RemoteException
- If there was some problem preventing the operation from working.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.public RemoteWorklog addWorklogWithNewRemainingEstimate(java.lang.String token, java.lang.String issueKey, RemoteWorklog remoteWorklog, java.lang.String newRemainingEstimate) throws RemoteException
JiraSoapService
addWorklogWithNewRemainingEstimate
in interface JiraSoapService
token
- the SOAP authentication token.issueKey
- the key of the issue.remoteWorklog
- the worklog to add.newRemainingEstimate
- the new value for the issue's remaining estimate as a duration string, eg 1d 2h.
RemoteException
- If there was some problem preventing the operation from working.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.public RemoteWorklog[] getWorklogs(java.lang.String token, java.lang.String issueKey) throws RemoteException
JiraSoapService
getWorklogs
in interface JiraSoapService
token
- the SOAP authentication token.issueKey
- the key of the issue.
RemoteException
- If there was some problem preventing the operation from working.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.public void deleteWorklogAndAutoAdjustRemainingEstimate(java.lang.String token, java.lang.String worklogId) throws RemoteException
JiraSoapService
deleteWorklogAndAutoAdjustRemainingEstimate
in interface JiraSoapService
token
- the SOAP authentication token.worklogId
- the id of the worklog to delete.
RemoteException
- If there was some problem preventing the operation from working.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.public void deleteWorklogAndRetainRemainingEstimate(java.lang.String token, java.lang.String worklogId) throws RemoteException
JiraSoapService
deleteWorklogAndRetainRemainingEstimate
in interface JiraSoapService
token
- the SOAP authentication token.worklogId
- the id of the worklog to delete.
RemoteException
- If there was some problem preventing the operation from working.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.public void deleteWorklogWithNewRemainingEstimate(java.lang.String token, java.lang.String worklogId, java.lang.String newRemainingEstimate) throws RemoteException
JiraSoapService
deleteWorklogWithNewRemainingEstimate
in interface JiraSoapService
token
- the SOAP authentication token.worklogId
- the id of the worklog to delete.newRemainingEstimate
- the new value for the issue's remaining estimate as a duration string, eg 1d 2h.
RemoteException
- If there was some problem preventing the operation from working.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.public void updateWorklogAndAutoAdjustRemainingEstimate(java.lang.String token, RemoteWorklog remoteWorklog) throws RemoteException
JiraSoapService
updateWorklogAndAutoAdjustRemainingEstimate
in interface JiraSoapService
token
- the SOAP authentication token.remoteWorklog
- the worklog to update.
RemoteException
- If there was some problem preventing the operation from working.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.public void updateWorklogAndRetainRemainingEstimate(java.lang.String token, RemoteWorklog remoteWorklog) throws RemoteException
JiraSoapService
updateWorklogAndRetainRemainingEstimate
in interface JiraSoapService
token
- the SOAP authentication token.remoteWorklog
- the worklog to update.
RemoteException
- If there was some problem preventing the operation from working.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.public void updateWorklogWithNewRemainingEstimate(java.lang.String token, RemoteWorklog remoteWorklog, java.lang.String newRemainingEstimate) throws RemoteException
JiraSoapService
updateWorklogWithNewRemainingEstimate
in interface JiraSoapService
token
- the SOAP authentication token.remoteWorklog
- the worklog to update.newRemainingEstimate
- the new value for the issue's remaining estimate as a duration string, eg 1d 2h.
RemoteException
- If there was some problem preventing the operation from working.
RemotePermissionException
- If the user is not permitted to perform this operation in this context.
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.public boolean hasPermissionToCreateWorklog(java.lang.String token, java.lang.String issueKey) throws RemoteException
JiraSoapService
hasPermissionToCreateWorklog
in interface JiraSoapService
token
- the SOAP authentication token.issueKey
- the key of the issue.
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.
RemoteException
- If there was some problem preventing the operation from working.public boolean hasPermissionToDeleteWorklog(java.lang.String token, java.lang.String worklogId) throws RemoteException
JiraSoapService
hasPermissionToDeleteWorklog
in interface JiraSoapService
token
- the SOAP authentication token.worklogId
- the id of the worklog wishes to delete.
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.
RemoteException
- If there was some problem preventing the operation from working.public boolean hasPermissionToUpdateWorklog(java.lang.String token, java.lang.String worklogId) throws RemoteException
JiraSoapService
hasPermissionToUpdateWorklog
in interface JiraSoapService
token
- the SOAP authentication token.worklogId
- the ide of the worklog wishes to update.
RemoteValidationException
- If the arguments and their properties are incomplete or malformed.
RemoteException
- If there was some problem preventing the operation from working.public RemoteSecurityLevel getSecurityLevel(java.lang.String token, java.lang.String issueKey) throws RemoteException, RemotePermissionException
JiraSoapService
getSecurityLevel
in interface JiraSoapService
token
- the SOAP authentication tokenissueKey
- the issue key
RemoteException
- If there was some problem preventing the operation from working.
RemotePermissionException
- If the issue key is invalid or the user is not permitted to see this issue.public RemoteSecurityLevel[] getSecurityLevels(java.lang.String token, java.lang.String projectKey) throws RemoteException, RemotePermissionException
JiraSoapService
getSecurityLevels
in interface JiraSoapService
token
- the SOAP authentication tokenprojectKey
- the key for the project
RemoteException
- If the project key is invalid
RemotePermissionException
- If you do not have Browse permission for the projectpublic RemoteAvatar[] getProjectAvatars(java.lang.String token, java.lang.String projectKey, boolean includeSystemAvatars) throws RemoteException, RemotePermissionException
JiraSoapService
getProjectAvatars
in interface JiraSoapService
token
- the SOAP authentication tokenprojectKey
- the key for the project.includeSystemAvatars
- if false, only custom avatars will be included in the returned array.
RemoteException
- If the project key is invalid.
RemotePermissionException
- If you do not have Browse permission for the project.public void setNewProjectAvatar(java.lang.String token, java.lang.String projectKey, java.lang.String contentType, java.lang.String base64ImageData) throws RemoteException, RemotePermissionException
JiraSoapService
setNewProjectAvatar
in interface JiraSoapService
token
- the SOAP authentication tokenprojectKey
- the key for the project.contentType
- the MIME type of the image provided, e.g. image/gif, image/jpeg, image/png.base64ImageData
- a base 64 encoded image, 48 pixels square.
RemoteException
- If the project key is invalid.
RemotePermissionException
- If you do not have project admin permission for the project.public void setProjectAvatar(java.lang.String token, java.lang.String projectKey, java.lang.Long avatarId) throws RemoteException, RemotePermissionException
JiraSoapService
setProjectAvatar
in interface JiraSoapService
token
- the SOAP authentication tokenprojectKey
- the key for the project.avatarId
- the id of an existing avatar to use for the project or null for the default avatar.
RemoteException
- If the project key is invalid.
RemotePermissionException
- If you do not have project admin permission for the project.public RemoteAvatar getProjectAvatar(java.lang.String token, java.lang.String projectKey) throws RemoteException, RemotePermissionException
JiraSoapService
getProjectAvatar
in interface JiraSoapService
token
- the SOAP authentication tokenprojectKey
- the key for the project.
RemoteException
- If the project key is invalid.
RemotePermissionException
- If you do not have Browse permission for the project.public void deleteProjectAvatar(java.lang.String token, long avatarId) throws RemoteException
JiraSoapService
deleteProjectAvatar
in interface JiraSoapService
token
- the SOAP authentication tokenavatarId
- id of the custom avatar to delete.
RemoteException
- if there is no avatar with the given id, or if it is a system avatar.
RemotePermissionException
- If you do not have administer permission for the project.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |