Package com.thingworx.security.users

Class User

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.security.users.User

All Implemented Interfaces:

IConfigurableObject, INotScriptFriendly, ISupportsDeprecation, IDiffableObject, IAvatar, IEntityLifeCycleEvent, IPersistable, IPropertyProvider, IServiceProvider, ITaggableObject, IDependencyScannableObject, IEntityDefinition, IPersistableObject<String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, Serializable, Cloneable

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class User
extends ServiceProviderEntity
implements IAvatar, IPropertyProvider, Cloneable

A Thingworx User entity.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTENDED_PROPERTY_PREFIX
static final String	SETTINGS_TABLE_NAME
static final String	USER_EXTENSIONS_DATE_ROW
static final String	USER_EXTENSIONS_NAME_ROW
static final String	USER_EXTENSIONS_TABLE_NAME
static final String	USER_EXTENSIONS_THINGSHAPE
static final String	USER_EXTENSIONS_VALUE_ROW

Fields inherited from class com.thingworx.entities.RootEntity

BASIC_PROPERTY_DEFINITIONS, EXCLUDED_ENTITY_TYPES_IN_PROJECT

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor	Description
User()	Initializes this instace with default values.

Method Summary

Modifier and Type	Method	Description
void	addGroup(Group group)
void	addOrganizationalUnit(OrganizationalUnit organization)
void	AddTags(TagCollection tags)	Service Category: Metadata Service Description: Append additional tags to an entity.
void	AssignNewPassword(String newPassword, String newPasswordConfirm)	Service Category: Security Service Description: Assign new password.
void	ChangePassword(String oldPassword, String newPassword, String newPasswordConfirm)	Service Category: Security Service Description: Change password.
final void	DeleteAllConfigurationTableRows(String tableName, Boolean persistent)	Service Category: Configuration Service Description: Delete all rows from a multi-row configuration table.
void	DeleteApplicationKeys(Boolean deleteExpiredKeys, Boolean deleteUnexpiredKeys)	Service Category: ApplicationKeys Service Description: Delete application keys associated with this user.
final void	DeleteConfigurationTable(String tableName, Boolean persistent)	Service Category: Configuration Service Description: Delete an entire configuration table.
void	DeleteConfigurationTableRows(String tableName, InfoTable values, Boolean persistent)	Deprecated.
final void	DeleteConfigurationTableRows(String tableName, InfoTable values, Boolean persistent, Boolean removeAllMatchingRows)	Service Category: Configuration Service Description: Delete one or more rows from a multi-row configuration table.
void	deleteGroup(Group group)
void	deleteOrganizationalUnit(OrganizationalUnit organization)
void	DisableUser()	Service Category: Security Service Description: Service to disable a user.
Boolean	DoesApplicationKeyWithKeyIdExist(String keyId)	Service Category: ApplicationKeys Service Description: Returns true if the specified key id associated with this user exists.
void	EnableUser()	Service Category: Security Service Description: Service to enable a user.
InfoTable	GetApplicationKeyExpirationInfo(Boolean expiredKeys, Boolean unexpiredKeys)	Service Category: ApplicationKeys Service Description: Get application key expiration info associated with this user.
RelationshipTypes.ThingworxRelationshipTypes	getEntityType()	Returns the type of this entity.
EntityReferenceCollection	getGroups()
InfoTable	GetGroups()	Service Category: Groups Service Description: Get list of groups that this user is a member of.
PropertyDefinition	getInstancePropertyDefinition(String name)	Returns the specified property definition for this instance.
PropertyDefinition	getInstancePropertyDefinitionIfVisible(String name)	Returns the specified property definition for this instance if visible.
PropertyDefinitionCollection	getInstancePropertyDefinitions()	Returns a collection containing all property definitions belonging to this instance.
String	getLanguage()	Get the user's language preferences.
String	GetMobileMashup()	Service Category: Mashups Service Description: Get mobile mashup.
InfoTable	GetNamedPropertyValues(InfoTable propertyNames)	Service Category: Properties Service Description: Get a subset of the current property values for this thing.
InfoTable	GetNamedPropertyValuesVTQ(InfoTable propertyNames)	Service Category: Properties Service Description: Get the current property values for this thing as VTQ.
ScriptFriendlyArrayList<String>	getOrganizationalUnitNames()	Gets the organizationUnitNames from getOrganizationalUnits
InfoTable	GetOrganizationalUnits()	Service Category: OrgUnits Service Description: Get list of organizational units that this user is a member of.
ScriptFriendlyArrayList<String>	getOrganizationNames()	Deprecated. As of ThingWorx 9.5, replaced by getOrgNames()
InfoTable	GetOrganizations()	Service Category: Organizations Service Description: Get list of organizations that this user is a member of.
ScriptFriendlyArrayList<String>	getOrgNames()	Gets the organizationNames getOrganizations
org.json.JSONObject	GetPersistentValue(String name)	Service Category: SessionInfo Service Description: Get persistent value.
String	GetPropertyQuality(String propertyName)	Service Category: Properties Service Description: Get the quality for a specific property.
org.joda.time.DateTime	GetPropertyTime(String propertyName)	Service Category: Properties Service Description: Get the timestamp for a specific property.
BaseTypes	getPropertyType(String propertyName)	Returns the base type defined in the specified property's definition.
IPrimitiveType	getPropertyValue(String propertyName)	Returns the value currently assigned to the specified property.
InfoTable	GetPropertyValues()	Service Category: Properties Service Description: Get the current property values for this thing.
InfoTable	getPropertyValuesAsInfoTable()	Returns an InfoTable containing a list of the properties belonging to this instance and their values.
InfoTable	GetPropertyValuesVTQ()	Service Category: Properties Service Description: Get the current property values for this thing as VTQ.
InfoTable	GetUserPreferenceInfo()	Service Category: Properties Service Description: Get the attributes of the User entity that an unprivileged user may see.
boolean	hasProperty(String propertyName)	Returns true if there exists a property with the specified name.
boolean	hasPropertyAndIsVisible(String propertyName)	Returns true if there exists a property with the specified name and is visible to the user.
boolean	IsEnabled()	Service Category: Security Service Description: Get Enabled Status.
boolean	IsLocked()	Service Category: Security Service Description: Get Locked Status.
void	LockUser()	Service Category: Security Service Description: Service to lock a user.
void	ResetSecurityContext()	Service Category: Security Service Description: Reset cached security context.
final void	SetConfigurationTable(String tableName, InfoTable configurationTable, Boolean persistent)	Service Category: Configuration Service Description: Set an entire configuration table.
final void	SetConfigurationTableRows(String tableName, InfoTable values, Boolean persistent)	Service Category: Configuration Service Description: Update/add one or more rows in a multi-row configuration table.
void	SetDescription(String description)	Service Category: Metadata Service Description: Overwrite/set the description for an entity.
void	SetLanguagePreferences(String preferences)	Service Category: Properties Service Description: Set the user's language preferences.
void	SetMobileMashup(String name)	Service Category: Mashups Service Description: Set mobile mashup.
final void	SetMultiRowConfigurationTable(String tableName, InfoTable configurationTable, Boolean persistent)	Service Category: Configuration Service Description: Set an entire multi-row configuration table.
void	SetPersistentValue(String name, org.json.JSONObject value)	Service Category: SessionInfo Service Description: Set persistent value.
void	setPropertyValue(String propertyName, IPrimitiveType value)	Assigns the provided value to the specified property.
void	SetPropertyValues(InfoTable values)	Service Category: Properties Service Description: Get a subset of the current property values for this thing.
void	SetTags(TagCollection tags)	Service Category: Metadata Service Description: Overwrite/set the tags for an entity.
void	UnlockUser()	Service Category: Security Service Description: Service to unlock a user.

