com.microsoft.tfs.core.clients.commonstructure
Class CommonStructureClient

java.lang.Object
  extended by com.microsoft.tfs.core.clients.commonstructure.CommonStructureClient

public class CommonStructureClient
extends java.lang.Object

Accesses the Team Foundation Server common structure web services.

Since:
TEE-SDK-10.1

Constructor Summary
CommonStructureClient(TFSTeamProjectCollection connection, ms.tfs.services.classification._03._ClassificationSoap webService, ms.tfs.services.classification._03._Classification4Soap webService4)
           
 
Method Summary
 void clearProjectInfoCache()
          Clears the project information cache.
 java.lang.String createNode(java.lang.String nodeName, java.lang.String parentNodeUri)
          Creates a new node in a classification service structure.
 java.lang.String createNode(java.lang.String nodeName, java.lang.String parentNodeUri, java.util.Calendar startDate, java.util.Calendar finishDate)
           
 void deleteBranches(java.lang.String[] nodeUris, java.lang.String reclassifyUri)
          Deletes one or more branches
 void deleteProject(java.lang.String projectUri)
          Deletes a project context and the associated structures
 java.lang.String getChangedNodes(int firstSequenceId)
          Gets the set of changed nodes with an ID greater than a specified ID.
 TFSTeamProjectCollection getConnection()
           
 CSSNode[] getCSSNodes(java.lang.String[] rootNodeUris, boolean includeChildren)
           
 CSSNode getCSSNodes(java.lang.String rootNodeUri, boolean includeChildren)
           
 NodeInfo getNode(java.lang.String nodeUri)
          Gets a NodeInfo structure using a node URI
 NodeInfo getNodeFrom(java.lang.String nodePath)
          Gets a NodeInfo structure using a node pathname.
 ProjectInfo getProject(java.lang.String projectUri)
           
 ProjectInfo getProjectFromName(java.lang.String projectName)
          Gets a ProjectInfo structure using a project name
 ProjectProperty getProjectProperty(java.lang.String projectUri, java.lang.String name)
           
 ProjectInfo[] listAllProjects()
           
 ProjectInfo[] listProjects()
           
 NodeInfo[] listStructures(java.lang.String projectUri)
          Lists the structures in a project
 void moveBranch(java.lang.String nodeUri, java.lang.String newParentNodeUri)
          Moves a node, along with the entire branch below the node, to a new position in the hierarchy The type of the moved node must be appropriate to be a child of the new parent, and the new parent cannot be in the branch below the moved node.
 void renameNode(java.lang.String nodeUri, java.lang.String newNodeName)
          Renames the specified node.
 void reorderNode(java.lang.String nodeUri, int moveBy)
          Moves a node to a new position in the order of nodes within its parent
 void setIterationDates(java.lang.String nodeUri, java.util.Calendar startDate, java.util.Calendar finishDate)
           
 void setProjectProperty(java.lang.String projectUri, java.lang.String name, java.lang.String value)
           
 void updateProjectProperties(java.lang.String projectUri, java.lang.String state, ProjectProperty[] properties)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CommonStructureClient

public CommonStructureClient(TFSTeamProjectCollection connection,
                             ms.tfs.services.classification._03._ClassificationSoap webService,
                             ms.tfs.services.classification._03._Classification4Soap webService4)
Method Detail

getConnection

public TFSTeamProjectCollection getConnection()

clearProjectInfoCache

public void clearProjectInfoCache()
Clears the project information cache.


createNode

public java.lang.String createNode(java.lang.String nodeName,
                                   java.lang.String parentNodeUri)
Creates a new node in a classification service structure.

Parameters:
nodeName - Name of the node to create. If the parent already has a node with this name, then the new node will not be created.
parentNodeUri - The URI of the node which will be the parent of the new node.
Returns:
A string value containing the URI of the created node.

deleteBranches

public void deleteBranches(java.lang.String[] nodeUris,
                           java.lang.String reclassifyUri)
Deletes one or more branches

Parameters:
nodeUris - The URIs of the nodes that are the roots of the branches to be deleted
reclassifyUri - The URI of the node to which artifacts are reclassified

deleteProject

public void deleteProject(java.lang.String projectUri)
Deletes a project context and the associated structures

