ch.aaap.harvestclient.api

Interface UsersApi

All Known Implementing Classes:

UsersApiImpl

public interface UsersApi

Method Summary

Modifier and Type	Method and Description
User	create(UserCreationInfo creationInfo) Create a new User.
void	delete(long userId) Delete a user.
void	delete(User user) Delete a user.
User	get(long userId) Retrieve an existing user
User	getSelf() Retrieve the currently authenticated user
java.util.List<User>	list() Returns a list of your users.
User	update(long userId, UserInfo userInfo) Change an existing user.

Method Detail

list

java.util.List<User> list()

Returns a list of your users. The users are returned sorted by creation date, with the most recently created users appearing first.

Returns:

a list of all users

create

User create(UserCreationInfo creationInfo)

Create a new User. First name, last name and email are required.

Parameters:

creationInfo - information about the new user.

Returns:

the User that was just created

getSelf

User getSelf()

Retrieve the currently authenticated user

Returns:

the currently authenticated user

get

User get(long userId)

Retrieve an existing user

Parameters:

userId - the id of an existing user

Returns:

the full User object

update

User update(long userId,
            UserInfo userInfo)

Change an existing user.

Parameters:

userId - the id of the user to be changed

userInfo - contains all the properties to be changed

Returns:

the updated User

delete

void delete(long userId)

Delete a user. Deleting a user is only possible if they have no time entries or expenses associated with them

Parameters:

userId - the id of the user to be deleted

delete

void delete(User user)

Delete a user. Deleting a user is only possible if they have no time entries or expenses associated with them

Parameters:

user - the user to be deleted