com.thingworx.resources.sourcecontrol

Class SourceControlFunctions

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.sourcecontrol.SourceControlFunctions

All Implemented Interfaces:

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

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

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
SourceControlFunctions()

Method Summary

Modifier and Type	Method and Description
void	ExportSourceControlledEntities(java.lang.String repositoryName, java.lang.String path, java.lang.String collection, TagCollection tags, org.joda.time.DateTime startDate, org.joda.time.DateTime endDate, java.lang.String projectName, java.lang.Boolean includeDependents) Service Category: Exports Service Description: Export a list of entities for source control.
java.lang.String	ExportSourceControlledEntitiesToZipFile(java.lang.String repositoryName, java.lang.String path, java.lang.String name, java.lang.String collection, TagCollection tags, org.joda.time.DateTime startDate, org.joda.time.DateTime endDate, java.lang.String projectName, java.lang.Boolean includeDependents) Service Category: Exports Service Description: Export a list of entities for source control.

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, 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

SourceControlFunctions

public SourceControlFunctions()

Method Detail

ExportSourceControlledEntities

@ThingworxExtensionApiMethod(since={6,6})
public void ExportSourceControlledEntities(java.lang.String repositoryName,
                                                                                     java.lang.String path,
                                                                                     java.lang.String collection,
                                                                                     TagCollection tags,
                                                                                     org.joda.time.DateTime startDate,
                                                                                     org.joda.time.DateTime endDate,
                                                                                     java.lang.String projectName,
                                                                                     java.lang.Boolean includeDependents)
                                                                              throws java.lang.Exception

Service Category:

Exports

Service Description:

Export a list of entities for source control.

Parameters:

repositoryName - File repository to which to export the content - THINGNAME

path - Path to which to write the content - STRING

collection - Collection name you wish to export (optional) - STRING

tags - Tags (optional) - TAGS

startDate - Date and time from which to export entities by their last modified date (optional) - DATETIME

endDate - Date and time to which to export entities by their last modified date (optional) - DATETIME

projectName - Project name (optional) - PROJECTNAME

includeDependents - Include dependent projects (optional) - BOOLEAN

Throws:

java.lang.Exception - If an error occurs

ExportSourceControlledEntitiesToZipFile

@ThingworxExtensionApiMethod(since={6,6})
public java.lang.String ExportSourceControlledEntitiesToZipFile(java.lang.String repositoryName,
                                                                                                          java.lang.String path,
                                                                                                          java.lang.String name,
                                                                                                          java.lang.String collection,
                                                                                                          TagCollection tags,
                                                                                                          org.joda.time.DateTime startDate,
                                                                                                          org.joda.time.DateTime endDate,
                                                                                                          java.lang.String projectName,
                                                                                                          java.lang.Boolean includeDependents)
                                                                                                   throws java.lang.Exception

Service Category:

Exports

Service Description:

Export a list of entities for source control.

Parameters:

repositoryName - File repository to which to export the content - THINGNAME

path - Path to which to write the content - STRING

name - File name to which to write the content - STRING

collection - Collection name you wish to export (optional) - STRING

tags - Tags (optional) - TAGS

startDate - Date and time from which to export entities by their last modified date (optional) - DATETIME

endDate - Date and time to which to export entities by their last modified date (optional) - DATETIME

projectName - Project name - PROJECTNAME

includeDependents - Include dependent projects - BOOLEAN

Returns:

result Path to exported entities - HYPERLINK

Throws:

java.lang.Exception - If an error occurs