Methods inherited from class com.thingworx.entities.ServiceProviderEntity

getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, initializeEntity, preInitializeEntity, processAPIServiceRequest, processServiceRequest

Methods inherited from class com.thingworx.entities.RootEntity

AddConfigurationTableDefinition, AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, deleteDesignTimePermission, DeleteDesignTimePermission, deleteRunTimePermission, DeleteRunTimePermission, deleteVisibilityPermission, DeleteVisibilityPermission, dispose, getAspects, GetAvatar, getAvatarContent, GetAvatarURL, GetConfigurationChangeHistory, getConfigurationSetting, getConfigurationTable, GetConfigurationTable, GetConfigurationTableDefinition, GetConfigurationTableRow, GetConfigurationTables, GetDescription, getDesignTimePermissions, GetDesignTimePermissions, GetDesignTimePermissionsAsJSON, getDocumentationContent, getEntityTypeAsString, GetEventDefinition, GetEventDefinitions, GetHomeMashup, GetIncomingDependencies, GetIncomingDependenciesAsNetwork, GetInstanceMetadataAsJSON, GetInstanceMetadataWithPermissionsAsJSON, GetLastModifiedDate, GetMetadata, GetMetadataAsJSON, GetMetadataWithPermissionsAsJSON, GetOutgoingDependencies, GetOutgoingDependenciesAsNetwork, getOwner, GetOwner, GetPermissionsForCurrentUser, GetPermissionsForGroup, GetPermissionsForUser, GetProjectName, GetPropertyDefinition, GetPropertyDefinitions, getRunTimePermissions, GetRunTimePermissions, GetRunTimePermissionsAsJSON, GetServiceDefinition, GetServiceDefinitions, getStringConfigurationSetting, getStringConfigurationSettingWithDefault, GetSummaryInformation, getTags, GetTags, GetTagsAsInfoTable, getVisibilityPermissions, GetVisibilityPermissions, GetVisibilityPermissionsAsJSON, HasIncomingDependencies, HasOutgoingDependencies, isEditable, isEditableExtensionObject, isEditableSystemObject, isExtensionObject, IsMultiRowTable, isOwner, isSystemObject, isThemeObject, isVisible, isVisible, ListDeprecatedUsage, persistDesignTimePermissions, persistRunTimePermissions, persistVisibilityPermissions, RemoveTags, SaveConfigurationTables, SetAvatar, setConfigurationSetting, setDesignTimePermissions, SetDesignTimePermissionsAsJSON, setDocumentationContent, setExtensionObject, SetHomeMashup, setLastModifiedDate, setOwner, SetOwner, SetProjectName, setRunTimePermissions, SetRunTimePermissionsAsJSON, setStringConfigurationSetting, setVisibilityPermissions, SetVisibilityPermissionsAsJSON, toJSON, toJSONDefinition, UpdateProjectDependencies, validateConfiguration

