|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWWebServiceParameterDefinition
public final class VWWebServiceParameterDefinition
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" is the array tag for the members array parameter, which could be retrieved with getArrayTag(). Note that all the parameter array members of one array are associated with the same namespace, which is displayed by getArrayNameSpace().]
VWModeType
,
VWFieldType
,
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 |
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 |
---|
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 setIsArray(boolean theIsArray) throws VWException
theIsArray
- true
specifies the parameter is
an array; false
specifies otherwise.
VWException
- Thrown for various causes.public boolean getIsArray()
true
indicates the parameter is
an array; false
indicates otherwise.public void setName(java.lang.String theName) throws VWException
theName
- A String containing the new name for the parameter. The name must conform to
the following:
VWException
- Thrown for various reasons, including invalid name format or
duplication of another parameter name.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).
setName
public void setValue(java.lang.String theValue) throws VWException
theValue
- New parameter value; may not be null.
VWException
- Causes include inputting a null value.public java.lang.String getValue()
null
.
public void setDataType(int theDataType) throws VWException
field data type
.
theDataType
- Integer value associated with the
data type for the parameter.
VWException
- Causes include specifying an invalid type.VWFieldType
public int getDataType()
field data type
of the parameter.
VWFieldType
public int getMode()
mode property
for this parameter.
VWModeType
public void setAttachmentByValue(boolean setting) throws VWException
setting
- true
specifies the Process Engine
will send the attachment by value.
VWException
public boolean isAttachmentByValue() throws VWException
true
indicates the Process Engine
will send the attachment by value.
VWException
public void setNameSpace(java.lang.String nameSpace) throws VWException
nameSpace
- Namespace for this parameter; may be
null
.
VWException
public java.lang.String getNameSpace() throws VWException
null
VWException
public void setAttributes(java.lang.String attributes) throws VWException
attributes
- Attributes for this parameter; may be
null
.
VWException
public java.lang.String getAttributes() throws VWException
null
.
VWException
public void setArrayTag(java.lang.String arrayTag) throws VWException
arrayTag
- Array tag name; may be null
.
VWException
public java.lang.String getArrayTag() throws VWException
null
.
null
.
VWException
public void setArrayNameSpace(java.lang.String arrayNameSpace) throws VWException
null
. All array members of an
array parameter are assumed to use the same namespace.
arrayNameSpace
- Namespace for an array member
VWException
public java.lang.String getArrayNameSpace() throws VWException
null
.
VWException
public void setArrayAttributes(java.lang.String arrayAttributes) throws VWException
arrayAttributes
- Attributes for an array specified by
an array tag
and array namespace, for this parameter. May be
null
.
VWException
public java.lang.String getArrayAttributes() throws VWException
null
.
VWException
public void setSequenceNumber(int seq) throws VWException
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).
VWException
public int getSequenceNumber() throws VWException
VWException
public void setLexicalLevel(int level) throws VWException
level
- Level of nesting (containment), or lexical level
for this parameter.VWException
public int getLexicalLevel() throws VWException
VWException
setLexicalLevel(int)
public void setSchemaSubType(int schemaSubType) throws VWException
schemaSubType
- the schema sub type
for this parameter.
VWException
VWXMLSchemaSubType
public int getSchemaSubType() throws VWException
VWException
setSchemaSubType(int)
,
VWXMLSchemaSubType
public java.lang.String toString()
toString
in class java.lang.Object
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 void validate(java.util.Vector EDefVector, VWCompoundStepDefinition myStep) 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.
myStep
- A VWCompoundStepDefinition object for the referenced step.
VWException
- Thrown if the validation cannot be performed.public VWSession getSession() throws VWException
VWException
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |