|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWMilestoneDefinition
public final class VWMilestoneDefinition
Use this class to access the name, message, level, and other properties of a milestone used in a workflow process.
VWStepDefinition
,
VWWorkflowDefinition
,
Serialized FormMethod Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
java.lang.Object |
clone()
Creates a clone of this instance. |
boolean |
equals(java.lang.Object obj)
Compares the specified object with this item for equality. |
int |
getLevel()
Gets the level for this milestone. |
java.lang.String |
getMessage()
Gets the message of this milestone. |
java.lang.String |
getName()
Gets the name of this milestone. |
void |
setLevel(int theLevel)
Sets the level for the milestone. |
void |
setMessage(java.lang.String theMessage)
Sets the message for the milestone. |
void |
setName(java.lang.String theName)
Sets the name for the milestone. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
void |
toXPDL(java.lang.String indentA,
java.lang.StringBuffer theBuffer)
Appends an XPDL string that represents this instance to the buffer specified. |
void |
validate(VWSession theSession,
java.util.Vector EDefVector)
Validates this instance, appending any validation errors found to the specified Vector object. |
Methods inherited from class java.lang.Object |
---|
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public java.lang.String getName()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
public void setName(java.lang.String theName) throws VWException
theName
- A String containing the name to use for the milestone.
VWException
- Thrown under the following conditions:
public java.lang.String getMessage()
public void setMessage(java.lang.String theMessage) throws VWException
theMessage
- An expression that conforms to workflow server grammar. See
validate
method to test message grammar.
VWException
validate(filenet.vw.api.VWSession, java.util.Vector)
public int getLevel()
setLevel(int)
public void setLevel(int theLevel) throws VWException
theLevel
- The integer value of the new level of the
milestone. This should be a value between 1 and 99, inclusive.
VWException
- Thrown if specified level is invalid.public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML string is nonextensible, and cannot be modified in any way.
theBuffer
- A StringBuffer that will be appended with the XML content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public void toXPDL(java.lang.String indentA, java.lang.StringBuffer theBuffer) throws VWException
Warning: This XPDL string is nonextensible, and cannot be modified in any way.
indentA
- A String specifying the initial indentation for this XPDL section.theBuffer
- A StringBuffer that will be appended with the XPDL content.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public void validate(VWSession theSession, java.util.Vector EDefVector) throws VWException
theSession
- The current VWSession object if logged on. This is needed
for various parts of the validation process. This can be null; however, areas of validation requiring a
logon will not be validated.EDefVector
- A Vector to which will be added a VWValidationError object for each validation
error found. This can be null; in this case, a new Vector is used.
Note: Because validate methods having EDefVector in the signature also occur on other classes, the existing Vector can contain validation errors from previous validation calls.
VWException
- Thrown if an error occurs during the validation; for example, if there is no
containing workflow definition or runtime milestone definition.public java.lang.Object clone()
clone
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |