|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWPartnerLinkDefinition
public final class VWPartnerLinkDefinition
Use this class to access name, port type, role, endpoint, and other properties of a partner link used in a workflow process.
Create a partnerlink using the VWWorkflowDefinition.createPartnerLink
method.
The term "partner link" and related terms used in the Process Engine API correspond to the terminology in the specification for Business Process Execution Language for Web Services Version 1.1
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.String |
getMyPortType()
Gets the MyportType of this partner link. |
java.lang.String |
getMyRole()
Gets the MyRole of this partner link. |
java.lang.String |
getName()
Gets the name of this partner link. |
java.lang.String |
getPartnerEndPoint()
Gets the end point of this partner link. |
java.lang.String |
getPartnerPortType()
Gets the port type of this partner link. |
java.lang.String |
getPartnerRole()
Gets the partner role of this partner link. |
java.util.Vector |
getReceiveInstructionRefs()
Gets a Vector of references to all receive instructions in the containing workflow that use this partner link. |
void |
setMyPortType(java.lang.String theMyPortType)
Sets the MyportType of this partner link. |
void |
setMyRole(java.lang.String theMyRole)
Sets the MyRole of this partner link. |
void |
setName(java.lang.String theName)
Sets the name of this partner link. |
void |
setPartnerEndPoint(java.lang.String thePartnerEndPoint)
Sets the end point of this partner link. |
void |
setPartnerPortType(java.lang.String thePartnerPortType)
Sets the port type of this partner link. |
void |
setPartnerRole(java.lang.String thePartnerRole)
Sets the partner role of this partner link. |
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 representing 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 |
---|
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 getMyPortType()
public java.lang.String getMyRole()
public java.lang.String getPartnerEndPoint()
public java.lang.String getPartnerPortType()
public java.lang.String getPartnerRole()
public void setName(java.lang.String theName) throws VWException
theName
- New name for this partner link. Name must be
non-null and non-zero length, and must not
match an existing partner link name. The length of the partner
link name must not exceed 15 characters. Partner link names can only contain letters
numbers and underscores.
VWException
- Thrown for various causes, including when
the partner link name is invalid.public void setMyPortType(java.lang.String theMyPortType) throws VWException
theMyPortType
- New MyportType value for this partner link.
VWException
public void setMyRole(java.lang.String theMyRole) throws VWException
theMyRole
- New MyRole value for this partner link.
VWException
public void setPartnerEndPoint(java.lang.String thePartnerEndPoint) throws VWException
thePartnerEndPoint
- New end point value for this partner link.
VWException
public void setPartnerPortType(java.lang.String thePartnerPortType) throws VWException
thePartnerPortType
- New port type value for this partner link.
VWException
public void setPartnerRole(java.lang.String thePartnerRole) throws VWException
thePartnerRole
- New partner role value for
this partner link.
VWException
public void validate(VWSession theSession, java.util.Vector EDefVector) throws VWException
theSession
- A VWSession object for the current session.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 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 java.util.Vector getReceiveInstructionRefs() throws VWException
VWException
VWReceiveInstruction
,
VWWorkflowDefinition.createPartnerLink(String)
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |