com.sitewhere.spi.error

Enum ErrorCode

java.lang.Object

java.lang.Enum<ErrorCode>

com.sitewhere.spi.error.ErrorCode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ErrorCode>

public enum ErrorCode
extends java.lang.Enum<ErrorCode>

Enumerates various system error conditions and gives them unique codes.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AssetCategoryIdInUse Attempting to create a new asset category with an id already in use
AssetIdInUse Attempting to create a new asset that conflicts with an existing one
AssetTypeNotAllowed Attempting to create a new asset in a category that does not allow the type
DeuplicateSiteToken Duplicate site token
DeviceAlreadyAssigned Attempting to create a new assignment for a device with an active assignment
DeviceCanNotBeDeletedIfAssigned Attempting to delete a device that is currently assigned
DeviceCommandExists Attempting to create a new command that duplicates an existing command
DeviceElementMappingDoesNotExist Attempting to refrence a device element mapping that does not exist
DeviceElementMappingExists Attempting to create a device element mapping for a path that is already mapped
DeviceHardwareIdCanNotBeChanged Attempting to change the hardware id of an existing device
DeviceNotAssigned Operation assumes device is assigned but no assignment exists
DeviceParentMappingExists Attempting to create a device element mapping for a device that is already mapped
DeviceSiteCanNotBeChangedIfAssigned Attempting to change site for device that is currently assigned
DuplicateAuthority Authority name already used
DuplicateBatchElement Duplicate batch element
DuplicateBatchOperationToken Duplicate batch operation token
DuplicateDeviceAssignment Duplicate device assignment token
DuplicateDeviceGroupToken Duplicate device group token
DuplicateDeviceSpecificationToken Invalid device specification token
DuplicateHardwareId Attempting to create a device with a duplicate hardware id
DuplicateId Generic duplicate id error
DuplicateScheduledJobToken Invalid scheduled job token
DuplicateScheduleToken Invalid schedule token
DuplicateStreamId Attempting to create a device stream with a stream id already in use
DuplicateTenantGroupId Attempting to create a tenant group with an id already in use
DuplicateTenantId Attempting to create a tenant with an id already in use
DuplicateUser Username already used
DuplicateZoneToken Duplicate zone token
GenericDeleteFailed Generic delete failure message
IncompleteData Some required data was missing
InvalidAssetCategoryId Invalid asset category id
InvalidAssetId Invalid asset id
InvalidAssetReferenceId Invalid asset reference id
InvalidAuthority Invalid authority reference
InvalidBatchElement Invalid batch element
InvalidBatchOperationToken Invalid batch operation token
InvalidCharsInStreamId Attempting to create a stream id that contains invalid characters
InvalidDeviceAssignmentId Invalid site assignment id
InvalidDeviceAssignmentToken Invalid device assignment token
InvalidDeviceCommandToken Invalid site token
InvalidDeviceEventId Invalid device event id
InvalidDeviceGroupToken Invalid device group token
InvalidDeviceSlotPath Path references a non-existent slot or a device unit
InvalidDeviceSpecificationToken Invalid device specification token
InvalidHardwareId Invalid device hardware id
InvalidMetadataFieldName Bad username
InvalidPassword Bad password
InvalidScheduledJobToken Invalid scheduled job token
InvalidScheduleToken Invalid schedule token
InvalidSearchProviderId Invalid search provider id
InvalidSiteToken Invalid site token
InvalidStreamId Attempting to access a device stream that does not exist
InvalidTenantAuthToken Invalid tenant authentication token
InvalidTenantEngineCommand Invalid tenant engine command
InvalidTenantEngineId Invalid tenant engine reference
InvalidTenantGroupId Invalid tenant group reference
InvalidTenantId Invalid tenant reference
InvalidTenantTemplateId Invalid tenant template id
InvalidUserInformation One or more required user fields are missing
InvalidUsername Bad username
InvalidZoneToken Invalid zone token
MissingTenantAuthToken Tenant authentication token not passed
NotAuthorizedForTenant Tenant authentication token passed but tenant not authorized for user
NotLoggedIn No user logged in for action that requires authorization
RequiredCommandParameterMissing Operation assumes device is assigned but no assignment exists
Unknown Error with no explanation
UnknownAssetType Reference to an unknown asset type
ZoneDeleteFailed Zone delete failure message

Method Summary

Modifier and Type	Method and Description
static ErrorCode	fromCode(long code) Look up the enum based on error code.
long	getCode()
java.lang.String	getMessage()
void	setCode(long code)
void	setMessage(java.lang.String message)
static ErrorCode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ErrorCode[]	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

InvalidMetadataFieldName

public static final ErrorCode InvalidMetadataFieldName

Bad username

InvalidUsername

public static final ErrorCode InvalidUsername

Bad username

InvalidPassword

public static final ErrorCode InvalidPassword

Bad password

DuplicateUser

public static final ErrorCode DuplicateUser

Username already used

InvalidUserInformation

public static final ErrorCode InvalidUserInformation

One or more required user fields are missing

InvalidAuthority

public static final ErrorCode InvalidAuthority

Invalid authority reference

DuplicateAuthority

public static final ErrorCode DuplicateAuthority

Authority name already used

NotLoggedIn

public static final ErrorCode NotLoggedIn

No user logged in for action that requires authorization

InvalidTenantId

public static final ErrorCode InvalidTenantId

Invalid tenant reference

InvalidTenantAuthToken

public static final ErrorCode InvalidTenantAuthToken

Invalid tenant authentication token

MissingTenantAuthToken

public static final ErrorCode MissingTenantAuthToken

Tenant authentication token not passed

NotAuthorizedForTenant

public static final ErrorCode NotAuthorizedForTenant

Tenant authentication token passed but tenant not authorized for user

InvalidTenantEngineId

public static final ErrorCode InvalidTenantEngineId

Invalid tenant engine reference

InvalidTenantEngineCommand

public static final ErrorCode InvalidTenantEngineCommand

Invalid tenant engine command

InvalidTenantGroupId

public static final ErrorCode InvalidTenantGroupId

Invalid tenant group reference

DuplicateId

public static final ErrorCode DuplicateId

Generic duplicate id error

DuplicateHardwareId

public static final ErrorCode DuplicateHardwareId

Attempting to create a device with a duplicate hardware id

InvalidHardwareId

public static final ErrorCode InvalidHardwareId

Invalid device hardware id

InvalidAssetReferenceId

public static final ErrorCode InvalidAssetReferenceId

Invalid asset reference id

InvalidDeviceSpecificationToken

public static final ErrorCode InvalidDeviceSpecificationToken

Invalid device specification token

DuplicateDeviceSpecificationToken

public static final ErrorCode DuplicateDeviceSpecificationToken

Invalid device specification token

InvalidDeviceCommandToken

public static final ErrorCode InvalidDeviceCommandToken

Invalid site token

DeuplicateSiteToken

public static final ErrorCode DeuplicateSiteToken

Duplicate site token

InvalidSiteToken

public static final ErrorCode InvalidSiteToken

Invalid site token

DuplicateDeviceAssignment

public static final ErrorCode DuplicateDeviceAssignment

Duplicate device assignment token

InvalidDeviceAssignmentId

public static final ErrorCode InvalidDeviceAssignmentId

Invalid site assignment id

InvalidDeviceAssignmentToken

public static final ErrorCode InvalidDeviceAssignmentToken

Invalid device assignment token

InvalidZoneToken

public static final ErrorCode InvalidZoneToken

Invalid zone token

InvalidDeviceEventId

public static final ErrorCode InvalidDeviceEventId

Invalid device event id

DuplicateDeviceGroupToken

public static final ErrorCode DuplicateDeviceGroupToken

Duplicate device group token

InvalidDeviceGroupToken

public static final ErrorCode InvalidDeviceGroupToken

Invalid device group token

InvalidBatchOperationToken

public static final ErrorCode InvalidBatchOperationToken

Invalid batch operation token

InvalidBatchElement

public static final ErrorCode InvalidBatchElement

Invalid batch element

InvalidSearchProviderId

public static final ErrorCode InvalidSearchProviderId

Invalid search provider id

DuplicateStreamId

public static final ErrorCode DuplicateStreamId

Attempting to create a device stream with a stream id already in use

InvalidStreamId

public static final ErrorCode InvalidStreamId

Attempting to access a device stream that does not exist

InvalidCharsInStreamId

public static final ErrorCode InvalidCharsInStreamId

