com.thingworx.projects

Class Project

java.lang.Object

com.thingworx.types.NamedObject

com.thingworx.persistence.common.PersistableNamedObject

com.thingworx.entities.RootEntity

com.thingworx.entities.ServiceProviderEntity

com.thingworx.projects.Project

All Implemented Interfaces:

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

@ThingworxExtensionApiClass(since={7,1},
                            canInstantiate=true)
public class Project
extends ServiceProviderEntity
implements IVersionedEntity

See Also:

Serialized Form

Field Summary

Fields inherited from class com.thingworx.entities.RootEntity

BASIC_PROPERTIES

Fields inherited from class com.thingworx.types.NamedObject

NAME_COMPARATOR

Constructor Summary

Constructors

Constructor and Description
Project()

Method Summary

Modifier and Type	Method and Description
void	AddEntities(java.lang.String searchExpression, TagCollection tags, org.json.JSONObject types) Service Category: Projects Service Description: Adds to the project of all model entities filtered by keyword query and tags. Add entities to this project based on the combination of a search expression, tags and types.
void	ClearEntities() Remove this project from all of the entities that have it.
static Project	fromJSON(org.json.JSONObject jsonObject) Deprecated.
java.util.Set<java.lang.String>	getAllDependentProjectNames()
InfoTable	GetAllDependentProjectNames() Service Category: Projects Service Description: Get list of all of the projects that this project depends on, including itself. Get list of all of the projects that this project depends on, including itself
java.lang.String	getArtifactId()
java.lang.String	GetArtifactId() Service Category: Projects Service Description: Get Project artifact id. Get Project artifact id
InfoTable	GetEntities() Service Category: Projects Service Description: Get the entities of the project. Get a reference to all of the entities in this project
RelationshipTypes.ThingworxRelationshipTypes	getEntityType()
EntityVersion	getEntityVersion()
java.lang.String	getGroupId()
java.lang.String	GetGroupId() Service Category: Projects Service Description: Get Project group id. Get Project group id
java.lang.String	getMinPlatformVersion()
java.lang.String	GetMinPlatformVersion() Service Category: Projects Service Description: Get minimum Platform version. Get minimum Platform version
EntityReferenceCollection	getProjectEntities() Get all of the entities in this project
java.lang.String	getPublishResult()
org.json.JSONObject	GetPublishResult() Get Publish Result
java.lang.String	GetVersion() Service Category: Projects Service Description: Get Project version. Get Project version
InfoTable	ListExternalDependencies() Service Category: Projects Service Description: Lists the first level project external dependencies.
org.json.JSONObject	PublishSolution() Publish solution
void	SetEntities(InfoTable entities) Service Category: Projects Service Description: Set the entities for a project.

Methods inherited from class com.thingworx.entities.ServiceProviderEntity

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

Methods inherited from class com.thingworx.entities.RootEntity

AddConfigurationTableDefinition, addDesignTimePermission, AddDesignTimePermission, addRunTimePermission, AddRunTimePermission, AddTags, addVisibilityPermission, AddVisibilityPermission, CheckDesignTimePermission, CheckDesignTimePermissionForGroup, CheckDesignTimePermissionForUser, CheckPermission, CheckPermissionForGroup, CheckPermissionForUser, cleanupEntity, cleanupEntity, DeleteAllConfigurationTableRows, DeleteConfigurationTable, 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, 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, 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, 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.IPersistable

getID, hasID

Methods inherited from interface com.thingworx.types.INamedObject

getDescription, getName

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

getID, getName

Constructor Detail

Project

public Project()

Method Detail

getEntityVersion

@ThingworxExtensionApiMethod(since={7,1})
public EntityVersion getEntityVersion()

GetVersion

@ThingworxExtensionApiMethod(since={8,5})
public java.lang.String GetVersion()

Service Category:

Projects

Service Description:

Get Project version.

Get Project version

Returns:

String Project version

getGroupId

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

GetGroupId

@ThingworxExtensionApiMethod(since={8,5})
public java.lang.String GetGroupId()

Service Category:

Projects

Service Description:

Get Project group id.

Get Project group id

Returns:

String Project group id

getArtifactId

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

GetArtifactId

@ThingworxExtensionApiMethod(since={8,5})
public java.lang.String GetArtifactId()

Service Category:

Projects

Service Description:

Get Project artifact id.

Get Project artifact id

Returns:

String Project artifact id

getPublishResult

@ThingworxExtensionApiMethod(since={8,5})
public java.lang.String getPublishResult()

GetPublishResult

@ThingworxExtensionApiMethod(since={8,5})
public org.json.JSONObject GetPublishResult()

Get Publish Result

Returns:

getMinPlatformVersion

@ThingworxExtensionApiMethod(since={8,5})
public java.lang.String getMinPlatformVersion()

GetMinPlatformVersion

@ThingworxExtensionApiMethod(since={8,5})
public java.lang.String GetMinPlatformVersion()

Service Category:

Projects

Service Description:

Get minimum Platform version.

Get minimum Platform version

Returns:

getAllDependentProjectNames

@ThingworxExtensionApiMethod(since={7,1})
public java.util.Set<java.lang.String> getAllDependentProjectNames()

getEntityType

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

getProjectEntities

@ThingworxExtensionApiMethod(since={7,1})
public EntityReferenceCollection getProjectEntities()
                                                                                       throws java.lang.Exception

Get all of the entities in this project

Returns:

EntityReferenceCollection of all the entities in the project

Throws:

java.lang.Exception

GetEntities

@ThingworxExtensionApiMethod(since={7,1})
public InfoTable GetEntities()
                                                                throws java.lang.Exception

Service Category:

Projects

Service Description:

Get the entities of the project.

Get a reference to all of the entities in this project

Returns:

InfoTable with DataShape EntityReference

Throws:

java.lang.Exception

ClearEntities

@ThingworxExtensionApiMethod(since={7,1})
public void ClearEntities()
                                                             throws java.lang.Exception

Remove this project from all of the entities that have it.

Throws:

java.lang.Exception

ListExternalDependencies

@ThingworxExtensionApiMethod(since={8,5})
public InfoTable ListExternalDependencies()
                                                                             throws java.lang.Exception

Service Category:

Projects

Service Description:

Lists the first level project external dependencies.

Returns:

result List first level external dependencies of project - INFOTABLE - Aspects {dataShape:EntityDependency}

Lists all the external dependencies of this project.

Throws:

java.lang.Exception

SetEntities

@ThingworxExtensionApiMethod(since={7,1})
public void SetEntities(InfoTable entities)
                                                           throws java.lang.Exception

Service Category:

Projects

Service Description:

Set the entities for a project. This clears entities from the project first.

Set this project on all of the entities in the entities list. It first clears all entities, then sets the projectName of each entity in the entities list.

Parameters:

entities - - InfoTable with DataShape EntityReference

Throws:

java.lang.Exception

AddEntities

@ThingworxExtensionApiMethod(since={7,1})
public void AddEntities(java.lang.String searchExpression,
                                                                  TagCollection tags,
                                                                  org.json.JSONObject types)
                                                           throws java.lang.Exception

Service Category:

Projects

Service Description:

Adds to the project of all model entities filtered by keyword query and tags.

Add entities to this project based on the combination of a search expression, tags and types. For each entity found, set the projectName to this project.

Parameters:

searchExpression - - String compatible with Searcher.SearchModelEntities

tags - - TagCollection of tags to match

types - - JSONObject compatible with the types parameter of Searcher.SearchModelEntities

Throws:

java.lang.Exception

GetAllDependentProjectNames

@ThingworxExtensionApiMethod(since={7,1})
public InfoTable GetAllDependentProjectNames()
                                                                                throws java.lang.Exception

Service Category:

Projects

Service Description:

Get list of all of the projects that this project depends on, including itself.

Get list of all of the projects that this project depends on, including itself

Returns:

InfoTable with DataShape GenericStringList

Throws:

java.lang.Exception

PublishSolution

@ThingworxExtensionApiMethod(since={8,5})
public org.json.JSONObject PublishSolution()
                                                                              throws java.lang.Exception

Publish solution

Returns:

Throws:

java.lang.Exception

fromJSON

@Deprecated
 @ThingworxExtensionApiMethod(since={7,1},
                             deprecatedSince={8,4})
public static Project fromJSON(org.json.JSONObject jsonObject)
                                                                                                                                   throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception - If an error occurs