Package 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, ISupportsDeprecation, IDiffableObject, IAvatar, IEntityLifeCycleEvent, IPersistable, IServiceProvider, ITaggableObject, IDependencyScannableObject, IVersionedEntity, IEntityDefinition, IPersistableObject<String>, IDesignTimeSecurable, IDesignTimeSecurableEntity, IRunTimeSecurable, IRunTimeSecurableEntity, ISecurable, IVisibilitySecurable, IVisibilitySecurableEntity, IAspectContainer, INamedObject, Serializable
@ThingworxExtensionApiClass(since={7,1}, canInstantiate=true) public class Project extends ServiceProviderEntity implements IVersionedEntity
See Also:

  • Field Details

  • Constructor Details

    • Project

      public Project()

  • Method Details

    • getEntityVersion

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

    • GetVersion

      @ThingworxExtensionApiMethod(since={8,5}) public String GetVersion()
      Service Category:
      Projects
      Service Description:
      Get Project version.


      Get Project version
      Returns:
      String Project version

    • getGroupId

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

    • GetGroupId

      @ThingworxExtensionApiMethod(since={8,5}) public 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 String getArtifactId()

    • GetArtifactId

      @ThingworxExtensionApiMethod(since={8,5}) public 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 String getPublishResult()

    • GetPublishResult

      @ThingworxExtensionApiMethod(since={8,5}) public org.json.JSONObject GetPublishResult()
      Returns:
      result Publish Result - JSON

      Get Publish Result

    • getMinPlatformVersion

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

    • GetMinPlatformVersion

      @ThingworxExtensionApiMethod(since={8,5}) public String GetMinPlatformVersion()
      Service Category:
      Projects
      Service Description:
      Get minimum Platform version.
      Returns:
      result Minimum Platform version - STRING

      Get minimum Platform version

    • getAllDependentProjectNames

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


      Get all of the entities in this project
      Returns:
      EntityReferenceCollection of all the entities in the project
      Throws:
      Exception

    • GetEntities

      @ThingworxExtensionApiMethod(since={7,1}) public InfoTable GetEntities() throws 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:
      Exception

    • GetEntityTypeCounts

      @ThingworxExtensionApiMethod(since={9,1}) public InfoTable GetEntityTypeCounts() throws Exception
      Service Category:
      Projects
      Service Description:
      Get the Entity type counts of the project.


      Get Project's Entity counts by entity type.
      Returns:
      InfoTable with DataShape EntityCount
      Throws:
      Exception

    • ClearEntities

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


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

      When entity project changed it also validates the entity and its characteristics accessModifier.

      • If entity has invalid accessModifier then this method updates its accessModifier to Projects defaultaccessModifier if present otherwise updates to PRIVATE.
      • If entity characteristics(property, service and configuration table) has invalid accessModifier then method removes characteristics accessModifier.
      Throws:
      Exception

    • ListExternalDependencies

      @ThingworxExtensionApiMethod(since={8,5}) public InfoTable ListExternalDependencies() throws 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:
      Exception

    • UpdateProjectDependencies

      @ThingworxExtensionApiMethod(since={9,1}) public void UpdateProjectDependencies() throws Exception
      Service Category:
      Projects
      Service Description:
      Updates current project's 'depends-on Projects' list by scanning entity set's external dependencies.


      Updates current project's dependencies by scanning project and project's entity set external dependencies
      Overrides:
      UpdateProjectDependencies in class RootEntity
      Throws:
      Exception

    • SetEntities

      @ThingworxExtensionApiMethod(since={7,1}) public void SetEntities(InfoTable entities) throws 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.

      When entity project changed it also validates the entity and its characteristics accessModifier.

      • If entity has invalid accessModifier then this method updates its accessModifier to Projects defaultaccessModifier if present otherwise updates to PRIVATE.
      • If entity characteristics(property, service and configuration table) has invalid accessModifier then method removes characteristics accessModifier.
      Parameters:
      entities - - InfoTable with DataShape EntityReference
      Throws:
      Exception

    • AddEntities

      @ThingworxExtensionApiMethod(since={7,1}) public void AddEntities(String searchExpression, TagCollection tags, org.json.JSONObject types) throws 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.

      When entity project changed it also validates the entity and its characteristics accessModifier.

      • If entity has invalid accessModifier then this method updates its accessModifier to Projects defaultaccessModifier if present otherwise updates to PRIVATE.
      • If entity characteristics(property, service and configuration table) has invalid accessModifier then method removes characteristics accessModifier.
      Parameters:
      searchExpression - - String compatible with Searcher.SearchModelEntities
      tags - - TagCollection of tags to match
      types - - JSONObject compatible with the types parameter of Searcher.SearchModelEntities
      Throws:
      Exception

    • SearchStructure

      @ThingworxExtensionApiMethod(since={9,1}) public org.json.JSONObject SearchStructure(org.json.JSONObject query) throws Exception


      Get/Search Project's entity names and its total counts by type based on matching query filter and pagination parameters.
      Parameters:
      query - JSON query input which is used for filter and pagination.
      Returns:
      JSON Object which returns entity names and its total count.
      Throws:
      Exception

    • GetAllDependentProjectNames

      @ThingworxExtensionApiMethod(since={7,1}) public InfoTable GetAllDependentProjectNames() throws 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:
      Exception

    • PublishSolution

      @ThingworxExtensionApiMethod(since={8,5}) public org.json.JSONObject PublishSolution() throws Exception
      Returns:
      result Publish result - JSON

      Publish solution
      Throws:
      Exception

    • fromJSON

      @Deprecated @ThingworxExtensionApiMethod(since={7,1}, deprecatedSince={8,4}) public static Project fromJSON(org.json.JSONObject jsonObject) throws Exception
      Deprecated.
      Throws:
      Exception - If an error occurs