|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.microsoft.tfs.core.pendingcheckin.StandardPendingCheckinPolicies
public class StandardPendingCheckinPolicies
Standard implementation of PendingCheckinPolicies
that uses a
PolicyEvaluator
to contain and evaluate policies. A constructor
exists to allow you to specify an existing PolicyEvaluator
.
Constructor Summary | |
---|---|
StandardPendingCheckinPolicies(PendingCheckin pendingCheckin,
VersionControlClient client,
PolicyEvaluator evaluator)
Constructs a @ StandardPendingCheckinPolicies} for the given pending checkin and client, using an existing PolicyEvaluator and the
PolicyLoader it was configured with. |
Method Summary | |
---|---|
PolicyFailure[] |
evaluate(PolicyContext policyContext)
Evaluates checkin policies. |
PolicyEvaluatorState |
getPolicyEvaluatorState()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public StandardPendingCheckinPolicies(PendingCheckin pendingCheckin, VersionControlClient client, PolicyEvaluator evaluator)
PolicyEvaluator
and the
PolicyLoader
it was configured with. The evalutor's
PolicyEvaluator.setPendingCheckin(PendingCheckin)
method is
called immediately to configure the checkin, then other methods are
called later by this object.
This construction option is available so clients can manage a single evaluator object that will be used for all evaluation tasks, simplifying event management and increasing the efficiency of policy instance caching.
pendingCheckin
- the pending checkin (must not be null
)client
- the version control client in use (must not be null
)evaluator
- the existing policy evaluator object to use (may be
null
)Method Detail |
---|
public PolicyFailure[] evaluate(PolicyContext policyContext) throws PolicyEvaluationCancelledException
evaluate
in interface PendingCheckinPolicies
policyContext
- contextual settings that may include information about the user
interface, etc. (must not be null
)
PolicyEvaluationCancelledException
- if the user canceled the policy evaluation.public PolicyEvaluatorState getPolicyEvaluatorState()
getPolicyEvaluatorState
in interface PendingCheckinPolicies
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |