Process API

filenet.vw.api
Class VWWebServiceParameterDefinition

java.lang.Object
  extended by filenet.vw.api.VWWebServiceParameterDefinition
All Implemented Interfaces:
java.io.Serializable

public final class VWWebServiceParameterDefinition
extends java.lang.Object
implements java.io.Serializable

Use this class to access the definition object for a web service parameter.

The functions of the methods for this class can be conceptualized as modifiers to XML code for a parameter. The following XML example code snippets represent a set of parameters. The parameter representations are commented with notes in square brackets ([]), which describe various functions of the major methods in this class.

<addProjectField xmlns="http://www.filenet.com/ns/fnpe/2004/06/po/wsdl/<workclassName>">

[addProjectField is not contained within any other parameters; therefore it has a lexical level of 0. As the first parameter of the set, addProjectField has a sequence number 0.]
      [parameter name | parameter value | closing tag]

<ProjectName>Process Orchestration</ProjectName>

[as the second parameter occurring in the set, ProjectName has a sequence number of 1. For more information on sequence numbering, see getSequenceNumber].
ProjectName is contained within the preceding parameter, so it has a lexical level one greater, which would be level 1.]

    <MileStoneDates>
      <StartDate>3-14-2004</StartDate>
      <EndDate>4-14-2004</EndDate>
   </MileStoneDates>

[For additional information on lexical level values, see setLexicalLevel.
The following parameter, members, is an array, so getIsArray() would return true for the members parameter. The array below has four values.]

   <Members>
      <value xmlns="http://www.filenet.com/ns/fnpe/2004/06/po/schema/basic">Filenet</value>
 
      <value xmlns="http://www.filenet.com/ns/fnpe/2004/06/po/schema/basic">Engineering</value>
      <value xmlns="http://www.filenet.com/ns/fnpe/2004/06/po/schema/basic">TH-A</value>
      <value xmlns="http://www.filenet.com/ns/fnpe/2004/06/po/schema/basic">VW</value>
   </Members>
 </addProjectField>
 
Note: Any of the elements in a parameter set may also contain XML attributes, according to XML conventions.

See Also:
VWModeType, VWFieldType, Serialized Form

Method 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 getArrayAttributes()
          Returns the attributes for an array specified by an array tag and array namespace, for this parameter.
 java.lang.String getArrayNameSpace()
          Returns the namespace for the array tag associated with this parameter
 java.lang.String getArrayTag()
          Returns the array tag name for this parameter; may be null
 java.lang.String getAttributes()
          Returns the attributes for this parameter, as they are applied to this combination of namespace and parameter name.
 int getDataType()
          Returns the integer value associated with the field data type of the parameter.
 boolean getIsArray()
          Indicates whether the parameter is an array.
 int getLexicalLevel()
          Returns the level of nesting (containment) for this parameter.
 int getMode()
          Returns an integer associated with the mode property for this parameter.
 java.lang.String getName()
          Returns the parameter name.
 java.lang.String getNameSpace()
          Returns the namespace for this parameter.
 int getSchemaSubType()
          Returns the schema sub type for this parameter.
 int getSequenceNumber()
          Returns the unique sequence number for this parameter.
 VWSession getSession()
          Get the session associated with this event definition.
 java.lang.String getValue()
          Returns the value of the value property; is not null.
 boolean isAttachmentByValue()
          Indicates whether the Process Engine will send the attachment data by value.
 void setArrayAttributes(java.lang.String arrayAttributes)
          Sets the attributes for an array specified by array tag and array namespace, for this parameter.
 void setArrayNameSpace(java.lang.String arrayNameSpace)
          Sets the namespace for an array tag for this parameter; may be null.
 void setArrayTag(java.lang.String arrayTag)
          Sets the array tag name for this parameter
 void setAttachmentByValue(boolean setting)
          Specifies whether the Process Engine will send the attachment data by value.
 void setAttributes(java.lang.String attributes)
          Sets the attributes for this parameter, as they are applied to this combination of namespace and parameter name.
 void setDataType(int theDataType)
          Sets the field data type.
 void setIsArray(boolean theIsArray)
          Sets the isArray flag on the parameter, specifying whether the parameter is an array.
 void setLexicalLevel(int level)
          Sets the level of nesting (containment) for this parameter.
 void setName(java.lang.String theName)
          Renames this parameter.
 void setNameSpace(java.lang.String nameSpace)
          Sets the namespace for this parameter.
 void setSchemaSubType(int schemaSubType)
          Sets the schema sub type for this parameter.
 void setSequenceNumber(int seq)
          Sets the unique sequence number for this parameter.
 void setValue(java.lang.String theValue)
          Modifies the parameter value.
 java.lang.String toString()
          Returns a string representation of this object
 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(java.util.Vector EDefVector, VWCompoundStepDefinition myStep)
          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, wait, wait, wait
 

Method Detail

_get_FILE_DATE

public static java.lang.String _get_FILE_DATE()
For FileNet internal use only, do not call.


_get_FILE_AUTHOR

public static java.lang.String _get_FILE_AUTHOR()
For FileNet internal use only, do not call.


_get_FILE_REVISION

public static java.lang.String _get_FILE_REVISION()
For FileNet internal use only, do not call.


setIsArray

public void setIsArray(boolean theIsArray)
                throws VWException
Sets the isArray flag on the parameter, specifying whether the parameter is an array.

Parameters:
theIsArray - true specifies the parameter is an array; false specifies otherwise.
Throws:
VWException - Thrown for various causes.

getIsArray

public boolean getIsArray()
Indicates whether the parameter is an array.

Returns:
A value of true indicates the parameter is an array; false indicates otherwise.

setName

public void setName(java.lang.String theName)
             throws VWException
Renames this parameter.

Parameters:
theName - A String containing the new name for the parameter. The name must conform to the following:
  • The name cannot be null or an empty string.
  • The name cannot contain spaces (' '), or tabs ('\t'), or colons (':')
Throws:
VWException - Thrown for various reasons, including invalid name format or duplication of another parameter name.

getName

public java.lang.String getName()
Returns the parameter name. If a translation source exists, the authored name is translated.

Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).

Returns:
A String containing the translated parameter name, if a translation source exists; otherwise the authored name is returned.
See Also:
setName

setValue

public void setValue(java.lang.String theValue)
              throws VWException
Modifies the parameter value.

Parameters:
theValue - New parameter value; may not be null.
Throws:
VWException - Causes include inputting a null value.

getValue

public java.lang.String getValue()
Returns the value of the value property; is not null.

Returns:
The value of the value property

setDataType

public void setDataType(int theDataType)
                 throws VWException
Sets the field data type.

Parameters:
theDataType - Integer value associated with the data type for the parameter.
Throws:
VWException - Causes include specifying an invalid type.
See Also:
VWFieldType

getDataType

public int getDataType()
Returns the integer value associated with the field data type of the parameter.

Returns:
Integer value associated with the data type of the parameter
See Also:
VWFieldType

getMode

public int getMode()
Returns an integer associated with the mode property for this parameter.

Returns:
Integer value associated with the mode of the parameter
See Also:
VWModeType

setAttachmentByValue

public void setAttachmentByValue(boolean setting)
                          throws VWException
Specifies whether the Process Engine will send the attachment data by value.

Parameters:
setting - true specifies the Process Engine will send the attachment by value.
Throws:
VWException

isAttachmentByValue

public boolean isAttachmentByValue()
                            throws VWException
Indicates whether the Process Engine will send the attachment data by value.

Returns:
true indicates the Process Engine will send the attachment by value.
Throws:
VWException

setNameSpace

public void setNameSpace(java.lang.String nameSpace)
                  throws VWException
Sets the namespace for this parameter.

Parameters:
nameSpace - Namespace for this parameter; may be null.
Throws:
VWException

getNameSpace

public java.lang.String getNameSpace()
                              throws VWException
Returns the namespace for this parameter.

Returns:
Namespace for this parameter; may be null
Throws:
VWException

setAttributes

public void setAttributes(java.lang.String attributes)
                   throws VWException
Sets the attributes for this parameter, as they are applied to this combination of namespace and parameter name.

Parameters:
attributes - Attributes for this parameter; may be null.
Throws:
VWException

getAttributes

public java.lang.String getAttributes()
                               throws VWException
Returns the attributes for this parameter, as they are applied to this combination of namespace and parameter name.

Returns:
Attributes for this parameter, as they are applied to this combination of namespace and parameter name. May be null.
Throws:
VWException

setArrayTag

