Package 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, 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 SourceControlFunctions
extends Resource

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

Method Summary

Modifier and Type	Method	Description
void	ExportSourceControlledEntities(String repositoryName, String path, String collection, TagCollection tags, org.joda.time.DateTime startDate, org.joda.time.DateTime endDate, String projectName, Boolean includeDependents)
void	ExportSourceControlledEntities(String repositoryName, String path, String collection, TagCollection tags, org.joda.time.DateTime startDate, org.joda.time.DateTime endDate, String projectName, Boolean includeDependents, Boolean exportMatchingModelTags)	Service Category: Exports Service Description: Export a list of entities for source control.
String	ExportSourceControlledEntitiesToZipFile(String repositoryName, String path, String name, String collection, TagCollection tags, org.joda.time.DateTime startDate, org.joda.time.DateTime endDate, String projectName, Boolean includeDependents)
String	ExportSourceControlledEntitiesToZipFile(String repositoryName, String path, String name, String collection, TagCollection tags, org.joda.time.DateTime startDate, org.joda.time.DateTime endDate, String projectName, Boolean includeDependents, Boolean exportMatchingModelTags)	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, 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

Constructor Details

SourceControlFunctions

public SourceControlFunctions()

Method Details

ExportSourceControlledEntities

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

Throws:

Exception - If an error occurs

ExportSourceControlledEntities

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

Service Category:

Exports

Service Description:

Export a list of entities for source control.

Parameters:

repositoryName -

path -

collection -

tags -

startDate -

endDate -

projectName -

includeDependents -

exportMatchingModelTags - : Specify Export Behavior when exporting entities using model tags. TRUE, indicates that an entity must have all specified Model Tags in order to be exported. FALSE, indicates that an entity must have at least one of the specified Model Tags in order to be exported.

Throws:

Exception

ExportSourceControlledEntitiesToZipFile

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

Throws:

Exception - If an error occurs

ExportSourceControlledEntitiesToZipFile

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

Service Category:

Exports

Service Description:

Export a list of entities for source control.

Parameters:

repositoryName -

path -

name -

collection -

tags -

startDate -

endDate -

projectName -

includeDependents -

exportMatchingModelTags - : Specify Export Behavior when exporting entities using model tags. TRUE, indicates that an entity must have all specified Model Tags in order to be exported. FALSE, indicates that an entity must have at least one of the specified Model Tags in order to be exported.

Returns:

Throws:

Exception