UserService (JIRA RPC - Plugin 4.4 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.atlassian.jira.rpc.soap.service
Interface UserService

All Known Implementing Classes:: UserServiceImpl

public interface UserService

Method Summary
`void`	`addUserToGroup(com.atlassian.crowd.embedded.api.User admin, RemoteGroup group, RemoteUser user)`
`RemoteGroup`	`createGroup(com.atlassian.crowd.embedded.api.User admin, java.lang.String groupName, RemoteUser user)`
`RemoteUser`	`createUser(com.atlassian.crowd.embedded.api.User admin, java.lang.String username, java.lang.String password, java.lang.String fullName, java.lang.String email)`
`void`	`deleteGroup(com.atlassian.crowd.embedded.api.User admin, java.lang.String groupName, java.lang.String swapGroupName)`
`void`	`deleteUser(com.atlassian.crowd.embedded.api.User admin, java.lang.String username)`
`RemoteFilter[]`	`getFavouriteFilters(com.atlassian.crowd.embedded.api.User user)` Returns a list of the passed in users favourite filters.
`RemoteGroup`	`getGroup(com.atlassian.crowd.embedded.api.User admin, java.lang.String groupName)`
`RemoteUser`	`getUser(com.atlassian.crowd.embedded.api.User currentUser, java.lang.String username)`
`void`	`removeUserFromGroup(com.atlassian.crowd.embedded.api.User admin, RemoteGroup group, RemoteUser user)`
`RemoteUser`	`setUserPassword(com.atlassian.crowd.embedded.api.User admin, RemoteUser remoteUser, java.lang.String newPassword)`
`RemoteGroup`	`updateGroup(com.atlassian.crowd.embedded.api.User admin, RemoteGroup group)`
`RemoteUser`	`updateUser(com.atlassian.crowd.embedded.api.User admin, RemoteUser remoteUser)`

Method Detail

getUser

RemoteUser getUser(com.atlassian.crowd.embedded.api.User currentUser,
                   java.lang.String username)

createUser

RemoteUser createUser(com.atlassian.crowd.embedded.api.User admin,
                      java.lang.String username,
                      java.lang.String password,
                      java.lang.String fullName,
                      java.lang.String email)
                      throws RemoteException,
                             RemoteValidationException,
                             RemotePermissionException

Throws:: RemoteException; RemoteValidationException; RemotePermissionException

deleteUser

void deleteUser(com.atlassian.crowd.embedded.api.User admin,
                java.lang.String username)
                throws RemoteException,
                       RemoteValidationException,
                       RemotePermissionException

Throws:: RemoteException; RemoteValidationException; RemotePermissionException

getGroup

RemoteGroup getGroup(com.atlassian.crowd.embedded.api.User admin,
                     java.lang.String groupName)
                     throws RemoteException,
                            RemoteValidationException,
                            RemotePermissionException

Throws:: RemoteException; RemoteValidationException; RemotePermissionException

createGroup

RemoteGroup createGroup(com.atlassian.crowd.embedded.api.User admin,
                        java.lang.String groupName,
                        RemoteUser user)
                        throws RemoteException,
                               RemoteValidationException,
                               RemotePermissionException

Throws:: RemoteException; RemoteValidationException; RemotePermissionException

addUserToGroup

void addUserToGroup(com.atlassian.crowd.embedded.api.User admin,
                    RemoteGroup group,
                    RemoteUser user)
                    throws RemoteException,
                           RemoteValidationException,
                           RemotePermissionException

Throws:: RemoteException; RemoteValidationException; RemotePermissionException

removeUserFromGroup

void removeUserFromGroup(com.atlassian.crowd.embedded.api.User admin,
                         RemoteGroup group,
                         RemoteUser user)
                         throws RemoteException,
                                RemoteValidationException,
                                RemotePermissionException

Throws:: RemoteException; RemoteValidationException; RemotePermissionException

updateGroup

RemoteGroup updateGroup(com.atlassian.crowd.embedded.api.User admin,
                        RemoteGroup group)
                        throws RemoteException,
                               RemoteValidationException,
                               RemotePermissionException

Throws:: RemoteException; RemoteValidationException; RemotePermissionException

deleteGroup

void deleteGroup(com.atlassian.crowd.embedded.api.User admin,
                 java.lang.String groupName,
                 java.lang.String swapGroupName)
                 throws RemoteException,
                        RemoteValidationException,
                        RemotePermissionException

Throws:: RemoteException; RemoteValidationException; RemotePermissionException

getFavouriteFilters

RemoteFilter[] getFavouriteFilters(com.atlassian.crowd.embedded.api.User user)
                                   throws RemoteException

Returns a list of the passed in users favourite filters.

Parameters:: user - The user whose fitlers to retreive
Returns:: A list of filters that the ser a favourited.
Throws:: RemoteException - if a remote exception happens.

updateUser

RemoteUser updateUser(com.atlassian.crowd.embedded.api.User admin,
                      RemoteUser remoteUser)
                      throws RemoteValidationException,
                             RemoteException

Throws:: RemoteValidationException; RemoteException

setUserPassword

RemoteUser setUserPassword(com.atlassian.crowd.embedded.api.User admin,
                           RemoteUser remoteUser,
                           java.lang.String newPassword)
                           throws RemoteValidationException,
                                  RemoteException

Throws:: RemoteValidationException; RemoteException