com.microsoft.tfs.core.clients.build
Interface IProcessTemplate


public interface IProcessTemplate


Method Summary
 void copyFrom(IProcessTemplate source)
          Copies properties from a source process template to this instance.
 void delete()
          Deletes the build process template from the server.
 java.lang.String download()
          Downloads the latest version of the build process template.
 java.lang.String download(java.lang.String versionSpec)
          Downloads the build process template at the version specified by version control version specifier.
 java.lang.String getDescription()
          The description of the build process template.
 int getID()
          Gets the identifier for this process template.
 java.lang.String getParameters()
          The process templates parameters.
 java.lang.String getServerPath()
          The version control path of the build process file.
 BuildReason getSupportedReasons()
          The valid build reasons that are supported by this build process template.
 java.lang.String getTeamProject()
          The Team Project for this process template.
 ProcessTemplateType getTemplateType()
          The type of the build process template.
 java.lang.String getVersion()
          Gets the version of this process template.
 void save()
          Saves the build process template to the server.
 void setDescription(java.lang.String value)
           
 void setSupportedReasons(BuildReason value)
           
 void setTemplateType(ProcessTemplateType value)
           
 

Method Detail

getID

int getID()
Gets the identifier for this process template.

Returns:

getTeamProject

java.lang.String getTeamProject()
The Team Project for this process template.

Returns:

getServerPath

java.lang.String getServerPath()
The version control path of the build process file.

Returns:

getTemplateType

ProcessTemplateType getTemplateType()
The type of the build process template. This property is for system use and should be set to ProcessTemplateType.Custom for all user defined templates.

Returns:

setTemplateType

void setTemplateType(ProcessTemplateType value)

getDescription

java.lang.String getDescription()
The description of the build process template.

Returns:

setDescription

void setDescription(java.lang.String value)

getSupportedReasons

BuildReason getSupportedReasons()
The valid build reasons that are supported by this build process template.

Returns:

setSupportedReasons

void setSupportedReasons(BuildReason value)

getParameters

java.lang.String getParameters()
The process templates parameters. This property is the root DynamicActivity of the build process along with all top-level arguments and properties serialized as XAML.

Returns:

getVersion

java.lang.String getVersion()
Gets the version of this process template.

Returns:

download

java.lang.String download()
Downloads the latest version of the build process template. The build process is downloaded to a temporary file and deleted after reading the file contents.

Returns:
The entire build process template as a string.

download

java.lang.String download(java.lang.String versionSpec)
Downloads the build process template at the version specified by version control version specifier. The build process is downloaded to a temporary file and deleted after reading the file contents.

Parameters:
versionSpec - Any valid version control version specifier in string form.
Returns:
The entire build process template as a string.

save

void save()
Saves the build process template to the server.


delete

void delete()
Deletes the build process template from the server.


copyFrom

void copyFrom(IProcessTemplate source)
Copies properties from a source process template to this instance.

Parameters:
source - Template to copy from


© 2015 Microsoft. All rights reserved.