Package com.thingworx.types
Enum Class BaseTypes
- All Implemented Interfaces:
Serializable
,Comparable<BaseTypes>
,Constable
This enumeration contains all "types" that the Thingworx API can resolve and process.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantsEnum ConstantDescriptionHas a value equivalent of 117.Has a value equivalent of 107.Has a value equivalent of 21.Has a value equivalent of 2.Has a value equivalent of 110.Has a value equivalent of 120.Has a value equivalent of 104.Has a value equivalent of 114.Has a value equivalent of 3.Has a value equivalent of 52.Has a value equivalent of 109.Has a value equivalent of 20.Has a value equivalent of 14.Has a value equivalent of 11.Has a value equivalent of 10.Has a value equivalent of 12.Has a value equivalent of 5.Has a value equivalent of 22.Has a value equivalent of 8.Has a value equivalent of 118.Has a value equivalent of 6.Has a value equivalent of 23.Has a value equivalent of 105.Has a value equivalent of 116.Has a value equivalent of 106.Has a value equivalent of 113.Has a value equivalent of 115.Has a value equivalent of -1.Has a value equivalent of 128.Has a value equivalent of 129.Has a value equivalent of 1.Has a value equivalent of 119.Has a value equivalent of 13.Has a value equivalent of 122.Has a value equivalent of 121.Has a value equivalent of 123.Has a value equivalent of 50.Has a value equivalent of 9.Has a value equivalent of 17.Has a value equivalent of 51.Has a value equivalent of 111.Has a value equivalent of 0.Has a value equivalent of 112.Has a value equivalent of 130.Has a value equivalent of 16.Has a value equivalent of 15.Has a value equivalent to 126.Has a value equivalent of 99.Has a value equivalent of 100.Has a value equivalent of 101.Has a value equivalent of 102.Has a value equivalent of 4.Has a value equivalent of 108.Has a value equivalent of 16.Has a value equivalent of 124.Has a value equivalent of 124.Has a value equivalent of 125.Has a value equivalent of 7. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Collection
<BaseTypes> static final Collection
<BaseTypes> -
Method Summary
Modifier and TypeMethodDescriptionstatic boolean
areCompatible
(BaseTypes t1, BaseTypes t2) byte
code()
static Object
ConvertToObject
(Object data, BaseTypes coreTypeID) static IPrimitiveType
ConvertToPrimitive
(Object data, BaseTypes coreTypeID) static BaseTypes
fromCode
(byte code) static BaseTypes
fromFriendlyName
(String friendlyName) static IPrimitiveType
GetDefault
(BaseTypes coreTypeID) static boolean
isLinkType
(BaseTypes type) static boolean
isNumericBaseType
(BaseTypes baseType) static boolean
isStringBaseType
(BaseTypes baseType) static boolean
isTrue
(IPrimitiveType value) static BaseTypes
JDBCTypeToBaseType
(int jdbcType) static boolean
supportsFullTextSearch
(BaseTypes baseType)
Returns false if given base type does not support full text search otherwise returns true.static BaseTypes
Returns the enum constant of this class with the specified name.static BaseTypes[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
BLOB
Has a value equivalent of 21.- See Also:
-
EVENTNAME
Has a value equivalent of 52. The name of a Event. -
PERSISTENCEPROVIDERPACKAGENAME
Has a value equivalent of 121. The name of aPersistenceProviderPackage
. -
HTML
Has a value equivalent of 14. -
TEXT
Has a value equivalent of 15. -
VARIANT
Has a value equivalent of 16.- See Also:
-
IMAGE
Has a value equivalent of 10.- See Also:
-
VEC2
Has a value equivalent of 124.- See Also:
-
BASETYPENAME
Has a value equivalent of 107. The name of aBaseTypes
. -
VEC3
Has a value equivalent of 124.- See Also:
-
HYPERLINK
Has a value equivalent of 11. -
USERNAME
Has a value equivalent of 108. The name of aUser
. -
NOTHING
Has a value equivalent of -1. Has no base type. -
SCHEDULE
Has a value equivalent of 17. -
CATEGORYNAME
Has a value equivalent of 110. The name of a Category. -
MASHUPNAME
Has a value equivalent of 105. The name of aMashup
. -
INTEGER
Has a value equivalent of 22.- See Also:
-
NUMBER
Has a value equivalent of 1.- See Also:
-
PERSISTENCEPROVIDERNAME
Has a value equivalent of 122. The name of aPersistenceProvider
. -
DATASHAPENAME
Has a value equivalent of 104. The name of aDataShape
. -
GUID
Has a value equivalent of 20.- See Also:
-
THINGCODE
Has a value equivalent to 126.- See Also:
-
NETWORKNAME
Has a value equivalent of 115. The name of aNetwork
. -
BOOLEAN
Has a value equivalent of 2.- See Also:
-
PASSWORD
Has a value equivalent of 13.- See Also:
-
QUERY
Has a value equivalent of 9. -
MODELTAGVOCABULARYNAME
Has a value equivalent of 113. The name of aModelTagVocabulary
. -
DATATAGVOCABULARYNAME
Has a value equivalent of 114. The name of aDataTagVocabulary
. -
THINGSHAPENAME
Has a value equivalent of 101. The name of aThingShape
. -
TAGS
Has a value equivalent of 16.- See Also:
-
LOCATION
Has a value equivalent of 6.- See Also:
-
PROPERTYNAME
Has a value equivalent of 50. The name of a property. -
STYLETHEMENAME
Has a value equivalent of 130. The name of a StyleTheme. -
THINGGROUPNAME
Has a value equivalent of 99. The name of a ThingGroup. -
JSON
Has a value equivalent of 8.- See Also:
-
SERVICENAME
Has a value equivalent of 51. The name of a service. -
THINGNAME
Has a value equivalent of 100. The name of aThing
. -
GROUPNAME
Has a value equivalent of 109. The name of aGroup
. -
ORGANIZATIONNAME
Has a value equivalent of 119. The name of aOrganization
. -
MENUNAME
Has a value equivalent of 106. The name of aMenu
. -
PROJECTNAME
Has a value equivalent of 123. The name of aProject
. -
LONG
Has a value equivalent of 23.- See Also:
-
INFOTABLE
Has a value equivalent of 5.- See Also:
-
STATEDEFINITIONNAME
Has a value equivalent of 111. The name of a Category. -
DASHBOARDNAME
Has a value equivalent of 120. The name of aDashboard
. -
STYLEDEFINITIONNAME
Has a value equivalent of 112. The name of a Category. -
VEC4
Has a value equivalent of 125.- See Also:
-
MEDIAENTITYNAME
Has a value equivalent of 116. The name of aMediaEntity
. -
LOCALIZATIONTABLENAME
Has a value equivalent of 118. The name of aLocalizationTable
. -
THINGTEMPLATENAME
Has a value equivalent of 102. The name of aThingTemplate
. -
DATETIME
Has a value equivalent of 3.- See Also:
-
TIMESPAN
Has a value equivalent of 4.- See Also:
-
APPLICATIONKEYNAME
Has a value equivalent of 117. The name of aApplicationKey
. -
XML
Has a value equivalent of 7.- See Also:
-
STRING
Has a value equivalent of 0.- See Also:
-
NOTIFICATIONCONTENTNAME
Has a value equivalent of 128. The name of a NotificationContent. -
NOTIFICATIONDEFINITIONNAME
Has a value equivalent of 129. The name of a NotificationDefinition. -
IMAGELINK
Has a value equivalent of 12.
-
-
Field Details
-
INDEXABLE_PROPERTY_TYPES
-
UNINDEXABLE_PROPERTY_TYPES
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
code
- Returns:
- The basetype as its code equivalent.
-
friendlyName
- Returns:
- The friendly name (i.e. human readable string).
-
fromCode
-
fromFriendlyName
@ThingworxExtensionApiMethod(since={6,6}) public static BaseTypes fromFriendlyName(String friendlyName) -
GetBaseTypeList
-
isLinkType
-
JDBCTypeToBaseType
-
GetDefault
@ThingworxExtensionApiMethod(since={6,6}) public static IPrimitiveType GetDefault(BaseTypes coreTypeID) -
isTrue
-
ConvertToObject
@ThingworxExtensionApiMethod(since={6,6}) public static Object ConvertToObject(Object data, BaseTypes coreTypeID) throws Exception - Throws:
Exception
- If an error occurs
-
isStringBaseType
@ThingworxExtensionApiMethod(since={6,6}) public static boolean isStringBaseType(BaseTypes baseType) -
isNumericBaseType
@ThingworxExtensionApiMethod(since={6,6}) public static boolean isNumericBaseType(BaseTypes baseType) -
areCompatible
@ThingworxExtensionApiMethod(since={6,6}) public static boolean areCompatible(BaseTypes t1, BaseTypes t2) -
ConvertToPrimitive
@ThingworxExtensionApiMethod(since={6,6}) public static IPrimitiveType ConvertToPrimitive(Object data, BaseTypes coreTypeID) throws Exception - Throws:
Exception
- If an error occurs
-
supportsFullTextSearch
@ThingworxExtensionApiMethod(since={6,6}) public static boolean supportsFullTextSearch(BaseTypes baseType)
Returns false if given base type does not support full text search otherwise returns true. This method is useful in finding out whether or not to index given field for full text search.
-