com.microsoft.tfs.core.pendingcheckin
Class CheckinEvaluationResult

java.lang.Object
  extended by com.microsoft.tfs.core.pendingcheckin.CheckinEvaluationResult

public class CheckinEvaluationResult
extends java.lang.Object

Contains the results of a checkin evaluation.

Since:
TEE-SDK-10.1
Thread-safety:
conditionally thread-safe

Constructor Summary
CheckinEvaluationResult(CheckinConflict[] conflicts, CheckinNoteFailure[] noteFailures, PolicyFailure[] policyFailures, PolicyEvaluatorState policyEvaluatorState, java.lang.Exception policyEvaluationException)
           
 
Method Summary
 CheckinConflict[] getConflicts()
           
 CheckinNoteFailure[] getNoteFailures()
           
 java.lang.Exception getPolicyEvaluationException()
           
 PolicyEvaluatorState getPolicyEvaluatorState()
           
 PolicyFailure[] getPolicyFailures()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CheckinEvaluationResult

public CheckinEvaluationResult(CheckinConflict[] conflicts,
                               CheckinNoteFailure[] noteFailures,
                               PolicyFailure[] policyFailures,
                               PolicyEvaluatorState policyEvaluatorState,
                               java.lang.Exception policyEvaluationException)
Parameters:
conflicts - the conflicts detected in the evaluation (must not be null)
noteFailures - checkin notes that were not supplied correctly (must not be null)
policyFailures - checkin policy evaluation failures (must not be null)
policyEvaluatorState - the final state of the policy evaluator after evaluation (may be null if policies were not evaluated)
policyEvaluationException - an exception generated during checkin policy evaluation (may be null).
Method Detail

getConflicts

public CheckinConflict[] getConflicts()
Returns:
the conflicts found during evaluation. Do not modify the returned objects to ensure thread-safety.

getNoteFailures

public CheckinNoteFailure[] getNoteFailures()
Returns:
the check-in note failures found during evaluation. Do not modify the returned objects to ensure thread-safety.

getPolicyFailures

public PolicyFailure[] getPolicyFailures()
Returns:
the check-in policy failures found during evaluation. Do not modify the returned objects to ensure thread-safety.

getPolicyEvaluatorState

public PolicyEvaluatorState getPolicyEvaluatorState()
Returns:
the state of the PolicyEvaluator after policy evaluation, which may be null if check-in policies were not evaluated.

getPolicyEvaluationException

public java.lang.Exception getPolicyEvaluationException()
Returns:
the Exception that occurred during policy evaluation, if there was one (otherwise null).


© 2015 Microsoft. All rights reserved.