com.microsoft.tfs.core.checkinpolicies
Class PolicyEditArgs
java.lang.Object
com.microsoft.tfs.core.checkinpolicies.PolicyEditArgs
public class PolicyEditArgs
- extends java.lang.Object
PolicyEditArgs
contains information that is passed to checkin
policies when they are edited. This information includes some edit-specific
values and any number of properties available in a context object. The
contextual values are stored as keyed properties and are defined by the
execution environment that is hosting the checkin policy.
For example, the Plug-in for Eclipse and Explorer will put an SWT Shell
object into the context that can be used to raise UI.
- Since:
- TEE-SDK-10.1
- Thread-safety:
- immutable
Constructor Summary |
PolicyEditArgs(boolean isNew,
TeamProject teamProject)
Creates arguments with all required (always available) items set. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
PolicyEditArgs
public PolicyEditArgs(boolean isNew,
TeamProject teamProject)
- Creates arguments with all required (always available) items set.
- Parameters:
isNew
- true if this edit action is for a newly-created (installed or
added to a Team Project) policy, false if it is for an existing
(already installed) policy.teamProject
- the Team Project where this policy is being configured (must not
be null
)
isNew
public boolean isNew()
- Returns:
true
if this edit action is for a newly-created
(installed or added to a Team Project) policy, false
if it is for an existing (already installed) policy
getTeamProject
public TeamProject getTeamProject()
- Returns:
- the Team Project where this policy is being configured (must not
be
null
)
getContext
public PolicyContext getContext()
- Returns:
- the context that contains optional values (must not be
null
)
© 2015 Microsoft. All rights reserved.