Package dev.getelements.elements.sdk.dao

Interface MultiMatchDao

All Known Implementing Classes:

MongoMultiMatchDao

public interface MultiMatchDao

Handles multi-matches, allowing multiple players to join or leave a match.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MULTI_MATCH_ADD_PROFILE
static final String	MULTI_MATCH_CREATED
static final String	MULTI_MATCH_DELETED
static final String	MULTI_MATCH_EXPIRED
static final String	MULTI_MATCH_REMOVE_PROFILE
static final String	MULTI_MATCH_UPDATED

Method Summary

Modifier and Type	Method	Description
MultiMatch	addProfile(String multiMatchId, Profile profile)	Adds a new Profile to the MultiMatch.
MultiMatch	createMultiMatch(MultiMatch multiMatch)	Creates a new MultiMatch with no players.
default void	deleteMultiMatch(String multiMatchId)	Deletes the MultiMatch with the given ID, throwing an exception if it does not exist.
default void	expireMultiMatch(String multiMatchId)	Expires a MultiMatch by its ID, setting its status to expired flagging it for removal at a later date.
Optional<MultiMatch>	findMultiMatch(String multiMatchId)	Finds a MultiMatch by its ID.
default List<MultiMatch>	getAllMultiMatches()	Gets all MultiMatch instances.
List<MultiMatch>	getAllMultiMatches(String query)	Gets all MultiMatch instances.
default MultiMatch	getMultiMatch(String multiMatchId)	Gets a MultiMatch by its ID.
List<Profile>	getProfiles(String multiMatchId)	Gets all Profile instances in the MultiMatch.
MultiMatch	removeProfile(String multiMatchId, Profile profile)	Removes the Profile to the MultiMatch.
boolean	tryDeleteMultiMatch(String multiMatchId)	Deletes the MultiMatch with the given ID, returning true if it was deleted, false if it did not exist.
boolean	tryExpireMultiMatch(String multiMatchId)	Expires a MultiMatch by its ID, setting its status to expired flagging it for removal at a later date.
MultiMatch	updateMultiMatch(MultiMatch configuration)	Creates a new MultiMatch with no players.

Field Details

MULTI_MATCH_CREATED

static final String MULTI_MATCH_CREATED

See Also:

• Constant Field Values

MULTI_MATCH_ADD_PROFILE

static final String MULTI_MATCH_ADD_PROFILE

See Also:

• Constant Field Values

MULTI_MATCH_REMOVE_PROFILE

static final String MULTI_MATCH_REMOVE_PROFILE

See Also:

• Constant Field Values

MULTI_MATCH_UPDATED

static final String MULTI_MATCH_UPDATED

See Also:

• Constant Field Values

MULTI_MATCH_EXPIRED

static final String MULTI_MATCH_EXPIRED

See Also:

• Constant Field Values

MULTI_MATCH_DELETED

static final String MULTI_MATCH_DELETED

See Also:

• Constant Field Values

Method Details

getAllMultiMatches

default List<MultiMatch> getAllMultiMatches()

Gets all MultiMatch instances.

Returns:

a List of MultiMatch instances

getAllMultiMatches

List<MultiMatch> getAllMultiMatches(String query)

Gets all MultiMatch instances.

Parameters:

query - the query to execute

Returns:

a List of MultiMatch instances

findMultiMatch

Optional<MultiMatch> findMultiMatch(String multiMatchId)

Finds a MultiMatch by its ID.

Parameters:

multiMatchId - the ID of the multi-match to find.

Returns:

the found MultiMatch, or an empty Optional if not found.

getMultiMatch

default MultiMatch getMultiMatch(String multiMatchId)

Gets a MultiMatch by its ID.

Parameters:

multiMatchId - the MultiMatch

Returns:

the MultiMatch

getProfiles

List<Profile> getProfiles(String multiMatchId)

Gets all Profile instances in the MultiMatch.

Parameters:

multiMatchId - tbe multi-match id to get profiles from

Returns:

the List of Profile instances in the MultiMatch

Throws:

MultiMatchNotFoundException - if no MultiMatch with the given ID exists

addProfile

MultiMatch addProfile(String multiMatchId,
 Profile profile)

Adds a new Profile to the MultiMatch.

Parameters:

multiMatchId - the multi-match id receiving the profile

profile - the profile to add

Returns:

the updated MultiMatch

removeProfile

MultiMatch removeProfile(String multiMatchId,
 Profile profile)

Removes the Profile to the MultiMatch.

Parameters:

multiMatchId - the multi-match id receiving the profile

profile - the profile to add

Returns:

the updated MultiMatch

createMultiMatch

MultiMatch createMultiMatch(MultiMatch multiMatch)

Creates a new MultiMatch with no players.

Parameters:

multiMatch - the MultiMatch to create

Returns:

the newly created MultiMatch

updateMultiMatch

MultiMatch updateMultiMatch(MultiMatch configuration)

Creates a new MultiMatch with no players.

Parameters:

configuration - the MatchmakingApplicationConfiguration to use

Returns:

the newly created MultiMatch

deleteMultiMatch

default void deleteMultiMatch(String multiMatchId)

Deletes the MultiMatch with the given ID, throwing an exception if it does not exist.

tryDeleteMultiMatch

boolean tryDeleteMultiMatch(String multiMatchId)

Deletes the MultiMatch with the given ID, returning true if it was deleted, false if it did not exist.

expireMultiMatch

default void expireMultiMatch(String multiMatchId)

Expires a MultiMatch by its ID, setting its status to expired flagging it for removal at a later date.

Parameters:

multiMatchId - the ID of the MultiMatch

Throws:

MultiMatchNotFoundException - if the multi-match does not exist or is already expired.

tryExpireMultiMatch

boolean tryExpireMultiMatch(String multiMatchId)

Expires a MultiMatch by its ID, setting its status to expired flagging it for removal at a later date.

Parameters:

multiMatchId - the ID of the MultiMatch

Returns:

true if the multi-match was expired, false if it did not exist or was already expired.