net.luckperms.api.track

Interface PromotionResult

All Superinterfaces:

Result

public interface PromotionResult
extends Result

Encapsulates the result of Users promotion along a Track.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PromotionResult.Status The result status

Field Summary

Fields inherited from interface net.luckperms.api.util.Result

GENERIC_FAILURE, GENERIC_SUCCESS

Method Summary

Modifier and Type	Method and Description
@NonNull Optional<String>	getGroupFrom() Gets the name of the group the user was promoted from, if applicable.
@NonNull Optional<String>	getGroupTo() Gets the name of the group the user was promoted from, if applicable.
@NonNull PromotionResult.Status	getStatus() Gets the status of the result.
default boolean	wasSuccessful() Gets if the operation which produced this result completed successfully.

Method Detail

getStatus

@NonNull PromotionResult.Status getStatus()

Gets the status of the result.

Returns:

the status

wasSuccessful

default boolean wasSuccessful()

Description copied from interface: Result

Gets if the operation which produced this result completed successfully.

Specified by:

wasSuccessful in interface Result

Returns:

if the result indicates a success

getGroupFrom

@NonNull Optional<String> getGroupFrom()

Gets the name of the group the user was promoted from, if applicable.

Will only be present for results with a status of PromotionResult.Status.SUCCESS.

Returns:

the group the user was promoted from.

getGroupTo

@NonNull Optional<String> getGroupTo()

Gets the name of the group the user was promoted from, if applicable.

Will only be present for results with a status of PromotionResult.Status.SUCCESS or PromotionResult.Status.ADDED_TO_FIRST_GROUP.

The value will also be set for results with the PromotionResult.Status.MALFORMED_TRACK status, with this value marking the group which no longer exists.

Returns:

the group the user was promoted to.