Methods inherited from class com.thingworx.persistence.common.PersistableNamedObject

getID, hasID, isTransient

Methods inherited from class com.thingworx.types.NamedObject

getDescription, getName, setDescription, setName, toValueCollection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.thingworx.entities.interfaces.IAvatar

GetAvatar, getAvatarContent, SetAvatar

Methods inherited from interface com.thingworx.types.INamedObject

getDescription, getName

Methods inherited from interface com.thingworx.entities.interfaces.IPersistable

getID, hasID

Methods inherited from interface com.thingworx.security.permissions.ISecurable

getID, getName

Methods inherited from interface com.thingworx.deprecation.ISupportsDeprecation

getDeprecated, isDeprecated, isDeprecatedBefore, since

Field Details

EXTENDED_PROPERTY_PREFIX

public static final String EXTENDED_PROPERTY_PREFIX

See Also:

• Constant Field Values

USER_EXTENSIONS_TABLE_NAME

public static final String USER_EXTENSIONS_TABLE_NAME

See Also:

• Constant Field Values

SETTINGS_TABLE_NAME

public static final String SETTINGS_TABLE_NAME

See Also:

• Constant Field Values

USER_EXTENSIONS_THINGSHAPE

public static final String USER_EXTENSIONS_THINGSHAPE

See Also:

• Constant Field Values

USER_EXTENSIONS_NAME_ROW

public static final String USER_EXTENSIONS_NAME_ROW

See Also:

• Constant Field Values

USER_EXTENSIONS_VALUE_ROW

public static final String USER_EXTENSIONS_VALUE_ROW

See Also:

• Constant Field Values

