Package com.thingworx.resources.admin

Class ScriptServices

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.entities.ExtensibleRootEntity

com.thingworx.resources.Resource

com.thingworx.resources.admin.ScriptServices

All Implemented Interfaces:

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

@ThingworxExtensionApiClass(since={6,6},
                            canInstantiate=true)
public class ScriptServices
extends Resource

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static org.slf4j.Logger	_errorLogger

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
ScriptServices()	Initializes this instace with default values.

Method Summary

Modifier and Type	Method	Description
InfoTable	CheckScript(String script)	Service Category: Scripting Service Description: Validate script syntax.
InfoTable	CheckScriptWithLinesAndColumns(String script)	Service Category: Scripting Service Description: Validate script syntax, returns with the line and column number.

Methods inherited from class com.thingworx.resources.Resource

getEntityType

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, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, DeleteConfigurationTableRows, DeleteConfigurationTableRows, 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, SetConfigurationTable, SetConfigurationTableRows, SetDescription, setDesignTimePermissions, SetDesignTimePermissionsAsJSON, setDocumentationContent, setExtensionObject, SetHomeMashup, setLastModifiedDate, SetMultiRowConfigurationTable, setOwner, SetOwner, SetProjectName, setRunTimePermissions, SetRunTimePermissionsAsJSON, setStringConfigurationSetting, SetTags, 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.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

_errorLogger

public static org.slf4j.Logger _errorLogger

Constructor Details

ScriptServices

public ScriptServices()

Initializes this instace with default values.

Method Details

CheckScript

@ThingworxExtensionApiMethod(since={6,6})
public InfoTable CheckScript(String script)
                      throws Exception

Service Category:

Scripting

Service Description:

Validate script syntax.

Parameters:

script - Script content - STRING

Returns:

result Result of compilation - INFOTABLE - Aspects {dataShape:GenericResult}

Throws:

Exception - if an error occurs

CheckScriptWithLinesAndColumns

@ThingworxExtensionApiMethod(since={7,3})
public InfoTable CheckScriptWithLinesAndColumns(String script)
                                         throws Exception

Service Category:

Scripting

Service Description:

Validate script syntax, returns with the line and column number.

Parameters:

script - Script content - STRING

Returns:

result Result of compilation - INFOTABLE - Aspects {dataShape:ScriptServiceResult}

Throws:

Exception - if an error occurs