VWPartnerLinkDefinition (Process API Documentation)

java.lang.Object
- filenet.vw.api.VWPartnerLinkDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public final class VWPartnerLinkDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
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

Since:

P8 3.0

See Also:

VWWorkflowDefinition, Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`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`	`getPartnerLinkRef()`
`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.
`java.lang.String`	`getWSDLRef()`
`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`	`setPartnerLinkRef(java.lang.String thePartnerLinkRef)`
`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`	`setWSDLRef(java.lang.String theWSDLRef)`
`void`	`toXML(java.lang.StringBuffer theBuffer)` Deprecated. Use `VWWorkflowDefinition.write(java.io.OutputStream)` or `VWWorkflowDefinition.writeToFile(String)`.
`void`	`toXPDL(java.lang.String indentA, java.lang.StringBuffer theBuffer)` Deprecated. Use `VWWorkflowCollectionDefinition.write(java.io.OutputStream)` or `VWWorkflowCollectionDefinition.writeToFile(String)`.
`void`	`validate(VWSession theSession, java.util.Vector EDefVector)` Deprecated. use the validation methods in VWWorkflowDefinition or VWWorkflowCollectionDefinition

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getName
```
public java.lang.String getName()
```
    Gets the name of this partner link. If a translation source exists, the authored name is translated.
    Note: The translation is done only at run time, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
    
    Returns:
    
    A String containing the translated name of this partner link, if a translation source exists; otherwise the authored name is returned.
  - getMyPortType
```
public java.lang.String getMyPortType()
```
    Gets the MyportType of this partner link.
    
    Returns:
    
    MyportType of this partner link.
  - getMyRole
```
public java.lang.String getMyRole()
```
    Gets the MyRole of this partner link.
    
    Returns:
    
    MyRole of this partner link.
  - getPartnerEndPoint
```
public java.lang.String getPartnerEndPoint()
```
    Gets the end point of this partner link.
    
    Returns:
    
    End point of this partner link.
  - getPartnerPortType
```
public java.lang.String getPartnerPortType()
```
    Gets the port type of this partner link.
    
    Returns:
    
    Port type of this partner link.
  - getPartnerRole
```
public java.lang.String getPartnerRole()
```
    Gets the partner role of this partner link.
    
    Returns:
    
    Partner role of this partner link.
  - getPartnerLinkRef
```
public java.lang.String getPartnerLinkRef()
```
  - getWSDLRef
```
public java.lang.String getWSDLRef()
```
  - setName
```
public void setName(java.lang.String theName)
             throws VWException
```
    Sets the name of this partner link.
    
    Parameters:
    
    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. Partner link names can only contain letters, numbers and underscores.
    
    Throws:
    
    VWException - Thrown for various causes, including when the partner link name is invalid.
  - setMyPortType
```
public void setMyPortType(java.lang.String theMyPortType)
                   throws VWException
```
    Sets the MyportType of this partner link.
    
    Parameters:
    
    theMyPortType - New MyportType value for this partner link.
    
    Throws:
    
    VWException
  - setMyRole
```
public void setMyRole(java.lang.String theMyRole)
               throws VWException
```
    Sets the MyRole of this partner link.
    
    Parameters:
    
    theMyRole - New MyRole value for this partner link.
    
    Throws:
    
    VWException
  - setPartnerEndPoint
```
public void setPartnerEndPoint(java.lang.String thePartnerEndPoint)
                        throws VWException
```
    Sets the end point of this partner link.
    
    Parameters:
    
    thePartnerEndPoint - New end point value for this partner link.
    
    Throws:
    
    VWException
  - setPartnerPortType
```
public void setPartnerPortType(java.lang.String thePartnerPortType)
                        throws VWException
```
    Sets the port type of this partner link.
    
    Parameters:
    
    thePartnerPortType - New port type value for this partner link.
    
    Throws:
    
    VWException
  - setPartnerRole
```
public void setPartnerRole(java.lang.String thePartnerRole)
                    throws VWException
```
    Sets the partner role of this partner link.
    
    Parameters:
    
    thePartnerRole - New partner role value for this partner link.
    
    Throws:
    
    VWException
  - setPartnerLinkRef
```
public void setPartnerLinkRef(java.lang.String thePartnerLinkRef)
```
  - setWSDLRef
```
public void setWSDLRef(java.lang.String theWSDLRef)
```
  - validate
```
public void validate(VWSession theSession,
                     java.util.Vector EDefVector)
              throws VWException
```
    Deprecated. use the validation methods in VWWorkflowDefinition or VWWorkflowCollectionDefinition
    
    Validates this instance, appending any validation errors found to the specified Vector object. EDefVector will be updated to contain any validation errors found.
    
    Parameters:
    
    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.
    
    Throws:
    
    VWException - Thrown if an error occurs during the validation; for example, if there is no containing workflow definition or run time milestone definition.
  - toXML
```
public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
```
    Deprecated. Use VWWorkflowDefinition.write(java.io.OutputStream) or VWWorkflowDefinition.writeToFile(String).
    
    Appends an XML string representing this instance to the buffer specified.
    Warning: This XML string is nonextensible, and cannot be modified in any way.
    
    Parameters:
    
    theBuffer - A StringBuffer that will be appended with the XML content.
    
    Throws:
    
    VWException - Thrown if the specified buffer is null.
    
    See Also:
    
    VWWorkflowDefinition
  - toXPDL
```
public void toXPDL(java.lang.String indentA,
                   java.lang.StringBuffer theBuffer)
            throws VWException
```
    Deprecated. Use VWWorkflowCollectionDefinition.write(java.io.OutputStream) or VWWorkflowCollectionDefinition.writeToFile(String).
    
    Appends an XPDL string representing this instance to the buffer specified.
    Warning: This XPDL string is nonextensible, and cannot be modified in any way.
    
    Parameters:
    
    indentA - A String specifying the initial indentation for this XPDL section.
    
    theBuffer - A StringBuffer that will be appended with the XPDL content.
    
    Throws:
    
    VWException - Thrown if the specified buffer is null.
    
    See Also:
    
    VWWorkflowCollectionDefinition
  - getReceiveInstructionRefs
```
public java.util.Vector getReceiveInstructionRefs()
                                           throws VWException
```
    Gets a Vector of references to all receive instructions in the containing workflow that use this partner link.
    
    Returns:
    
    A Vector of references to the receive instruction instances in the containing workflow that use this partner link. An empty vector means that no receive instruction instances in the containing workflow use this partner link.
    
    Throws:
    
    VWException
    
    See Also:
    
    VWReceiveInstruction, VWWorkflowDefinition.createPartnerLink(String)

Methods inherited from class java.lang.Object

getName

getMyPortType

getMyRole

getPartnerEndPoint

getPartnerPortType

getPartnerRole

getPartnerLinkRef

getWSDLRef

setName

setMyPortType

setMyRole

setPartnerEndPoint

setPartnerPortType

setPartnerRole

setPartnerLinkRef

setWSDLRef

validate

toXML

toXPDL

getReceiveInstructionRefs