USER_EXTENSIONS_DATE_ROW

public static final String USER_EXTENSIONS_DATE_ROW

See Also:

• Constant Field Values

Constructor Details

User

public User()

Initializes this instace with default values.

Method Details

SetDescription

@ThingworxExtensionApiMethod(since={6,6})
public void SetDescription(String description)
                    throws Exception

Service Category:

Metadata

Service Description:

Overwrite/set the description for an entity.

Overrides:

SetDescription in class RootEntity

Parameters:

description - Description for an entity - STRING

Throws:

Exception - if an error occurs

SetTags

@ThingworxExtensionApiMethod(since={6,6})
public void SetTags(TagCollection tags)
             throws Exception

Service Category:

Metadata

Service Description:

Overwrite/set the tags for an entity.

Overrides:

SetTags in class RootEntity

Parameters:

tags - Tags for an entity - TAGS

Throws:

Exception - if an error occurs

AddTags

@ThingworxExtensionApiMethod(since={6,6})
public void AddTags(TagCollection tags)
             throws Exception

Service Category:

Metadata

Service Description:

Append additional tags to an entity.

Overrides:

AddTags in class RootEntity

Parameters:

tags - Tags for an entity - TAGS

Throws:

Exception - if an error occurs

ResetSecurityContext

@ThingworxExtensionApiMethod(since={6,6})
public void ResetSecurityContext()

Service Category:

Security

Service Description:

Reset cached security context.

GetMobileMashup

@ThingworxExtensionApiMethod(since={6,6})
public String GetMobileMashup()

Service Category:

Mashups

Service Description:

Get mobile mashup.

Returns:

MobileMashup Mobile mashup - MASHUPNAME

SetMobileMashup

@ThingworxExtensionApiMethod(since={6,6})
public void SetMobileMashup(String name)
                     throws Exception

Service Category:

Mashups

Service Description:

Set mobile mashup.

Parameters:

name - Mobile mashup name - MASHUPNAME

Throws:

Exception - if an error occurs

GetPersistentValue

@ThingworxExtensionApiMethod(since={6,6})
public org.json.JSONObject GetPersistentValue(String name)
                                       throws Exception

Service Category:

SessionInfo

Service Description:

Get persistent value.

Parameters:

name - Parameter name - STRING

Returns:

result Parameter value - JSON

Throws:

Exception - if an error occurs

SetPersistentValue

@ThingworxExtensionApiMethod(since={6,6})
public void SetPersistentValue(String name,
 org.json.JSONObject value)
                        throws Exception

Service Category:

SessionInfo

Service Description:

Set persistent value.

Parameters:

name - Parameter name - STRING

value - Parameter value - JSON

Throws:

Exception - if an error occurs

ChangePassword

@ThingworxExtensionApiMethod(since={6,6})
public void ChangePassword(String oldPassword,
 String newPassword,
 String newPasswordConfirm)
                    throws Exception

Service Category:

Security

Service Description:

Change password.

Parameters:

oldPassword - Previous Password - STRING

newPassword - New Password - STRING

newPasswordConfirm - New Password Confirmation - STRING

Throws:

Exception - if an error occurs

AssignNewPassword

@ThingworxExtensionApiMethod(since={6,6})
public void AssignNewPassword(String newPassword,
 String newPasswordConfirm)
                       throws Exception

Service Category:

Security

Service Description:

Assign new password.

Parameters:

newPassword - New Password - STRING

newPasswordConfirm - New Password Confirmation - STRING

Throws:

Exception - if an error occurs

SetLanguagePreferences

@ThingworxExtensionApiMethod(since={6,6,5})
public void SetLanguagePreferences(String preferences)
                            throws Exception

Service Category:

Properties

Service Description:

Set the user's language preferences.

Sets an ordered list of languages as the language preferences for this user. Localization tokens are resolved in the first (or only) language, if possible. If that translation is not available, other listed languages are tried in the specified order.

Parameters:

preferences - The new language preferences, ordered best first, comma separated

Throws:

Exception - Thrown if the user in the current security context attempts to call this on a different user and is not an administrator

GetUserPreferenceInfo

@ThingworxExtensionApiMethod(since={6,6,5})
public InfoTable GetUserPreferenceInfo()
                                throws Exception

Service Category:

Properties

Service Description:

Get the attributes of the User entity that an unprivileged user may see.

Returns all of this user's general preference information such as username, avatar and language preferences.

Returns:

A collection of the user's preference information

Throws:

Exception - Thrown if the user in the current security context attempts to call this on a different user and is not an administrator

DisableUser

@ThingworxExtensionApiMethod(since={6,6})
public void DisableUser()
                 throws Exception

Service Category:

Security

Service Description:

Service to disable a user.

Throws:

Exception - if an error occurs

EnableUser

@ThingworxExtensionApiMethod(since={6,6})
public void EnableUser()
                throws Exception

Service Category:

Security

Service Description:

Service to enable a user.

Throws:

Exception - if an error occurs

IsEnabled

@ThingworxExtensionApiMethod(since={6,6})
public boolean IsEnabled()
                  throws Exception

Service Category:

Security

Service Description:

Get Enabled Status.

Returns:

enabled Enabled status - BOOLEAN

Throws:

Exception - if an error occurs

LockUser

@ThingworxExtensionApiMethod(since={7,2})
public void LockUser()
              throws Exception

Service Category:

Security

Service Description:

Service to lock a user.

Throws:

Exception - if an error occurs

UnlockUser

@ThingworxExtensionApiMethod(since={7,2})
public void UnlockUser()
                throws Exception

Service Category:

Security

Service Description:

Service to unlock a user.

Throws:

Exception - if an error occurs

IsLocked

@ThingworxExtensionApiMethod(since={7,2})
public boolean IsLocked()
                 throws Exception

Service Category:

Security

Service Description:

Get Locked Status.

Returns:

result Locked status - BOOLEAN

Throws:

Exception - if an error occurs

GetGroups

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetGroups()
                    throws Exception

Service Category:

Groups

Service Description:

Get list of groups that this user is a member of.

Returns:

result Result - INFOTABLE - Aspects {dataShape:EntityList}

Throws:

Exception - if an error occurs

GetOrganizationalUnits

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetOrganizationalUnits()
                                 throws Exception

Service Category:

OrgUnits

Service Description:

Get list of organizational units that this user is a member of.

Returns:

result Result - INFOTABLE - Aspects {dataShape:EntityList}

Throws:

Exception - if an error occurs

GetOrganizations

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetOrganizations()
                           throws Exception

Service Category:

Organizations

Service Description:

Get list of organizations that this user is a member of.

Returns:

result Result - INFOTABLE - Aspects {dataShape:EntityList}

Throws:

Exception - if an error occurs

GetApplicationKeyExpirationInfo

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetApplicationKeyExpirationInfo(Boolean expiredKeys,
 Boolean unexpiredKeys)
                                          throws Exception

Service Category:

ApplicationKeys

Service Description:

Get application key expiration info associated with this user. Must specify true to at least one parameter to return any application keys, true to both parameters if you want to return all application keys.

Parameters:

expiredKeys - Expired keys - BOOLEAN

unexpiredKeys - Unexpired keys - BOOLEAN

Returns:

result Result - INFOTABLE - Aspects {dataShape:ApplicationKeyExpirationInfo}

Throws:

Exception - if an error occurs

DoesApplicationKeyWithKeyIdExist

@ThingworxExtensionApiMethod(since={6,6})
public Boolean DoesApplicationKeyWithKeyIdExist(String keyId)
                                         throws Exception

Service Category:

ApplicationKeys

Service Description:

Returns true if the specified key id associated with this user exists.

Parameters:

keyId - The Key Id - STRING

Returns:

result Result - BOOLEAN

Throws:

Exception - if an error occurs

DeleteApplicationKeys

@ThingworxExtensionApiMethod(since={6,6})
public void DeleteApplicationKeys(Boolean deleteExpiredKeys,
 Boolean deleteUnexpiredKeys)
                           throws Exception

Service Category:

ApplicationKeys

Service Description:

Delete application keys associated with this user. Must specify true to at least one parameter to delete any application keys, true to both parameters if you want to delete all application keys.

Parameters:

deleteExpiredKeys - Delete expired keys - BOOLEAN

deleteUnexpiredKeys - Delete unexpired keys - BOOLEAN

Throws:

Exception - if an error occurs

getGroups

@ThingworxExtensionApiMethod(since={6,6})
public EntityReferenceCollection getGroups()

addGroup

@ThingworxExtensionApiMethod(since={6,6})
public void addGroup(Group group)
              throws Exception

Throws:

Exception

deleteGroup

@ThingworxExtensionApiMethod(since={6,6})
public void deleteGroup(Group group)
                 throws Exception

Throws:

Exception

getOrganizationalUnitNames

@ThingworxExtensionApiMethod(since={6,6})
public ScriptFriendlyArrayList<String> getOrganizationalUnitNames()

Gets the organizationUnitNames from getOrganizationalUnits

getOrganizationNames

@Deprecated
@ThingworxExtensionApiMethod(since={6,6})
public ScriptFriendlyArrayList<String> getOrganizationNames()

Deprecated.

As of ThingWorx 9.5, replaced by getOrgNames()

Gets the organizationNames from getOrganizationalUnits

getOrgNames

@ThingworxExtensionApiMethod(since={9,5})
public ScriptFriendlyArrayList<String> getOrgNames()

Gets the organizationNames getOrganizations

addOrganizationalUnit

@ThingworxExtensionApiMethod(since={6,6})
public void addOrganizationalUnit(OrganizationalUnit organization)
                           throws Exception

Throws:

Exception

deleteOrganizationalUnit

@ThingworxExtensionApiMethod(since={6,6})
public void deleteOrganizationalUnit(OrganizationalUnit organization)
                              throws Exception

Throws:

Exception

getInstancePropertyDefinition

@ThingworxExtensionApiMethod(since={6,6})
public PropertyDefinition getInstancePropertyDefinition(String name)

Description copied from interface: IPropertyProvider

Returns the specified property definition for this instance.

Specified by:

getInstancePropertyDefinition in interface IPropertyProvider

Parameters:

name - the name of the property

Returns:

the definition of the property

getInstancePropertyDefinitionIfVisible

@ThingworxExtensionApiMethod(since={9,0})
public PropertyDefinition getInstancePropertyDefinitionIfVisible(String name)
                                                          throws Exception

Description copied from interface: IPropertyProvider

Returns the specified property definition for this instance if visible.

Specified by:

getInstancePropertyDefinitionIfVisible in interface IPropertyProvider

Parameters:

name - the name of the property

Returns:

the definition of the property

Throws:

Exception - if the user does not have permission to access the property

getInstancePropertyDefinitions

@ThingworxExtensionApiMethod(since={6,6})
public PropertyDefinitionCollection getInstancePropertyDefinitions()

Description copied from interface: IPropertyProvider

Returns a collection containing all property definitions belonging to this instance.

Specified by:

getInstancePropertyDefinitions in interface IPropertyProvider

Returns:

a collection of property definitions

getLanguage

@ThingworxExtensionApiMethod(since={7,4})
public String getLanguage()

Get the user's language preferences.

Returns:

{String} an ordered, comma-separated list of language preferences, best choice first.

getPropertyValue

@ThingworxExtensionApiMethod(since={6,6})
public IPrimitiveType getPropertyValue(String propertyName)
                                throws Exception

Description copied from interface: IPropertyProvider

Returns the value currently assigned to the specified property.

Specified by:

getPropertyValue in interface IPropertyProvider

Parameters:

propertyName - the name of the property to retrieve the value of

Returns:

the property's current value

Throws:

Exception - if propName is null, the user is unauthorized (when applicable), or an error occurs while attempting to read from the property

getPropertyType

@ThingworxExtensionApiMethod(since={6,6})
public BaseTypes getPropertyType(String propertyName)

Description copied from interface: IPropertyProvider

Returns the base type defined in the specified property's definition.

Specified by:

getPropertyType in interface IPropertyProvider

Parameters:

propertyName - the name of the property

Returns:

the BaseTypes entry corresponding to the property type

