com.microsoft.tfs.core.clients.versioncontrol.soapextensions
Class CheckinNoteFieldDefinition

java.lang.Object
  extended by com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
      extended by com.microsoft.tfs.core.clients.versioncontrol.soapextensions.CheckinNoteFieldDefinition
All Implemented Interfaces:
java.lang.Comparable

public class CheckinNoteFieldDefinition
extends com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
implements java.lang.Comparable

Defines a checkin note field (which has a name, can be required, and has a display order).

Since:
TEE-SDK-10.1

Field Summary
 
Fields inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
webServiceObject
 
Constructor Summary
CheckinNoteFieldDefinition(ms.tfs.versioncontrol.clientservices._03._CheckinNoteFieldDefinition definition)
           
CheckinNoteFieldDefinition()
           
CheckinNoteFieldDefinition(java.lang.String name, boolean required, int displayOrder)
           
CheckinNoteFieldDefinition(java.lang.String serverItem, java.lang.String name, boolean required, int displayOrder)
           
 
Method Summary
 int compareTo(java.lang.Object otherObject)
          IComparable implementation.
 boolean equals(java.lang.Object otherObject)
           
 int getDisplayOrder()
           
 java.lang.String getName()
           
 java.lang.String getServerItem()
           
 ms.tfs.versioncontrol.clientservices._03._CheckinNoteFieldDefinition getWebServiceObject()
          Gets the web service object this class wraps.
 int hashCode()
           
 boolean isRequired()
           
 void setDisplayOrder(int displayOrder)
           
 void setName(java.lang.String name)
           
 void setRequired(boolean required)
           
 void setServerItem(java.lang.String serverItem)
           
 
Methods inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CheckinNoteFieldDefinition

public CheckinNoteFieldDefinition()

CheckinNoteFieldDefinition

public CheckinNoteFieldDefinition(java.lang.String name,
                                  boolean required,
                                  int displayOrder)

CheckinNoteFieldDefinition

public CheckinNoteFieldDefinition(ms.tfs.versioncontrol.clientservices._03._CheckinNoteFieldDefinition definition)

CheckinNoteFieldDefinition

public CheckinNoteFieldDefinition(java.lang.String serverItem,
                                  java.lang.String name,
                                  boolean required,
                                  int displayOrder)
Parameters:
serverItem - path to server item that this definition corresponds - usually the path of the project in source control.
name - Name of the field
required - Indicator defining if providing a value is mandatory
displayOrder - integer representing the order in which the item should be presented to the user, low numbers first.
Method Detail

getWebServiceObject

public ms.tfs.versioncontrol.clientservices._03._CheckinNoteFieldDefinition getWebServiceObject()
Gets the web service object this class wraps. The returned object should not be modified.

Returns:
the web service object this class wraps.

equals

public boolean equals(java.lang.Object otherObject)
Overrides:
equals in class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper

hashCode

public int hashCode()
Overrides:
hashCode in class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper

compareTo

public int compareTo(java.lang.Object otherObject)
IComparable implementation. Sort by displayOrder then by name. However, if two field defnitions have the same name, they are considered equal.

Specified by:
compareTo in interface java.lang.Comparable
See Also:
Comparable.compareTo(java.lang.Object)

getServerItem

public java.lang.String getServerItem()

setServerItem

public void setServerItem(java.lang.String serverItem)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

isRequired

public boolean isRequired()

setRequired

public void setRequired(boolean required)

getDisplayOrder

public int getDisplayOrder()

setDisplayOrder

public void setDisplayOrder(int displayOrder)


© 2015 Microsoft. All rights reserved.