Package com.tapkey.mobile.model

Enum CommandResult.UserCommandResult.UserCommandResultCode

java.lang.Object

java.lang.Enum<CommandResult.UserCommandResult.UserCommandResultCode>

com.tapkey.mobile.model.CommandResult.UserCommandResult.UserCommandResultCode

All Implemented Interfaces:

Serializable, Comparable<CommandResult.UserCommandResult.UserCommandResultCode>

Enclosing class:

CommandResult.UserCommandResult

public static enum CommandResult.UserCommandResult.UserCommandResultCode
extends Enum<CommandResult.UserCommandResult.UserCommandResultCode>

Represents a user command's result code. The result codes in this enum are sorted by priority.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AsyncResponse	The result is still pending.
BindingError	The binding of the key does not match the lock's binding.
Jammed	Mechanical error on the lock
LockCommunicationError	An error occurred while communicating with the locking device.
LockDateTimeInvalid	Lock date/time are invalid.
LockNotFullyAssembled	The lock is not fully assembled.
NothingToDo	The command was successfully received, but not executed.
NotLicensed	The lock has no active license
Ok	Command executed as requested.
ReauthenticationRequired	The authentication information isn't valid anymore.
ServerCommunicationError	A technical error occurred when trying to communicate with the Tapkey Trust Service.
TechnicalError	Some unspecific technical error has occurred.
TemporarilyUnauthorized	The key is valid but access is denied due to ICAL restrictions of the grant.
Unauthorized	The user is not authorized for the given command on this locking device.
UnauthorizedAtThisTime	The present key is considered not yet valid or expired.

Method Summary

Modifier and Type	Method	Description
static CommandResult.UserCommandResult.UserCommandResultCode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CommandResult.UserCommandResult.UserCommandResultCode[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Ok

public static final CommandResult.UserCommandResult.UserCommandResultCode Ok

Command executed as requested.

NothingToDo

public static final CommandResult.UserCommandResult.UserCommandResultCode NothingToDo

The command was successfully received, but not executed. There is nothing to do. The intended achievement is already fulfilled.

AsyncResponse

public static final CommandResult.UserCommandResult.UserCommandResultCode AsyncResponse

The result is still pending.

Unauthorized

public static final CommandResult.UserCommandResult.UserCommandResultCode Unauthorized

The user is not authorized for the given command on this locking device.

ServerCommunicationError

public static final CommandResult.UserCommandResult.UserCommandResultCode ServerCommunicationError

A technical error occurred when trying to communicate with the Tapkey Trust Service.

LockCommunicationError

public static final CommandResult.UserCommandResult.UserCommandResultCode LockCommunicationError

An error occurred while communicating with the locking device.

BindingError

public static final CommandResult.UserCommandResult.UserCommandResultCode BindingError

The binding of the key does not match the lock's binding.

UnauthorizedAtThisTime

public static final CommandResult.UserCommandResult.UserCommandResultCode UnauthorizedAtThisTime

The present key is considered not yet valid or expired. This error is not imposed by ICAL restrictions of the corresponding grant.

TemporarilyUnauthorized

public static final CommandResult.UserCommandResult.UserCommandResultCode TemporarilyUnauthorized

The key is valid but access is denied due to ICAL restrictions of the grant. See the corresponding grant for more information.

LockNotFullyAssembled

public static final CommandResult.UserCommandResult.UserCommandResultCode LockNotFullyAssembled

The lock is not fully assembled. Certain types of locks may ship in multiple parts and need to be assembled before use.

TechnicalError

public static final CommandResult.UserCommandResult.UserCommandResultCode TechnicalError

Some unspecific technical error has occurred.

ReauthenticationRequired

public static final CommandResult.UserCommandResult.UserCommandResultCode ReauthenticationRequired

The authentication information isn't valid anymore. Reauthentication is required.

LockDateTimeInvalid

public static final CommandResult.UserCommandResult.UserCommandResultCode LockDateTimeInvalid

Lock date/time are invalid.

NotLicensed

public static final CommandResult.UserCommandResult.UserCommandResultCode NotLicensed

The lock has no active license

Jammed

public static final CommandResult.UserCommandResult.UserCommandResultCode Jammed

Mechanical error on the lock

Method Detail

values

public static CommandResult.UserCommandResult.UserCommandResultCode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CommandResult.UserCommandResult.UserCommandResultCode c : CommandResult.UserCommandResult.UserCommandResultCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static CommandResult.UserCommandResult.UserCommandResultCode 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