Package dev.getelements.elements.sdk.service.mission

Interface MissionService

All Known Implementing Classes:

AnonMissionService, SuperUserMissionService

public interface MissionService

Method Summary

Modifier and Type	Method	Description
Mission	createMission(Mission mission)	Creates a new Mission.
void	deleteMission(String missionNameOrId)	Deletes the Mission with the supplied id or name.
Mission	getMissionByNameOrId(String missionNameOrId)	Gets a mission with specified name or ID.
Pagination<Mission>	getMissions(int offset, int count, String query)	Returns a list of Mission objects.
Pagination<Mission>	getMissions(int offset, int count, List<String> tags)	Returns a list of Mission objects.
Mission	updateMission(Mission mission)	Updates the Mission.

Method Details

getMissions

Pagination<Mission> getMissions(int offset,
 int count,
 List<String> tags)

Returns a list of Mission objects.

Parameters:

offset - the offset

count - the count

tags - the search query

Returns:

the list of Mission instances

getMissions

Pagination<Mission> getMissions(int offset,
 int count,
 String query)

Returns a list of Mission objects.

Parameters:

offset - the offset

count - the count

query - the search query

Returns:

the list of Mission instances

getMissionByNameOrId

Mission getMissionByNameOrId(String missionNameOrId)

Gets a mission with specified name or ID.

Parameters:

missionNameOrId - the UserId

Returns:

the mission

updateMission

Mission updateMission(Mission mission)

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

Parameters:

mission - the Mission to update

Returns:

the Mission as it was written to the database

createMission

Mission createMission(Mission mission)

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

Parameters:

mission - the Mission to create

Returns:

the Mission as it was created by the service.

deleteMission

void deleteMission(String missionNameOrId)

Deletes the Mission with the supplied id or name.

Parameters:

missionNameOrId - the mission name or ID.