BaseTypes (ThingWorx Platform API 8.5.0)

java.lang.Object
- java.lang.Enum<BaseTypes>
- - com.thingworx.types.BaseTypes

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BaseTypes>
```
@ThingworxExtensionApiClass(since={6,6})
public enum BaseTypes
extends java.lang.Enum<BaseTypes>
```
This enumeration contains all "types" that the Thingworx API can resolve and process.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`APPLICATIONKEYNAME` Has a value equivalent of 117.
`BASETYPENAME` Has a value equivalent of 107.
`BLOB` Has a value equivalent of 21.
`BOOLEAN` Has a value equivalent of 2.
`CATEGORYNAME` Has a value equivalent of 110.
`DASHBOARDNAME` Has a value equivalent of 120.
`DATASHAPENAME` Has a value equivalent of 104.
`DATATAGVOCABULARYNAME` Has a value equivalent of 114.
`DATETIME` Has a value equivalent of 3.
`EVENTNAME` Has a value equivalent of 52.
`GROUPNAME` Has a value equivalent of 109.
`GUID` Has a value equivalent of 20.
`HTML` Has a value equivalent of 14.
`HYPERLINK` Has a value equivalent of 11.
`IMAGE` Has a value equivalent of 10.
`IMAGELINK` Has a value equivalent of 12.
`INFOTABLE` Has a value equivalent of 5.
`INTEGER` Has a value equivalent of 22.
`JSON` Has a value equivalent of 8.
`LOCALIZATIONTABLENAME` Has a value equivalent of 118.
`LOCATION` Has a value equivalent of 6.
`LONG` Has a value equivalent of 23.
`MASHUPNAME` Has a value equivalent of 105.
`MEDIAENTITYNAME` Has a value equivalent of 116.
`MENUNAME` Has a value equivalent of 106.
`MODELTAGVOCABULARYNAME` Has a value equivalent of 113.
`NETWORKNAME` Has a value equivalent of 115.
`NOTHING` Has a value equivalent of -1.
`NOTIFICATIONCONTENTNAME` Has a value equivalent of 128.
`NOTIFICATIONDEFINITIONNAME` Has a value equivalent of 129.
`NUMBER` Has a value equivalent of 1.
`ORGANIZATIONNAME` Has a value equivalent of 119.
`PASSWORD` Has a value equivalent of 13.
`PERSISTENCEPROVIDERNAME` Has a value equivalent of 122.
`PERSISTENCEPROVIDERPACKAGENAME` Has a value equivalent of 121.
`PROJECTNAME` Has a value equivalent of 123.
`PROPERTYNAME` Has a value equivalent of 50.
`QUERY` Has a value equivalent of 9.
`SCHEDULE` Has a value equivalent of 17.
`SERVICENAME` Has a value equivalent of 51.
`STATEDEFINITIONNAME` Has a value equivalent of 111.
`STRING` Has a value equivalent of 0.
`STYLEDEFINITIONNAME` Has a value equivalent of 112.
`STYLETHEMENAME` Has a value equivalent of 130.
`TAGS` Has a value equivalent of 16.
`TEXT` Has a value equivalent of 15.
`THINGCODE` Has a value equivalent to 126.
`THINGNAME` Has a value equivalent of 100.
`THINGSHAPENAME` Has a value equivalent of 101.
`THINGTEMPLATENAME` Has a value equivalent of 102.
`TIMESPAN` Has a value equivalent of 4.
`USERNAME` Has a value equivalent of 108.
`VARIANT` Has a value equivalent of 16.
`VEC2` Has a value equivalent of 124.
`VEC3` Has a value equivalent of 124.
`VEC4` Has a value equivalent of 125.
`XML` Has a value equivalent of 7.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`areCompatible(BaseTypes t1, BaseTypes t2)`
`byte`	`code()`
`static java.lang.Object`	`ConvertToObject(java.lang.Object data, BaseTypes coreTypeID)`
`static IPrimitiveType`	`ConvertToPrimitive(java.lang.Object data, BaseTypes coreTypeID)`
`java.lang.String`	`friendlyName()`
`static BaseTypes`	`fromCode(byte code)` Constructs a `BaseTypes` from its code equivalent.
`static BaseTypes`	`fromFriendlyName(java.lang.String friendlyName)` Constructs a `BaseTypes` from its friendly name equivalent.
`static java.util.ArrayList<java.lang.String>`	`GetBaseTypeList()`
`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`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static BaseTypes[]`	`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
  - BLOB
