Package dev.getelements.elements.sdk.dao

Interface ProgressDao

All Known Implementing Classes:

MongoProgressDao

public interface ProgressDao

Created by davidjbrooks on 12/05/18.

Method Summary

Modifier and Type	Method	Description
Progress	advanceProgress(Progress progress, int actionsPerformed)	Advances Progress by the specified number of actions.
Progress	createOrGetExistingProgress(Progress progress)	Creates a progress.
void	deleteProgress(String progressId)	Deletes a progress.
Optional<Progress>	findProgress(String progressId)	Gets the progress with the id, or throws a NotFoundException if the progress can't be found.
Optional<Progress>	findProgressForProfileAndMission(Profile profile, String missionNameOrId)	Gets the Progress instance for the supplied Profile and Mission instance.
default Progress	getProgress(String progressId)	Gets the progress with the id, or throws a NotFoundException if the progress can't be found.
Pagination<Progress>	getProgresses(int offset, int count, List<String> tags)	Gets progresses specifying the offset and the count.
Pagination<Progress>	getProgresses(int offset, int count, List<String> tags, String search)	Gets progresses specifying the offset and the count, specifying a search filter.
Pagination<Progress>	getProgresses(Profile profile, int offset, int count, List<String> tags)	Gets progresses specifying the user, offset and the count.
Pagination<Progress>	getProgresses(Profile profile, int offset, int count, List<String> tags, String search)	Gets progresses specifying the user, offset and the count, specifying a search filter.
Tabulation<ProgressRow>	getProgressesTabular()	Gets Progress instances in a tabular fashion.
default Progress	getProgressForProfileAndMission(Profile profile, String missionNameOrId)	Gets the Progress instance for the supplied Profile and Mission instance.
Progress	updateProgress(Progress progress)	Updates the progress, or throws a NotFoundException if the progress can't be found.

Method Details

getProgresses

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

Gets progresses specifying the user, offset and the count.

Parameters:

profile - Profile

offset - the offset

count - the count

tags -

profile - Profile

Returns:

a Pagination of Progress objects.

getProgresses

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

Gets progresses specifying the user, offset and the count, specifying a search filter.

Parameters:

profile - Profile

offset - the offset

count - the count

tags -

search - a query to filter the results

Returns:

a Pagination of Progress objects.

getProgresses

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

Gets progresses specifying the offset and the count.

Parameters:

offset - the offset

count - the count

tags - the tags

Returns:

a Pagination of Progress objects.

getProgresses

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

Gets progresses specifying the offset and the count, specifying a search filter.

Parameters:

offset - the offset

count - the count

tags - the tags

search - a query to filter the results

Returns:

a Pagination of Progress objects.

getProgressesTabular

Tabulation<ProgressRow> getProgressesTabular()

Gets Progress instances in a tabular fashion.

Returns:

a Tabulation of ProgressRow instances

getProgress

default Progress getProgress(String progressId)

Gets the progress with the id, or throws a NotFoundException if the progress can't be found.

Returns:

the Progress that was requested, never null

Throws:

ProgressNotFoundException - if no Progress matches

findProgress

Optional<Progress> findProgress(String progressId)

Gets the progress with the id, or throws a NotFoundException if the progress can't be found.

Returns:

the Progress that was requested, never null

Throws:

ProgressNotFoundException - if no Progress matches

updateProgress

Progress updateProgress(Progress progress)

Updates the progress, or throws a NotFoundException if the progress can't be found. The Progress.getId() is used to key the progress being updated.

Returns:

the Progress as it was written into the database

Throws:

InvalidDataException - if the state of the passed in Progress is invalid

createOrGetExistingProgress

Progress createOrGetExistingProgress(Progress progress)

Creates a progress. The value of Progress.getId() will be ignored.

Returns:

the Progress as it was written into the database

Throws:

InvalidDataException - if the state of the passed in Progress is invalid

DuplicateException - if the passed in Progress has a name that already exists

deleteProgress

void deleteProgress(String progressId)

Deletes a progress.

Parameters:

progressId - the progress ID

advanceProgress

Progress advanceProgress(Progress progress,
 int actionsPerformed)

Advances Progress by the specified number of actions.

Parameters:

progress - the Progress

actionsPerformed - the amount of actions to apply

Returns:

getProgressForProfileAndMission

default Progress getProgressForProfileAndMission(Profile profile,
 String missionNameOrId)

Gets the Progress instance for the supplied Profile and Mission instance.

Parameters:

profile - the Profile linked to the progress

missionNameOrId - the Mission linked to the progress

Returns:

the Progress instances

Throws:

ProgressNotFoundException - if the process cannot be found

findProgressForProfileAndMission

Optional<Progress> findProgressForProfileAndMission(Profile profile,
 String missionNameOrId)

Gets the Progress instance for the supplied Profile and Mission instance.

Parameters:

profile - the Profile linked to the progress

missionNameOrId - the Mission linked to the progress

Returns:

the Progress instances