com.microsoft.tfs.core.clients.workitem.link
Interface WorkItemLinkTypeCollection


public interface WorkItemLinkTypeCollection

Interface which exposes link type information from WIT metadata.

Since:
TEE-SDK-10.1

Method Summary
 boolean contains(java.lang.String linkTypeReferenceName)
          Contains takes a string as the link type name
 WorkItemLinkType get(java.lang.String referenceName)
          Retrieves a work item link type based on the link type's reference name.
 int getCount()
          Get the number of link types in the collection.
 java.lang.String getDisplayName(int linkTypeId)
          Returns the display name of the specified link type identifier or null if there is no such link type.
 WorkItemLinkTypeEndCollection getLinkTypeEnds()
          Retrieves a collection of all the link type ends across all link types.
 java.lang.String getReferenceName(int linkTypeId)
          Returns the reference name of the specified link type identifier or null if there is no such link type.
 boolean isForwardLink(int linkTypeId)
          Returns true if the specified link type identifier is for a forward link.
 boolean isReverseLink(int linkTypeId)
          Returns true if the specified link type identifier is for a reverse link.
 

Method Detail

isForwardLink

boolean isForwardLink(int linkTypeId)
Returns true if the specified link type identifier is for a forward link. This will always return true for non directional links.

Parameters:
linkTypeId - The link type identifier.
Returns:
Returns true if the link type is a forward link.

isReverseLink

boolean isReverseLink(int linkTypeId)
Returns true if the specified link type identifier is for a reverse link. This will always return true for non directional links.

Parameters:
linkTypeId - The link type identifier.
Returns:
Returns true if the link type is a reverse link.

getReferenceName

java.lang.String getReferenceName(int linkTypeId)
Returns the reference name of the specified link type identifier or null if there is no such link type.

Parameters:
linkTypeId - The link type identifier.
Returns:
The String reference name for this link type or null if there is no such link type.

getDisplayName

java.lang.String getDisplayName(int linkTypeId)
Returns the display name of the specified link type identifier or null if there is no such link type.

Parameters:
linkTypeId - The link type identifier.
Returns:
The String display name for this link type or null if there is no such link type.

getCount

int getCount()
Get the number of link types in the collection.


get

WorkItemLinkType get(java.lang.String referenceName)
Retrieves a work item link type based on the link type's reference name.


contains

boolean contains(java.lang.String linkTypeReferenceName)
Contains takes a string as the link type name

Parameters:
linkTypeReferenceName - Must be the reference name of the link type

getLinkTypeEnds

WorkItemLinkTypeEndCollection getLinkTypeEnds()
Retrieves a collection of all the link type ends across all link types. This is provided for convenience and faster lookup of link type ends by Id, Name, and ImmutableName.



© 2015 Microsoft. All rights reserved.