Attempting to create a stream id that contains invalid characters

InvalidAssetCategoryId

public static final ErrorCode InvalidAssetCategoryId

Invalid asset category id

InvalidAssetId

public static final ErrorCode InvalidAssetId

Invalid asset id

DuplicateTenantId

public static final ErrorCode DuplicateTenantId

Attempting to create a tenant with an id already in use

DuplicateTenantGroupId

public static final ErrorCode DuplicateTenantGroupId

Attempting to create a tenant group with an id already in use

InvalidScheduleToken

public static final ErrorCode InvalidScheduleToken

Invalid schedule token

InvalidScheduledJobToken

public static final ErrorCode InvalidScheduledJobToken

Invalid scheduled job token

DuplicateScheduleToken

public static final ErrorCode DuplicateScheduleToken

Invalid schedule token

DuplicateScheduledJobToken

public static final ErrorCode DuplicateScheduledJobToken

Invalid scheduled job token

InvalidTenantTemplateId

public static final ErrorCode InvalidTenantTemplateId

Invalid tenant template id

DuplicateZoneToken

public static final ErrorCode DuplicateZoneToken

Duplicate zone token

DuplicateBatchOperationToken

public static final ErrorCode DuplicateBatchOperationToken

Duplicate batch operation token

DuplicateBatchElement

public static final ErrorCode DuplicateBatchElement

Duplicate batch element

DeviceCommandExists

public static final ErrorCode DeviceCommandExists

Attempting to create a new command that duplicates an existing command

DeviceAlreadyAssigned

public static final ErrorCode DeviceAlreadyAssigned

Attempting to create a new assignment for a device with an active assignment

DeviceNotAssigned

public static final ErrorCode DeviceNotAssigned

Operation assumes device is assigned but no assignment exists

DeviceHardwareIdCanNotBeChanged

public static final ErrorCode DeviceHardwareIdCanNotBeChanged

Attempting to change the hardware id of an existing device

DeviceCanNotBeDeletedIfAssigned

public static final ErrorCode DeviceCanNotBeDeletedIfAssigned

Attempting to delete a device that is currently assigned

DeviceSiteCanNotBeChangedIfAssigned

public static final ErrorCode DeviceSiteCanNotBeChangedIfAssigned

Attempting to change site for device that is currently assigned

DeviceElementMappingExists

public static final ErrorCode DeviceElementMappingExists

Attempting to create a device element mapping for a path that is already mapped

DeviceElementMappingDoesNotExist

public static final ErrorCode DeviceElementMappingDoesNotExist

Attempting to refrence a device element mapping that does not exist

InvalidDeviceSlotPath

public static final ErrorCode InvalidDeviceSlotPath

Path references a non-existent slot or a device unit

DeviceParentMappingExists

public static final ErrorCode DeviceParentMappingExists

Attempting to create a device element mapping for a device that is already mapped

RequiredCommandParameterMissing

public static final ErrorCode RequiredCommandParameterMissing

Operation assumes device is assigned but no assignment exists

ZoneDeleteFailed

public static final ErrorCode ZoneDeleteFailed

Zone delete failure message

AssetCategoryIdInUse

public static final ErrorCode AssetCategoryIdInUse

Attempting to create a new asset category with an id already in use

AssetIdInUse

public static final ErrorCode AssetIdInUse

Attempting to create a new asset that conflicts with an existing one

AssetTypeNotAllowed

public static final ErrorCode AssetTypeNotAllowed

Attempting to create a new asset in a category that does not allow the type

UnknownAssetType

public static final ErrorCode UnknownAssetType

Reference to an unknown asset type

GenericDeleteFailed

public static final ErrorCode GenericDeleteFailed

Generic delete failure message

IncompleteData

public static final ErrorCode IncompleteData

Some required data was missing

Unknown

public static final ErrorCode Unknown

Error with no explanation

Method Detail

values

public static ErrorCode[] 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 (ErrorCode c : ErrorCode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ErrorCode valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

fromCode

public static ErrorCode fromCode(long code)

Look up the enum based on error code.

Parameters:

code -

Returns:

setCode

public void setCode(long code)

getCode

public long getCode()

setMessage

public void setMessage(java.lang.String message)

getMessage

public java.lang.String getMessage()