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


public interface IWorkspaceTemplate


Method Summary
 IWorkspaceMapping addMapping()
          Adds a workspace mapping to the workspace.
 IWorkspaceMapping addMapping(java.lang.String serverItem, java.lang.String localItem, WorkspaceMappingType type)
          Adds a workspace mapping with the provided server item, local item, and mapping type with a depth of 120.
 IWorkspaceMapping addMapping(java.lang.String serverItem, java.lang.String localItem, WorkspaceMappingType type, WorkspaceMappingDepth depth)
          Adds a workspace mapping with the provided server item, local item, mapping type, and depth.
 void clearMappings()
          Removes all workspace mappings from the workspace template.
 IWorkspaceMapping cloak(java.lang.String serverItem)
          Adds a cloak entry to the workspace for the specified server item.
 void copyFrom(IWorkspaceTemplate source)
          Copies properties from a source workspace template to this one
 java.lang.String getLastModifiedBy()
          The user who last modified the workspace.
 java.util.Calendar getLastModifiedDate()
          The date and time at which the workspace was last modified.
 IWorkspaceMapping[] getMappings()
          The workspace mappings for the workspace.
 IWorkspaceMapping map(java.lang.String serverItem, java.lang.String localItem)
          Adds a workspace mapping with the provided server item and local item with WorkspaceMappingType.Map.
 boolean removeMapping(IWorkspaceMapping mapping)
          Removes the workspace mapping from the workspace template.
 boolean removeMapping(java.lang.String serverItem)
          Removes the workspace mapping for the given server item from the workspace template.
 

Method Detail

getMappings

IWorkspaceMapping[] getMappings()
The workspace mappings for the workspace.

Returns:

getLastModifiedDate

java.util.Calendar getLastModifiedDate()
The date and time at which the workspace was last modified.

Returns:

getLastModifiedBy

java.lang.String getLastModifiedBy()
The user who last modified the workspace.

Returns:

addMapping

IWorkspaceMapping addMapping()
Adds a workspace mapping to the workspace.

Returns:
The new workspace mapping.

cloak

IWorkspaceMapping cloak(java.lang.String serverItem)
Adds a cloak entry to the workspace for the specified server item.

Parameters:
serverItem - The server item which should be cloaked.
Returns:
A new workspace mapping.

map

IWorkspaceMapping map(java.lang.String serverItem,
                      java.lang.String localItem)
Adds a workspace mapping with the provided server item and local item with WorkspaceMappingType.Map.

Parameters:
serverItem - The server item to map.
localItem - The local item to map.
Returns:
A new workspace mapping.

addMapping

IWorkspaceMapping addMapping(java.lang.String serverItem,
                             java.lang.String localItem,
                             WorkspaceMappingType type)
Adds a workspace mapping with the provided server item, local item, and mapping type with a depth of 120. If WorkspaceMappingType.Cloak is specified then the localItem is forced to null.

Parameters:
serverItem - The server item for the mapping.
localItem - The local item path for the mapping.
type - The mapping type to create.
Returns:
A new workspace mapping.

addMapping

IWorkspaceMapping addMapping(java.lang.String serverItem,
                             java.lang.String localItem,
                             WorkspaceMappingType type,
                             WorkspaceMappingDepth depth)
Adds a workspace mapping with the provided server item, local item, mapping type, and depth. If WorkspaceMappingType.Cloak is specified then the localItem parameter is forced to null.

Parameters:
serverItem - The server item for the mapping
localItem - The local item path for the mapping
type - The mapping type to create
depth - The depth of the mapping
Returns:
A new workspace mapping

removeMapping

boolean removeMapping(IWorkspaceMapping mapping)
Removes the workspace mapping from the workspace template.

Parameters:
mapping - The mapping to be removed.
Returns:
True if the mapping was removed, false otherwise.

removeMapping

boolean removeMapping(java.lang.String serverItem)
Removes the workspace mapping for the given server item from the workspace template.

Parameters:
serverItem - The server item of the mapping to be removed.
Returns:
True if the mapping was removed, false otherwise.

clearMappings

void clearMappings()
Removes all workspace mappings from the workspace template.


copyFrom

void copyFrom(IWorkspaceTemplate source)
Copies properties from a source workspace template to this one

Parameters:
source - Template to copy from


© 2015 Microsoft. All rights reserved.