ch.aaap.harvestclient.impl

Class TimesheetsApiImpl

Object

ch.aaap.harvestclient.impl.TimesheetsApiImpl

All Implemented Interfaces:

Api.Get<TimeEntry>, TimesheetsApi

public class TimesheetsApiImpl
extends Object
implements TimesheetsApi

Constructor Summary

Constructors

Constructor and Description
TimesheetsApiImpl(TimeEntryService timeEntryService)

Method Summary

Modifier and Type	Method and Description
TimeEntry	create(TimeEntryCreationInfoDuration creationInfo) Create a TimeEntry with a duration.
TimeEntry	create(TimeEntryCreationInfoTimestamp creationInfo) Create a TimeEntry with a started time.
void	delete(Reference<TimeEntry> timeEntryReference) Delete an existing TimeEntry
TimeEntry	get(Reference<TimeEntry> timeEntryReference) Retrieve an existing TimeEntry
List<TimeEntry>	list(TimeEntryFilter filter) Return a list of all TimeEntries, filtered by the TimeEntryFilter, sorted by creation date, newest first.
Pagination<TimeEntry>	list(TimeEntryFilter filter, int page, int perPage) Return a list of all TimeEntries, filtered by the TimeEntryFilter, sorted by creation date, newest first.
TimeEntry	restart(Reference<TimeEntry> timeEntryReference) Restart a TimeEntry.
TimeEntry	stop(Reference<TimeEntry> timeEntryReference) Stop a TimeEntry.
TimeEntry	update(Reference<TimeEntry> timeEntryReference, TimeEntryUpdateInfo updatedInfo) Modify an existing TimeEntry.

Methods inherited from class Object

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

Constructor Detail

TimesheetsApiImpl

public TimesheetsApiImpl(TimeEntryService timeEntryService)

Method Detail

list

public List<TimeEntry> list(TimeEntryFilter filter)

Description copied from interface: TimesheetsApi

Return a list of all TimeEntries, filtered by the TimeEntryFilter, sorted by creation date, newest first.

Specified by:

list in interface TimesheetsApi

Parameters:

filter - filtering options

Returns:

a list of all matching TimeEntry, newest first.

list

public Pagination<TimeEntry> list(TimeEntryFilter filter,
                                  int page,
                                  int perPage)

Description copied from interface: TimesheetsApi

Return a list of all TimeEntries, filtered by the TimeEntryFilter, sorted by creation date, newest first. Page and perPage allow controlling how many results to return.

Specified by:

list in interface TimesheetsApi

Parameters:

filter - filtering options

page - the page number

perPage - how many results to return for one page. Max 100

Returns:

a list of all matching TimeEntry, newest first.

get

public TimeEntry get(Reference<TimeEntry> timeEntryReference)

Description copied from interface: TimesheetsApi

Retrieve an existing TimeEntry

Specified by:

get in interface Api.Get<TimeEntry>

Specified by:

get in interface TimesheetsApi

Parameters:

timeEntryReference - a reference to an the timeentry to retrieve

Returns:

a Full TimeEntry object

create

public TimeEntry create(TimeEntryCreationInfoDuration creationInfo)

Description copied from interface: TimesheetsApi

Create a TimeEntry with a duration. If no duration is given, the TimeEntry will be running, otherwise it will not be.

Specified by:

create in interface TimesheetsApi

Parameters:

creationInfo - creation options

Returns:

the created TimeEntry

See Also:

TimeEntryCreationInfoDuration

create

public TimeEntry create(TimeEntryCreationInfoTimestamp creationInfo)

Description copied from interface: TimesheetsApi

Create a TimeEntry with a started time. The Entry will be running after if a startTime has been given.

Specified by:

create in interface TimesheetsApi

Parameters:

creationInfo - creation options

Returns:

the created TimeEntry

See Also:

TimeEntryCreationInfoTimestamp

update

public TimeEntry update(Reference<TimeEntry> timeEntryReference,
                        TimeEntryUpdateInfo updatedInfo)

Description copied from interface: TimesheetsApi

Modify an existing TimeEntry.

Specified by:

update in interface TimesheetsApi

Parameters:

timeEntryReference - the existing TimeEntry to be modified

updatedInfo - the changes to be done

Returns:

the updated TimeEntry

See Also:

TimesheetsApi.stop(Reference), TimesheetsApi.restart(Reference)

delete

public void delete(Reference<TimeEntry> timeEntryReference)

Description copied from interface: TimesheetsApi

Delete an existing TimeEntry

Specified by:

delete in interface TimesheetsApi

Parameters:

timeEntryReference - a reference to the TimeEntry to be deleted

restart

public TimeEntry restart(Reference<TimeEntry> timeEntryReference)

Description copied from interface: TimesheetsApi

Restart a TimeEntry. Only possible if it is not running

Specified by:

restart in interface TimesheetsApi

Parameters:

timeEntryReference - a reference to the TimeEntry to be restarted

Returns:

the modified TimeEntry

stop

public TimeEntry stop(Reference<TimeEntry> timeEntryReference)

Description copied from interface: TimesheetsApi

Stop a TimeEntry. Only possible if it is running

Specified by:

stop in interface TimesheetsApi

Parameters:

timeEntryReference - a reference to the TimeEntry to be stopped

Returns:

the modified TimeEntry