Enum BaseTypes

  • 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 Detail

      • 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.
      • BASETYPENAME

        public static final BaseTypes BASETYPENAME
        Has a value equivalent of 107. The name of a BaseTypes.
      • 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.
      • 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.
      • NETWORKNAME

        public static final BaseTypes NETWORKNAME
        Has a value equivalent of 115. The name of a Network.
      • 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.
      • 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.
      • THINGGROUPNAME

        public static final BaseTypes THINGGROUPNAME
        Has a value equivalent of 99. The name of a ThingGroup.
      • 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.
      • 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.
      • 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.
      • APPLICATIONKEYNAME

        public static final BaseTypes APPLICATIONKEYNAME
        Has a value equivalent of 117. The name of a ApplicationKey.
      • 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
      • 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.
      • 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
      • 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.