|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.microsoft.tfs.core.checkinpolicies.PolicyType
public class PolicyType
Defines a kind of check-in policy. Policy implementations (classes on disk
that implement PolicyInstance
) must declare their policy type, and
each type is identified by the type ID.
Implementations whose policy types have equal IDs are considered compatible: they should read and write each others' configuration information and evaluate the same rules during check-in.
Policies configured on Team Projects ("defined") indicate the associated policy type so they can be loaded by clients (using the ID to find implementations).
PolicyLoader
is responsible for loading implementations given
appropriate type information.
Constructor Summary | |
---|---|
PolicyType(java.lang.String id,
java.lang.String name,
java.lang.String shortDescription,
java.lang.String longDescription,
java.lang.String installationInstructions)
Constructs a fully-specified policy type. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
|
java.lang.String |
getID()
|
java.lang.String |
getInstallationInstructions()
|
java.lang.String |
getLongDescription()
|
java.lang.String |
getName()
|
java.lang.String |
getShortDescription()
|
int |
hashCode()
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public PolicyType(java.lang.String id, java.lang.String name, java.lang.String shortDescription, java.lang.String longDescription, java.lang.String installationInstructions)
id
- a free-form string that uniquely identifies a kind of check-in
policy. All configuration-compatible policy implementations that
enforce the same set of check-in rules can be given the same type
ID, so they can read each others configuration data. It's a good
idea to include some kind of version identifier in a type ID, but
it is not required. (must not be null
or empty)name
- the name of this policy (e.g. "Work Items"). This text is
presented to the user in space-constrained places like lists and
tables. (must not be null
or empty)shortDescription
- a short description of what this type of checkin policy does (e.g.
"Require associated work items."). This text is presented to the
user when he chooses a check-in policy type to define for a team
project, or configures an existing definition. (must not be
null
or empty)longDescription
- a longer description of what this type of checkin policy does
(e.g. "This policy requires that one or more work items be
associated with every check-in."). This text is shown to the user
when selecting a policy implementation for definition on a team
project. (must not be null
)installationInstructions
- instructions on how to install this policy implementation. This is
shown to users when this type of policy is defined on a team
project, but a client program cannot find an implementation. (must
not be null
)Method Detail |
---|
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String getID()
null
or empty)PolicyType(String, String, String, String, String)
public java.lang.String getName()
null
or empty)PolicyType(String, String, String, String, String)
public java.lang.String getShortDescription()
null
or empty)PolicyType(String, String, String, String, String)
public java.lang.String getLongDescription()
null
)PolicyType(String, String, String, String, String)
public java.lang.String getInstallationInstructions()
null
)PolicyType(String, String, String, String, String)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |