|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWAssociationDefinition
public class VWAssociationDefinition
Represents a connection from a text annotation in a map to a route or a node (step) in the same map.
VWMapDefinition
,
VWMapNode
,
VWTextAnnotationDefinition
,
VWRouteDefinition
,
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. |
boolean |
equals(java.lang.Object obj)
|
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. |
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)
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(java.util.Vector EDefVector,
VWMapDefinition map,
int id)
Validates this instance, appending any validation errors found to the specified Vector object. |
Methods inherited from class java.lang.Object |
---|
getClass, hashCode, notify, notifyAll, 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 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.lang.String toString()
toString
in class java.lang.Object
public void validate(java.util.Vector EDefVector, VWMapDefinition map, int id) throws VWException
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.
VWException
- Thrown if an error occurs during the validation.public int getTargetId()
The target type can be used in conjunction with the target id to find the object that this association references.
public int getTargetType()
VWAssociationTargetType
class.
VWAssociationTargetType
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Object.equals(java.lang.Object)
public java.lang.String getName()
public void setName(java.lang.String name) throws VWException
name
- A String containing the name to set, or null if unused.
VWException
public VWTextAnnotationDefinition getTextAnnotation()
VWTextAnnotationDefinition
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |