Package net.ognetwork.ogcore.api.models

Enum Party.ResultStatus

java.lang.Object

java.lang.Enum<Party.ResultStatus>

net.ognetwork.ogcore.api.models.Party.ResultStatus

All Implemented Interfaces:

Serializable, Comparable<Party.ResultStatus>, java.lang.constant.Constable

Enclosing class:

Party

public static enum Party.ResultStatus
extends Enum<Party.ResultStatus>

The possible results of different actions performed by users.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALREADY_INVITED	Indicates that the inviteePlayer was already invited to the party.
IS_LEADER	Indicates that the action cannot be performed since the acting user is the party leader.
IS_MEMBER	Indicates that the a player is already a member.
NO_PERMISSION	Indicates that the actingPlayer did not have permission to perform the action.
NOT_INVITED	Indicates that the inviteePlayer has no invite to the current party.
OK	Indicates that everything worked correctly.
PARTY_FULL	Indicates that the party is full and has no free member slots available.
UNKNOWN_FAIL	Indicates that something unknown happened.

Method Summary

Modifier and Type	Method	Description
static Party.ResultStatus	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Party.ResultStatus[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

OK

public static final Party.ResultStatus OK

Indicates that everything worked correctly.

NO_PERMISSION

public static final Party.ResultStatus NO_PERMISSION

Indicates that the actingPlayer did not have permission to perform the action.

PARTY_FULL

public static final Party.ResultStatus PARTY_FULL

Indicates that the party is full and has no free member slots available.

IS_LEADER

public static final Party.ResultStatus IS_LEADER

Indicates that the action cannot be performed since the acting user is the party leader.

IS_MEMBER

public static final Party.ResultStatus IS_MEMBER

Indicates that the a player is already a member.

ALREADY_INVITED

public static final Party.ResultStatus ALREADY_INVITED

Indicates that the inviteePlayer was already invited to the party.

NOT_INVITED

public static final Party.ResultStatus NOT_INVITED

Indicates that the inviteePlayer has no invite to the current party.

UNKNOWN_FAIL

public static final Party.ResultStatus UNKNOWN_FAIL

Indicates that something unknown happened.

Method Details

values

public static Party.ResultStatus[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Party.ResultStatus valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null