|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWFaultDefinition
public final class VWFaultDefinition
Use the VWFaultDefinition class to retrieve and set the name, map name (optional), and message for a Web Services fault, represented by a VWFaultDefinition object. Additional functions of methods in this class include validating a fault or converting a fault into an XML String.
VWCompoundStepDefinition
,
VWValidationError
,
VWInvokeInstruction
,
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.String |
getFaultMapName()
Gets the fault map name for this instance. |
java.lang.String |
getFaultMessage()
Gets the fault message for this instance. |
java.lang.String |
getName()
Gets the name of this fault definition. |
VWSession |
getSession()
Get the session associated with this event definition. |
void |
setFaultMapName(java.lang.String theFaultMapName)
Sets the fault map name of this fault definition. |
void |
setFaultMessage(java.lang.String theFaultMessage)
Sets the fault message of this fault definition. |
void |
setName(java.lang.String theName)
Sets the name of this fault definition, which must be unique (within the containing invoke instruction), non- null , and non-empty. |
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,
boolean isCatchAll,
VWCompoundStepDefinition myCompoundStep)
Appends an XPDL string representing this instance to the buffer specified. |
void |
validate(VWSession theSession,
java.util.Vector EDefVector,
VWCompoundStepDefinition myStep,
int instId,
int faultId)
Validates this instance, appending any validation errors found to the specified Vector object. |
Methods inherited from class java.lang.Object |
---|
equals, 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 java.lang.String getFaultMapName()
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 java.lang.String getFaultMessage()
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
null
, and non-empty.
theName
- the new name for this fault definition
VWException
public void setFaultMapName(java.lang.String theFaultMapName)
theFaultMapName
- the new fault map name for this fault
definition; may be null
if no fault map is
used.public void setFaultMessage(java.lang.String theFaultMessage)
theFaultMessage
- the new fault message for this fault
definition; must be a valid, non-null
, LValue
String expression (able to hold a value on the left side of
an assignment statement).public void validate(VWSession theSession, java.util.Vector EDefVector, VWCompoundStepDefinition myStep, int instId, int faultId) 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.
myStep
- The VWCompoundStepDefinition object containing this event.instId
- An integer identifying the instruction ID for the VWInvokeInstruction object that contains this event.faultId
- An integer identifying the fault ID of this fault (its index into the array of faults that
belongs to the containing VWInvokeInstruction object), or -99. A value of -99 represents the catch all fault
definition. Other index values are useful for accessing meaningful validation error messages
within the array of faults in the containing invoke instruction.
VWException
- Thrown if an error occurs during the validation.VWCompoundStepDefinition
,
VWValidationError
,
VWInvokeInstruction
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, boolean isCatchAll, VWCompoundStepDefinition myCompoundStep) 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.isCatchAll
- Indicates whether the fault is for a CatchAll.myCompoundStep
- The VWCompoundStepDefinition object that contains this instance.
VWException
- Thrown if the specified buffer is null.VWXMLUtil
public VWSession getSession() throws VWException
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |