Package com.thingworx.extensibility

Class ExtensionPackage

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.extensibility.ExtensionPackage

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={7,0,3},
                            canInstantiate=true)
public class ExtensionPackage
extends ExtensibleRootEntity
implements IServiceProvider

See Also:

• Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
String	getArtifactId()
String	getBuildNumber()
RelationshipTypes.ThingworxRelationshipTypes	getEntityType()	Returns the type of this entity.
InfoTable	GetExtensionDependencyDetails()	Service Category: Service Description: Get Extension Dependency Details.
InfoTable	GetExtensionDetails()	Service Category: Extensions Service Description: get a list of EntityDescriptors for Extensions associated with this Extension Package.
InfoTable	GetExtensionsInUse()	Service Category: Extensions Service Description: get a list of Entities that are currently using Extensions associated with this Extension Package.
String	getGroupId()
boolean	getHaCompatible()
String	getMinimumThingworxVersion()
String	getNameVersion()
EntityVersion	getPackageVersion()
String	getVendor()
boolean	isApplicationRuntimeRequired()

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.entities.interfaces.IServiceProvider

getInstancePublicServiceDefinitions, getInstanceServiceDefinition, getInstanceServiceDefinitions, processAPIServiceRequest, processServiceRequest

Methods inherited from interface com.thingworx.deprecation.ISupportsDeprecation

getDeprecated, isDeprecated, isDeprecatedBefore, since

Constructor Details

ExtensionPackage

public ExtensionPackage()

Initializes this instace with default values.

Method Details

getNameVersion

@ThingworxExtensionApiMethod(since={7,0,3})
public String getNameVersion()

getPackageVersion

@ThingworxExtensionApiMethod(since={7,0,3})
public EntityVersion getPackageVersion()

getBuildNumber

@ThingworxExtensionApiMethod(since={7,0,3})
public String getBuildNumber()

getMinimumThingworxVersion

@ThingworxExtensionApiMethod(since={7,0,3})
public String getMinimumThingworxVersion()

getHaCompatible

@ThingworxExtensionApiMethod(since={9,0})
public boolean getHaCompatible()

getVendor

@ThingworxExtensionApiMethod(since={7,0,3})
public String getVendor()

getGroupId

@ThingworxExtensionApiMethod(since={8,5})
public String getGroupId()

getArtifactId

@ThingworxExtensionApiMethod(since={8,5})
public String getArtifactId()

isApplicationRuntimeRequired

@ThingworxExtensionApiMethod(since={9,0})
public boolean isApplicationRuntimeRequired()

GetExtensionDetails

@ThingworxExtensionApiMethod(since={7,0,3})
public InfoTable GetExtensionDetails()
                              throws Exception

Service Category:

Extensions

Service Description:

get a list of EntityDescriptors for Extensions associated with this Extension Package.

Returns:

result Result - INFOTABLE - Aspects {dataShape:EntityDescriptor}

Throws:

Exception - if an error occurs

GetExtensionsInUse

@ThingworxExtensionApiMethod(since={7,0,3})
public InfoTable GetExtensionsInUse()
                             throws Exception

Service Category:

Extensions

Service Description:

get a list of Entities that are currently using Extensions associated with this Extension Package.

Returns:

result Result - INFOTABLE - Aspects {dataShape:NetworkConnection}

Throws:

Exception - if an error occurs

GetExtensionDependencyDetails

@ThingworxExtensionApiMethod(since={9,1})
public InfoTable GetExtensionDependencyDetails()
                                        throws Exception

Service Category:

Service Description:

Get Extension Dependency Details.

Gets extension dependency information.

Returns:

Returns an Infotable with information like installed extension version, dependent extension and which other extension(s) are using this extension.

Throws:

Exception - if any failures when getting the extension dependency details.

getEntityType

@ThingworxExtensionApiMethod(since={7,0,3})
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