filenet.vw.api

Class VWAssociationDefinition

java.lang.Object

filenet.vw.api.VWAssociationDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public final class VWAssociationDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Represents a connection from a text annotation in a map to a route or a node (step) in the same map.

See Also:

VWMapDefinition, VWMapNode, VWTextAnnotationDefinition, VWRouteDefinition, Serialized Form

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
int	getId() Gets the value of the id property associated with this association.
java.lang.String	getName() Gets the name of this association.
int	getTargetId() Gets the target id for this association.
int	getTargetType() Gets the target type for this association.
VWTextAnnotationDefinition	getTextAnnotation() Gets the containing annotation object.
int	hashCode()
void	setName(java.lang.String name) Sets the name of this association.
java.lang.String	toString() Gets the string representation of this instance.
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(java.util.Vector EDefVector, VWMapDefinition map, int id) Deprecated. Use VWWorkflowDefinition.validate(VWSession, VWSystemConfiguration, String)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

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 that represents 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

toString

public java.lang.String toString()

Gets the string representation of this instance.

Overrides:

toString in class java.lang.Object

Returns:

A String containing the name, target id, and target type.

validate

public void validate(java.util.Vector EDefVector,
                     VWMapDefinition map,
                     int id)
              throws VWException

Deprecated. Use VWWorkflowDefinition.validate(VWSession, VWSystemConfiguration, String)

Validates this instance, appending any validation errors found to the specified Vector object. Although this method does not return a value, EDefVector will be updated to contain any validation errors found.

Parameters:

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.

map - The VWMapDefinition object specifying the map used for this association. This is used to verify the existence of the target id and type.

id - An integer identifying the ID of the annotation containing this assocation. This is used for formatting any validation errors.

Throws:

VWException - Thrown if an error occurs during the validation.

getTargetId

public int getTargetId()

Gets the target id for this association. This is the id of a step (VWMapNode) or route (VWRouteDefinition) in the same map as the text annotation from which this association originates.

The target type can be used in conjunction with the target id to find the object that this association references.

Returns:

An integer identifying the target id.

getTargetType

public int getTargetType()

Gets the target type for this association. Valid target types are defined by the VWAssociationTargetType class.

Returns:

An integer identifying the target type.

See Also:

VWAssociationTargetType

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

See Also:

Object.equals(java.lang.Object)

getName

public java.lang.String getName()

Gets the name of this association. This will be null if undefined.

Returns:

A String containing the name.

setName

public void setName(java.lang.String name)
             throws VWException

Sets the name of this association. This can be null.

Parameters:

name - A String containing the name to set, or null if unused.

Throws:

VWException

getId

public int getId()
          throws VWException

Gets the value of the id property associated with this association.

Returns:

An integer identifying the id.

Throws:

VWException

Since:

PE 4.5.1

getTextAnnotation

public VWTextAnnotationDefinition getTextAnnotation()

Gets the containing annotation object.

Returns:

The VWTextAnnotationDefinition object containing this association.

See Also:

VWTextAnnotationDefinition