ch.aaap.harvestclient.api

Interface TimesheetsApi

All Superinterfaces:

Api.Get<TimeEntry>

All Known Implementing Classes:

TimesheetsApiImpl

public interface TimesheetsApi
extends Api.Get<TimeEntry>

See Also:

Time Entries API on Harvest

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.

Method Detail

list

List<TimeEntry> list(TimeEntryFilter filter)

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

Parameters:

filter - filtering options

Returns:

a list of all matching TimeEntry, newest first.

list

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. Page and perPage allow controlling how many results to return.

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

TimeEntry get(Reference<TimeEntry> timeEntryReference)

Retrieve an existing TimeEntry

Specified by:

get in interface Api.Get<TimeEntry>

Parameters:

timeEntryReference - a reference to an the timeentry to retrieve

Returns:

a Full TimeEntry object

create

TimeEntry create(TimeEntryCreationInfoDuration creationInfo)

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

Parameters:

creationInfo - creation options

Returns:

the created TimeEntry

See Also:

TimeEntryCreationInfoDuration

create

TimeEntry create(TimeEntryCreationInfoTimestamp creationInfo)

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

Parameters:

creationInfo - creation options

Returns:

the created TimeEntry

See Also:

TimeEntryCreationInfoTimestamp

update

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

Modify an existing TimeEntry.

Parameters:

timeEntryReference - the existing TimeEntry to be modified

updatedInfo - the changes to be done

Returns:

the updated TimeEntry

See Also:

stop(Reference), restart(Reference)

delete

void delete(Reference<TimeEntry> timeEntryReference)

Delete an existing TimeEntry

Parameters:

timeEntryReference - a reference to the TimeEntry to be deleted

restart

TimeEntry restart(Reference<TimeEntry> timeEntryReference)

Restart a TimeEntry. Only possible if it is not running

Parameters:

timeEntryReference - a reference to the TimeEntry to be restarted

Returns:

the modified TimeEntry

stop

TimeEntry stop(Reference<TimeEntry> timeEntryReference)

Stop a TimeEntry. Only possible if it is running

Parameters:

timeEntryReference - a reference to the TimeEntry to be stopped

Returns:

the modified TimeEntry