```
public static final BaseTypes BLOB
```
    Has a value equivalent of 21.
    
    See Also:
    
    BlobPrimitive
  - EVENTNAME
```
public static final BaseTypes EVENTNAME
```
    Has a value equivalent of 52. The name of a Event.
  - PERSISTENCEPROVIDERPACKAGENAME
```
public static final BaseTypes PERSISTENCEPROVIDERPACKAGENAME
```
    Has a value equivalent of 121. The name of a PersistenceProviderPackage.
  - HTML
```
public static final BaseTypes HTML
```
    Has a value equivalent of 14.
  - TEXT
```
public static final BaseTypes TEXT
```
    Has a value equivalent of 15.
  - VARIANT
```
public static final BaseTypes VARIANT
```
    Has a value equivalent of 16.
    
    See Also:
    
    VariantPrimitive
  - IMAGE
```
public static final BaseTypes IMAGE
```
    Has a value equivalent of 10.
    
    See Also:
    
    ImagePrimitive
  - VEC2
```
public static final BaseTypes VEC2
```
    Has a value equivalent of 124.
    
    See Also:
    
    Vec2Primitive
  - BASETYPENAME
```
public static final BaseTypes BASETYPENAME
```
    Has a value equivalent of 107. The name of a BaseTypes.
  - VEC3
```
public static final BaseTypes VEC3
```
    Has a value equivalent of 124.
    
    See Also:
    
    Vec3Primitive
  - HYPERLINK
```
public static final BaseTypes HYPERLINK
```
    Has a value equivalent of 11.
  - USERNAME
```
public static final BaseTypes USERNAME
```
    Has a value equivalent of 108. The name of a User.
  - NOTHING
```
public static final BaseTypes NOTHING
```
    Has a value equivalent of -1. Has no base type.
  - SCHEDULE
```
public static final BaseTypes SCHEDULE
```
    Has a value equivalent of 17.
  - CATEGORYNAME
```
public static final BaseTypes CATEGORYNAME
```
    Has a value equivalent of 110. The name of a Category.
  - MASHUPNAME
```
public static final BaseTypes MASHUPNAME
```
    Has a value equivalent of 105. The name of a Mashup.
  - INTEGER
```
public static final BaseTypes INTEGER
```
    Has a value equivalent of 22.
    
    See Also:
    
    IntegerPrimitive
  - NUMBER
```
public static final BaseTypes NUMBER
```
    Has a value equivalent of 1.
    
    See Also:
    
    NumberPrimitive
  - PERSISTENCEPROVIDERNAME
```
public static final BaseTypes PERSISTENCEPROVIDERNAME
```
    Has a value equivalent of 122. The name of a PersistenceProvider.
  - DATASHAPENAME
```
public static final BaseTypes DATASHAPENAME
```
    Has a value equivalent of 104. The name of a DataShape.
  - GUID
```
public static final BaseTypes GUID
```
    Has a value equivalent of 20.
    
    See Also:
    
    GUIDPrimitive
  - THINGCODE
```
public static final BaseTypes THINGCODE
```
    Has a value equivalent to 126.
    
    See Also:
    
    ThingCodePrimitive
  - NETWORKNAME
```
public static final BaseTypes NETWORKNAME
```
    Has a value equivalent of 115. The name of a Network.
  - BOOLEAN
```
public static final BaseTypes BOOLEAN
```
    Has a value equivalent of 2.
    
    See Also:
    
    BooleanPrimitive
  - PASSWORD
```
public static final BaseTypes PASSWORD
```
    Has a value equivalent of 13.
    
    See Also:
    
    PasswordPrimitive
  - QUERY
```
public static final BaseTypes QUERY
```
    Has a value equivalent of 9.
  - MODELTAGVOCABULARYNAME
```
public static final BaseTypes MODELTAGVOCABULARYNAME
```
    Has a value equivalent of 113. The name of a ModelTagVocabulary.
  - DATATAGVOCABULARYNAME
```
public static final BaseTypes DATATAGVOCABULARYNAME
```
    Has a value equivalent of 114. The name of a DataTagVocabulary.
  - THINGSHAPENAME
