ch.aaap.harvestclient.impl

Class UsersApiImpl

java.lang.Object

ch.aaap.harvestclient.impl.UsersApiImpl

All Implemented Interfaces:

UsersApi

public class UsersApiImpl
extends java.lang.Object
implements UsersApi

Constructor Summary

Constructors

Constructor and Description
UsersApiImpl(UserService userService)

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UsersApiImpl

public UsersApiImpl(UserService userService)

Method Detail

list

public java.util.List<User> list()

Description copied from interface: UsersApi

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

Specified by:

list in interface UsersApi

Returns:

a list of all users

create

public User create(UserCreationInfo creationInfo)

Description copied from interface: UsersApi

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

Specified by:

create in interface UsersApi

Parameters:

creationInfo - information about the new user.

Returns:

the User that was just created

getSelf

public User getSelf()

Description copied from interface: UsersApi

Retrieve the currently authenticated user

Specified by:

getSelf in interface UsersApi

Returns:

the currently authenticated user

get

public User get(long userId)

Description copied from interface: UsersApi

Retrieve an existing user

Specified by:

get in interface UsersApi

Parameters:

userId - the id of an existing user

Returns:

the full User object

update

public User update(long userId,
                   UserInfo userInfo)

Description copied from interface: UsersApi

Change an existing user.

Specified by:

update in interface UsersApi

Parameters:

userId - the id of the user to be changed

userInfo - contains all the properties to be changed

Returns:

the updated User

delete

public void delete(long userId)

Description copied from interface: UsersApi

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

Specified by:

delete in interface UsersApi

Parameters:

userId - the id of the user to be deleted

delete

public void delete(User user)

Description copied from interface: UsersApi

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

Specified by:

delete in interface UsersApi

Parameters:

user - the user to be deleted