Package dev.getelements.elements.sdk.service.progress

Interface ProgressService

All Known Implementing Classes:

SuperUserProgressService, UserProgressService

public interface ProgressService

Method Summary

Modifier and Type	Method	Description
Progress	createProgress(Progress progress)	Creates a new Progress.
void	deleteProgress(String progressNameOrId)	Deletes the Progress with the supplied id or name.
Progress	getProgress(String progressId)	Gets a progress with specified name or ID.
Pagination<Progress>	getProgresses(int offset, int count, List<String> tags)	Returns a list of Progress objects.
Pagination<Progress>	getProgresses(int offset, int count, List<String> tags, String query)	Returns a list of Progress objects.
Tabulation<ProgressRow>	getProgressesTabular()	Gets a Tabulation<ProgressRow> complete with the tabular data for that row.
Progress	updateProgress(Progress progress)	Updates the Progress.

Method Details

getProgresses

Pagination<Progress> getProgresses(int offset,
 int count,
 List<String> tags)

Returns a list of Progress objects.

Parameters:

offset - the offset

count - the count

tags -

Returns:

the list of Progress instances

getProgresses

Pagination<Progress> getProgresses(int offset,
 int count,
 List<String> tags,
 String query)

Returns a list of Progress objects.

Parameters:

offset - the offset

count - the count

tags -

query - the search query

Returns:

the list of Progress instances

getProgressesTabular

Tabulation<ProgressRow> getProgressesTabular()

Gets a Tabulation<ProgressRow> complete with the tabular data for that row.

Returns:

the progress in a tabular fashion.

getProgress

Progress getProgress(String progressId)

Gets a progress with specified name or ID.

Parameters:

progressId - the UserId

Returns:

the progress

updateProgress

Progress updateProgress(Progress progress)

Updates the Progress. The Progress.getId() method is used to key the Progress.

Parameters:

progress - the Progress to update

Returns:

the Progress as it was written to the database

createProgress

Progress createProgress(Progress progress)

Creates a new Progress. The ID of the progress, as specified by Progress.getId(), should be null and will be assigned.

Parameters:

progress - the Progress to create

Returns:

the Progress as it was created by the service.

deleteProgress

void deleteProgress(String progressNameOrId)

Deletes the Progress with the supplied id or name.

Parameters:

progressNameOrId - the progress name or ID.