```
public static final BaseTypes THINGSHAPENAME
```
    Has a value equivalent of 101. The name of a ThingShape.
  - TAGS
```
public static final BaseTypes TAGS
```
    Has a value equivalent of 16.
    
    See Also:
    
    TagCollectionPrimitive
  - LOCATION
```
public static final BaseTypes LOCATION
```
    Has a value equivalent of 6.
    
    See Also:
    
    LocationPrimitive
  - PROPERTYNAME
```
public static final BaseTypes PROPERTYNAME
```
    Has a value equivalent of 50. The name of a property.
  - STYLETHEMENAME
```
public static final BaseTypes STYLETHEMENAME
```
    Has a value equivalent of 130. The name of a StyleTheme.
  - JSON
```
public static final BaseTypes JSON
```
    Has a value equivalent of 8.
    
    See Also:
    
    JSONPrimitive
  - SERVICENAME
```
public static final BaseTypes SERVICENAME
```
    Has a value equivalent of 51. The name of a service.
  - THINGNAME
```
public static final BaseTypes THINGNAME
```
    Has a value equivalent of 100. The name of a Thing.
  - GROUPNAME
```
public static final BaseTypes GROUPNAME
```
    Has a value equivalent of 109. The name of a Group.
  - ORGANIZATIONNAME
```
public static final BaseTypes ORGANIZATIONNAME
```
    Has a value equivalent of 119. The name of a Organization.
  - MENUNAME
```
public static final BaseTypes MENUNAME
```
    Has a value equivalent of 106. The name of a Menu.
  - PROJECTNAME
```
public static final BaseTypes PROJECTNAME
```
    Has a value equivalent of 123. The name of a Project.
  - LONG
```
public static final BaseTypes LONG
```
    Has a value equivalent of 23.
    
    See Also:
    
    LongPrimitive
  - INFOTABLE
```
public static final BaseTypes INFOTABLE
```
    Has a value equivalent of 5.
    
    See Also:
    
    InfoTablePrimitive
  - STATEDEFINITIONNAME
```
public static final BaseTypes STATEDEFINITIONNAME
```
    Has a value equivalent of 111. The name of a Category.
  - DASHBOARDNAME
```
public static final BaseTypes DASHBOARDNAME
```
    Has a value equivalent of 120. The name of a Dashboard.
  - STYLEDEFINITIONNAME
```
public static final BaseTypes STYLEDEFINITIONNAME
```
    Has a value equivalent of 112. The name of a Category.
  - VEC4
```
public static final BaseTypes VEC4
```
    Has a value equivalent of 125.
    
    See Also:
    
    Vec4Primitive
  - MEDIAENTITYNAME
```
public static final BaseTypes MEDIAENTITYNAME
```
    Has a value equivalent of 116. The name of a MediaEntity.
  - LOCALIZATIONTABLENAME
```
public static final BaseTypes LOCALIZATIONTABLENAME
```
    Has a value equivalent of 118. The name of a LocalizationTable.
  - THINGTEMPLATENAME
```
public static final BaseTypes THINGTEMPLATENAME
```
    Has a value equivalent of 102. The name of a ThingTemplate.
  - DATETIME
```
public static final BaseTypes DATETIME
```
    Has a value equivalent of 3.
    
    See Also:
    
    DatetimePrimitive
  - TIMESPAN
```
public static final BaseTypes TIMESPAN
```
    Has a value equivalent of 4.
    
    See Also:
    
    TimespanPrimitive
  - APPLICATIONKEYNAME
```
public static final BaseTypes APPLICATIONKEYNAME
```
    Has a value equivalent of 117. The name of a ApplicationKey.
  - XML
```
public static final BaseTypes XML
```
    Has a value equivalent of 7.
    
    See Also:
    
    XMLPrimitive
  - STRING
```
public static final BaseTypes STRING
```
    Has a value equivalent of 0.
    
    See Also:
    
    StringPrimitive
  - NOTIFICATIONCONTENTNAME
```
public static final BaseTypes NOTIFICATIONCONTENTNAME
```
    Has a value equivalent of 128. The name of a NotificationContent.
  - NOTIFICATIONDEFINITIONNAME
```
public static final BaseTypes NOTIFICATIONDEFINITIONNAME
```
    Has a value equivalent of 129. The name of a NotificationDefinition.
  - IMAGELINK
```
public static final BaseTypes IMAGELINK
```
    Has a value equivalent of 12.
- Method Detail
  - values
```
public static BaseTypes[] 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 (BaseTypes c : BaseTypes.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static BaseTypes 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
  - code
```
@ThingworxExtensionApiMethod(since={6,6})
public byte code()
```
    Returns:
    
    The basetype as its code equivalent.
  - friendlyName
```
@ThingworxExtensionApiMethod(since={6,6})
public java.lang.String friendlyName()
```
    Returns:
    
    The friendly name (i.e. human readable string).
  - fromCode
```
@ThingworxExtensionApiMethod(since={6,6})
public static BaseTypes fromCode(byte code)
```
    Constructs a BaseTypes from its code equivalent.
    
    Parameters:
    
    code - The code equivalent of the BaseTypes enumeration.
    
    Returns:
    
    The enumeration BaseTypes of the code provided, or null if the code is not recognized.
  - fromFriendlyName
```
@ThingworxExtensionApiMethod(since={6,6})
public static BaseTypes fromFriendlyName(java.lang.String friendlyName)
```
    Constructs a BaseTypes from its friendly name equivalent.
    
    Parameters:
    
    friendlyName - A friendly name String equivalent of the BaseTypes enumeration.
    
    Returns:
    
    The enumeration BaseTypes of the friendly name String provided, or null if the friendly name String is not recognized.
  - GetBaseTypeList
```
@ThingworxExtensionApiMethod(since={6,6})
public static java.util.ArrayList<java.lang.String> GetBaseTypeList()
```
  - isLinkType
```
@ThingworxExtensionApiMethod(since={6,6})
public static boolean isLinkType(BaseTypes type)
```
  - JDBCTypeToBaseType
```
@ThingworxExtensionApiMethod(since={6,6})
public static BaseTypes JDBCTypeToBaseType(int jdbcType)
```
  - GetDefault
```
@ThingworxExtensionApiMethod(since={6,6})
public static IPrimitiveType GetDefault(BaseTypes coreTypeID)
```
  - isTrue
```
@ThingworxExtensionApiMethod(since={6,6})
public static boolean isTrue(IPrimitiveType value)
```
  - ConvertToObject
```
@ThingworxExtensionApiMethod(since={6,6})
public static java.lang.Object ConvertToObject(java.lang.Object data,
                                                                                         BaseTypes coreTypeID)
                                                                                  throws java.lang.Exception
```
    Throws:
    
    java.lang.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(java.lang.Object data,
                                                                                          BaseTypes coreTypeID)
                                                                                   throws java.lang.Exception
```
    Throws:
    
    java.lang.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.

Enum BaseTypes

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

BLOB

EVENTNAME

PERSISTENCEPROVIDERPACKAGENAME

HTML

TEXT

VARIANT

IMAGE

VEC2

BASETYPENAME

VEC3

HYPERLINK

USERNAME

NOTHING

SCHEDULE

CATEGORYNAME

MASHUPNAME

INTEGER

NUMBER

PERSISTENCEPROVIDERNAME

DATASHAPENAME

GUID

THINGCODE

NETWORKNAME

BOOLEAN

PASSWORD

QUERY

MODELTAGVOCABULARYNAME

DATATAGVOCABULARYNAME

THINGSHAPENAME

TAGS

LOCATION

PROPERTYNAME

STYLETHEMENAME

JSON

SERVICENAME

THINGNAME

GROUPNAME

ORGANIZATIONNAME

MENUNAME

PROJECTNAME

LONG

INFOTABLE

STATEDEFINITIONNAME

DASHBOARDNAME

STYLEDEFINITIONNAME

VEC4

MEDIAENTITYNAME

LOCALIZATIONTABLENAME

THINGTEMPLATENAME

DATETIME

TIMESPAN

APPLICATIONKEYNAME

XML

STRING

NOTIFICATIONCONTENTNAME

NOTIFICATIONDEFINITIONNAME

IMAGELINK

Method Detail

values

valueOf

code

friendlyName

fromCode

fromFriendlyName

GetBaseTypeList

isLinkType

JDBCTypeToBaseType

GetDefault

isTrue

ConvertToObject

isStringBaseType

isNumericBaseType

areCompatible

ConvertToPrimitive