public void setArrayTag(java.lang.String arrayTag)
                 throws VWException
Sets the array tag name for this parameter

Parameters:
arrayTag - Array tag name; may be null.
Throws:
VWException

getArrayTag

public java.lang.String getArrayTag()
                             throws VWException
Returns the array tag name for this parameter; may be null.

Returns:
Array tag name for this parameter; may be null.
Throws:
VWException

setArrayNameSpace

public void setArrayNameSpace(java.lang.String arrayNameSpace)
                       throws VWException
Sets the namespace for an array tag for this parameter; may be null. All array members of an array parameter are assumed to use the same namespace.

Parameters:
arrayNameSpace - Namespace for an array member
Throws:
VWException

getArrayNameSpace

public java.lang.String getArrayNameSpace()
                                   throws VWException
Returns the namespace for the array tag associated with this parameter.

Returns:
Namespace for the array tag associated with this parameter; may be null.
Throws:
VWException

setArrayAttributes

public void setArrayAttributes(java.lang.String arrayAttributes)
                        throws VWException
Sets the attributes for an array specified by array tag and array namespace, for this parameter.

Parameters:
arrayAttributes - Attributes for an array specified by an array tag and array namespace, for this parameter. May be null.
Throws:
VWException

getArrayAttributes

public java.lang.String getArrayAttributes()
                                    throws VWException
Returns the attributes for an array specified by an array tag and array namespace, for this parameter.

Returns:
Attributes for an array specified by array tag and array namespace, for this parameter. May be null.
Throws:
VWException

setSequenceNumber

public void setSequenceNumber(int seq)
                       throws VWException
Sets the unique sequence number for this parameter.

Parameters:
seq - Sequence number for the parameter. The sequence number (count) begins with zero (0), and increases monotonically to the total number of parameters, minus one (1).
Throws:
VWException
See Also:
Sequence example

getSequenceNumber

public int getSequenceNumber()
                      throws VWException
Returns the unique sequence number for this parameter. The sequence number (count) begins with zero (0), and increases monotonically to the total number of parameters, minus one (1).

Returns:
Unique sequence number for this parameter.
Throws:
VWException

setLexicalLevel

public void setLexicalLevel(int level)
                     throws VWException
Sets the level of nesting (containment) for this parameter. A parameter that is not contained by any other parameter has lexical level 0.

Parameters:
level - Level of nesting (containment), or lexical level for this parameter.
Note: If the lexical level for a given parameter is greater than the lexical level of the preceding (by sequence number) parameter, it can exceed the preceding level by a maximum value of one (1).
Throws:
VWException

getLexicalLevel

public int getLexicalLevel()
                    throws VWException
Returns the level of nesting (containment) for this parameter. A parameter that is not contained by any other parameter has lexical level 0.

Returns:
Level of nesting (containment) for this parameter.
Throws:
VWException
See Also:
setLexicalLevel(int)

setSchemaSubType

public void setSchemaSubType(int schemaSubType)
                      throws VWException
Sets the schema sub type for this parameter.

Parameters:
schemaSubType - the schema sub type for this parameter.
Throws:
VWException
See Also:
VWXMLSchemaSubType

getSchemaSubType

public int getSchemaSubType()
                     throws VWException
Returns the schema sub type for this parameter.

Returns:
schema sub type for this parameter.
Throws:
VWException
See Also:
setSchemaSubType(int), VWXMLSchemaSubType

toString

public java.lang.String toString()
Returns a string representation of this object

Overrides:
toString in class java.lang.Object
Returns:
String representation of this object.

toXML

public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
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:
VWXMLUtil

toXPDL

public void toXPDL(java.lang.String indentA,
                   java.lang.StringBuffer theBuffer)
            throws VWException
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:
VWXMLUtil

validate

public void validate(java.util.Vector EDefVector,
                     VWCompoundStepDefinition myStep)
              throws VWException
Validates this instance, appending any validation errors found to the specified Vector object.

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.

myStep - A VWCompoundStepDefinition object for the referenced step.
Throws:
VWException - Thrown if the validation cannot be performed.

getSession

public VWSession getSession()
                     throws VWException
Get the session associated with this event definition.

Returns:
The session associated with this event definition, may return null.
Throws:
VWException

Process API

© Copyright IBM Corporation 2002, 2008. All rights reserved.