Parameters:
projectUri - The URI of the project context to delete

getChangedNodes

public java.lang.String getChangedNodes(int firstSequenceId)
Gets the set of changed nodes with an ID greater than a specified ID.

Parameters:
firstSequenceId - The lowest allowable ID.

getNode

public NodeInfo getNode(java.lang.String nodeUri)
Gets a NodeInfo structure using a node URI

Parameters:
nodeUri - The URI of the node to be obtained
Returns:
An ANodeInfo value containing the node information structure.

getNodeFrom

public NodeInfo getNodeFrom(java.lang.String nodePath)
Gets a NodeInfo structure using a node pathname.

Parameters:
nodePath - The URI of the node to be obtained
Returns:
An ANodeInfo value containing the node information structure.

getCSSNodes

public CSSNode getCSSNodes(java.lang.String rootNodeUri,
                           boolean includeChildren)

getCSSNodes

public CSSNode[] getCSSNodes(java.lang.String[] rootNodeUris,
                             boolean includeChildren)

getProject

public ProjectInfo getProject(java.lang.String projectUri)
Parameters:
projectUri - The URI of the project to be obtained
Returns:
An AProjectInfo value containing the project information structure.

getProjectFromName

public ProjectInfo getProjectFromName(java.lang.String projectName)
Gets a ProjectInfo structure using a project name

Parameters:
projectName - The name of the project to be obtained
Returns:
An AProjectInfo object containing the project information structure.

listAllProjects

public ProjectInfo[] listAllProjects()

listProjects

public ProjectInfo[] listProjects()

listStructures

public NodeInfo[] listStructures(java.lang.String projectUri)
Lists the structures in a project

Parameters:
projectUri - URI of the project from which the structure is to be obtained
Returns:
An array of ANodeInfo objects containing the URI of the root node of the structure.

moveBranch

public void moveBranch(java.lang.String nodeUri,
                       java.lang.String newParentNodeUri)
Moves a node, along with the entire branch below the node, to a new position in the hierarchy The type of the moved node must be appropriate to be a child of the new parent, and the new parent cannot be in the branch below the moved node. The effects on tools that hold pathnames is equivalent to the effects of RenameNode, above. There are additional effects on tools that infer information from the parentage of the node. For example, TFS might derive security from a node, and it's parentage in the hierarchy. Tools that hold only URIs do not need to respond to CSS change events that occur for MoveNode.

Parameters:
nodeUri - The URI of the node to be moved
newParentNodeUri - The URI of the new parent

renameNode

public void renameNode(java.lang.String nodeUri,
                       java.lang.String newNodeName)
Renames the specified node. This has the effect of changing the path for this node and the entire branch below this node.

Parameters:
nodeUri - The URI of the node to rename
newNodeName - The new name of the node

reorderNode

public void reorderNode(java.lang.String nodeUri,
                        int moveBy)
Moves a node to a new position in the order of nodes within its parent

Parameters:
nodeUri - The URI of the node to be moved
moveBy - The number of places to move. Negative numbers indicate upwards movement and positive numbers indicate downward movement. If moveby would indicate a position further than one end or the other, then the node is moved to that end.

updateProjectProperties

public void updateProjectProperties(java.lang.String projectUri,
                                    java.lang.String state,
                                    ProjectProperty[] properties)
Parameters:
projectUri - The project to be updated
state - A ProjectState value indicating the state of the project (New, WellFormed, or Deleting)
properties - The array of properties for the project

createNode

public java.lang.String createNode(java.lang.String nodeName,
                                   java.lang.String parentNodeUri,
                                   java.util.Calendar startDate,
                                   java.util.Calendar finishDate)
Since:
TFS 2012

setIterationDates

public void setIterationDates(java.lang.String nodeUri,
                              java.util.Calendar startDate,
                              java.util.Calendar finishDate)
Since:
TFS 2012

getProjectProperty

public ProjectProperty getProjectProperty(java.lang.String projectUri,
                                          java.lang.String name)
Since:
TFS 2012

setProjectProperty

public void setProjectProperty(java.lang.String projectUri,
                               java.lang.String name,
                               java.lang.String value)
Since:
TFS 2012


© 2015 Microsoft. All rights reserved.