hasProperty

@ThingworxExtensionApiMethod(since={6,6})
public boolean hasProperty(String propertyName)

Description copied from interface: IPropertyProvider

Returns true if there exists a property with the specified name. Property names are case-sensitive.

Specified by:

hasProperty in interface IPropertyProvider

Parameters:

propertyName - the property name to check

Returns:

true if the specified property exists

hasPropertyAndIsVisible

@ThingworxExtensionApiMethod(since={9,0})
public boolean hasPropertyAndIsVisible(String propertyName)
                                throws Exception

Description copied from interface: IPropertyProvider

Returns true if there exists a property with the specified name and is visible to the user. Property names are case-sensitive.

Specified by:

hasPropertyAndIsVisible in interface IPropertyProvider

Parameters:

propertyName - the property name to check

Returns:

true if the specified property exists and is visible

Throws:

Exception - if the user does not have permission to access the property

getPropertyValuesAsInfoTable

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable getPropertyValuesAsInfoTable()
                                       throws Exception

Description copied from interface: IPropertyProvider

Returns an InfoTable containing a list of the properties belonging to this instance and their values.

Specified by:

getPropertyValuesAsInfoTable in interface IPropertyProvider

Returns:

an InfoTable of property names and their associated values

Throws:

Exception - if the user does not have permission to access the properties (when applicable), or an error occurs when attempting to read the property values

setPropertyValue

@ThingworxExtensionApiMethod(since={6,6})
public void setPropertyValue(String propertyName,
 IPrimitiveType value)
                      throws Exception

Description copied from interface: IPropertyProvider

Assigns the provided value to the specified property.

Specified by:

setPropertyValue in interface IPropertyProvider

Parameters:

propertyName - the name of the property that is being modified

value - the value to assign to the property

Throws:

Exception - if propertyName is null, the user is unauthorized (when applicable), the specified property does not exist, or an error occurs when attempting to modify the property

getEntityType

@ThingworxExtensionApiMethod(since={6,6})
public RelationshipTypes.ThingworxRelationshipTypes getEntityType()

Description copied from class: RootEntity

Returns the type of this entity.

Specified by:

getEntityType in class RootEntity

Returns:

the entity type

GetPropertyValues

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetPropertyValues()
                            throws Exception

Service Category:

Properties

Service Description:

Get the current property values for this thing.

Returns:

result Property values - INFOTABLE

Throws:

Exception - if an error occurs

SetPropertyValues

@ThingworxExtensionApiMethod(since={6,6})
public void SetPropertyValues(InfoTable values)
                       throws Exception

Service Category:

Properties

Service Description:

Get a subset of the current property values for this thing.

Parameters:

values - Property values - INFOTABLE

Throws:

Exception - if an error occurs

GetNamedPropertyValues

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetNamedPropertyValues(InfoTable propertyNames)
                                 throws Exception

Service Category:

Properties

Service Description:

Get a subset of the current property values for this thing.

Parameters:

propertyNames - Property names - INFOTABLE

Returns:

result Property values - INFOTABLE

Throws:

Exception - if an error occurs

GetPropertyValuesVTQ

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetPropertyValuesVTQ()
                               throws Exception

Service Category:

Properties

Service Description:

Get the current property values for this thing as VTQ.

Returns:

result Property values - INFOTABLE

Throws:

Exception - if an error occurs

GetNamedPropertyValuesVTQ

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable GetNamedPropertyValuesVTQ(InfoTable propertyNames)
                                    throws Exception

Service Category:

Properties

Service Description:

Get the current property values for this thing as VTQ.

Parameters:

propertyNames - Property names - INFOTABLE

Returns:

result Property values - INFOTABLE - Aspects {isMultiRow: false}

Throws:

Exception - if an error occurs

GetPropertyQuality

@ThingworxExtensionApiMethod(since={6,6})
public String GetPropertyQuality(String propertyName)
                          throws Exception

Service Category:

Properties

Service Description:

Get the quality for a specific property.

Parameters:

propertyName - Property name - STRING

Returns:

Quality Quality value - STRING

Throws:

Exception - if an error occurs

