com.microsoft.tfs.core.clients.versioncontrol.exceptions
Class GatedCheckinException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by java.lang.RuntimeException
              extended by com.microsoft.tfs.core.exceptions.TECoreException
                  extended by com.microsoft.tfs.core.exceptions.TEClientException
                      extended by com.microsoft.tfs.core.clients.versioncontrol.exceptions.VersionControlException
                          extended by com.microsoft.tfs.core.clients.versioncontrol.exceptions.ActionDeniedBySubscriberException
                              extended by com.microsoft.tfs.core.clients.versioncontrol.exceptions.GatedCheckinException
All Implemented Interfaces:
java.io.Serializable

public class GatedCheckinException
extends ActionDeniedBySubscriberException

Exception thrown when the server rejects a check-in because a gated build definition convers one or more of the pending changes.

See Also:
Serialized Form
Since:
TEE-SDK-10.1

Field Summary
 java.lang.String[] affectedBuildDefinitionNames
           
 java.util.Map<java.lang.String,java.lang.String> affectedBuildDefinitions
           
 java.lang.String[] affectedBuildDefinitionURIs
           
 
Constructor Summary
GatedCheckinException(ActionDeniedBySubscriberException e)
           
 
Method Summary
 java.lang.String[] getAffectedBuildDefinitionNames()
           
 java.util.Map<java.lang.String,java.lang.String> getAffectedBuildDefinitions()
          Gets a collection of (Name, Uri) pairs defining the build definitions which blocked the checkin attempt.
 java.lang.String[] getAffectedBuildDefinitionURIs()
           
 java.lang.String getCheckinTicket()
          Gets the check-in ticket provided by the server for submitting a CheckInShelveset build request.
 boolean getOverridePermission()
          Gets a value indicating whether or not the user that performed the checkin has the required permissions to override the gated checkin policy.
 int getQueueID()
          Gets the ID of the queued build for this gated check-in if the build was queued by the server.
 java.lang.String getShelvesetName()
          Gets the name of the shelveset that was created on behalf of the account making the checkin.
 int getSubCode()
          Gets the sub code for this exception.
 
Methods inherited from class com.microsoft.tfs.core.clients.versioncontrol.exceptions.ActionDeniedBySubscriberException
getStatusCode, getSubscriberName, getSubscriberType
 
Methods inherited from class com.microsoft.tfs.core.clients.versioncontrol.exceptions.VersionControlException
getProperties, setProperties
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

affectedBuildDefinitions

public java.util.Map<java.lang.String,java.lang.String> affectedBuildDefinitions

affectedBuildDefinitionNames

public java.lang.String[] affectedBuildDefinitionNames

affectedBuildDefinitionURIs

public java.lang.String[] affectedBuildDefinitionURIs
Constructor Detail

GatedCheckinException

public GatedCheckinException(ActionDeniedBySubscriberException e)
Method Detail

getAffectedBuildDefinitions

public java.util.Map<java.lang.String,java.lang.String> getAffectedBuildDefinitions()
Gets a collection of (Name, Uri) pairs defining the build definitions which blocked the checkin attempt. This property is always valid.


getAffectedBuildDefinitionNames

public java.lang.String[] getAffectedBuildDefinitionNames()

getAffectedBuildDefinitionURIs

public java.lang.String[] getAffectedBuildDefinitionURIs()

getCheckinTicket

public java.lang.String getCheckinTicket()
Gets the check-in ticket provided by the server for submitting a CheckInShelveset build request. This ticket should be used when requesting a build in response to this exception to ensure the ability to submit even if the caller does not have the normally required permissions.

Returns:
The gated checkin ticket.

getShelvesetName

public java.lang.String getShelvesetName()
Gets the name of the shelveset that was created on behalf of the account making the checkin. If a shelveset could not be created for any reason this value will be null. This property is valid when SubCode is 1 or 3.

Returns:
The shelveset name.

getOverridePermission

public boolean getOverridePermission()
Gets a value indicating whether or not the user that performed the checkin has the required permissions to override the gated checkin policy. This property is always valid.

Returns:
True if the user has override permission.

getSubCode

public int getSubCode()
Gets the sub code for this exception. The sub code indicates what action(s) were performed on the server to aid the client in taking the appropriate corrective action.

Returns:
The sub code for this exception

getQueueID

public int getQueueID()
Gets the ID of the queued build for this gated check-in if the build was queued by the server. If the server did not queue a build, returns 0.

Returns:
the queued build ID if this build was queued by the server, otherwise 0.


© 2015 Microsoft. All rights reserved.