GetPropertyTime

@ThingworxExtensionApiMethod(since={6,6})
public org.joda.time.DateTime GetPropertyTime(String propertyName)
                                       throws Exception

Service Category:

Properties

Service Description:

Get the timestamp for a specific property.

Parameters:

propertyName - Property name - STRING

Returns:

Time Time value - DATETIME

Throws:

Exception - if an error occurs

SetConfigurationTable

@ThingworxExtensionApiMethod(since={6,6})
public final void SetConfigurationTable(String tableName,
 InfoTable configurationTable,
 Boolean persistent)
                                 throws Exception

Service Category:

Configuration

Service Description:

Set an entire configuration table.

Overrides:

SetConfigurationTable in class RootEntity

Parameters:

tableName - Configuration table name - STRING

configurationTable - Configuration table content - INFOTABLE

persistent - Persist these changes - BOOLEAN

Throws:

Exception - if an error occurs

SetMultiRowConfigurationTable

@ThingworxExtensionApiMethod(since={6,6})
public final void SetMultiRowConfigurationTable(String tableName,
 InfoTable configurationTable,
 Boolean persistent)
                                         throws Exception

Service Category:

Configuration

Service Description:

Set an entire multi-row configuration table.

Overrides:

SetMultiRowConfigurationTable in class RootEntity

Parameters:

tableName - Configuration table name - STRING

configurationTable - Configuration table content - INFOTABLE

persistent - Persist these changes - BOOLEAN

Throws:

Exception - if an error occurs

SetConfigurationTableRows

@ThingworxExtensionApiMethod(since={6,6})
public final void SetConfigurationTableRows(String tableName,
 InfoTable values,
 Boolean persistent)
                                     throws Exception

Service Category:

Configuration

Service Description:

Update/add one or more rows in a multi-row configuration table.

Overrides:

SetConfigurationTableRows in class RootEntity

Parameters:

tableName - Configuration table name - STRING

values - Configuration table rows to modify - INFOTABLE

persistent - Persist these changes - BOOLEAN

Throws:

Exception - if an error occurs

DeleteConfigurationTable

@ThingworxExtensionApiMethod(since={6,6})
public final void DeleteConfigurationTable(String tableName,
 Boolean persistent)
                                    throws Exception

Service Category:

Configuration

Service Description:

Delete an entire configuration table.

Overrides:

DeleteConfigurationTable in class RootEntity

Parameters:

tableName - Configuration table name - STRING

persistent - Persist these changes - BOOLEAN

Throws:

Exception - if an error occurs

DeleteConfigurationTableRows

@Deprecated
@ThingworxExtensionApiMethod(since={6,6},
                             deprecatedSince={9,6})
public void DeleteConfigurationTableRows(String tableName,
 InfoTable values,
 Boolean persistent)
                                  throws Exception

Deprecated.

Overrides:

DeleteConfigurationTableRows in class RootEntity

Throws:

Exception

DeleteConfigurationTableRows

@ThingworxExtensionApiMethod(since={9,6})
public final void DeleteConfigurationTableRows(String tableName,
 InfoTable values,
 Boolean persistent,
 Boolean removeAllMatchingRows)
                                        throws Exception

Service Category:

Configuration

Service Description:

Delete one or more rows from a multi-row configuration table.

Overrides:

DeleteConfigurationTableRows in class RootEntity

Parameters:

tableName - Configuration table name - STRING

values - Configuration table rows to modify - INFOTABLE

persistent - Persist these changes - BOOLEAN

removeAllMatchingRows - It will remove all matching rows if value is true - BOOLEAN

Throws:

Exception - if an error occurs

DeleteAllConfigurationTableRows

@ThingworxExtensionApiMethod(since={6,6})
public final void DeleteAllConfigurationTableRows(String tableName,
 Boolean persistent)
                                           throws Exception

Service Category:

Configuration

Service Description:

Delete all rows from a multi-row configuration table.

Overrides:

DeleteAllConfigurationTableRows in class RootEntity

Parameters:

tableName - Configuration table name - STRING

persistent - Persist these changes - BOOLEAN

Throws:

Exception - if an error occurs