|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWAttributeInfo
public final class VWAttributeInfo
VWAttributeInfo objects contain a set of name-value pairs; the VWAttributeInfo class enables users to associate properties they define with VWOperationDefinition, VWQueueDefinition, VWStepDefinition, VWSystemAdministration, VWSystemConfiguration, and VWWorkflowDefinition objects.
Initialize or modify an instance of this class using the setAttributeInfo method in any of these associated classes; get an instance of this class with the getAttributeInfo method of any of these associated classes. Individual values held in a VWAttributeInfo object may be accessed and maintained with the methods documented here.
Other workflow-related applications, such as System Console, may also use attributes to hold settings or other functional results. These applications may initialize or maintain attributes whose names are prefixed with "F_".
Contents of a VWSystemAdministration-produced VWAttributeInfo
object are saved to the workflow server with VWSystemAdministration.commit()
. Contents of a
VWAttributeInfo object associated with a VWSystemConfiguration or
VWQueueDefinition object is saved to the workflow server with
VWSystemConfiguration.commit()
.
The VWAttributeInfo objects associated with the
VWWorkflowDefinition, VWStepDefinition, and VWOperation classes
are saved to the workflow server with a session transfer, using
VWSession.transfer(VWWorkflowDefinition, String, boolean,
boolean)
.
Constructor Summary | |
---|---|
VWAttributeInfo()
Constructor for creating a VWAttributeInfo Object. |
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. |
void |
deleteField(java.lang.String fieldName)
Deletes a field entry, specified by name. |
java.lang.String[] |
getAttributeNames()
Gets the attribute names. |
int |
getFieldType(java.lang.String fieldName)
Returns the field type of the input field name. |
java.lang.Object |
getFieldValue(java.lang.String fieldName)
Gets the object value for the input field name. |
boolean |
isFieldArray(java.lang.String fieldName)
Determines whether a field is an array. |
void |
setFieldValue(java.lang.String fieldName,
java.lang.Object fieldValue)
Initializes, updates, or deletes an attribute. |
void |
toXML(java.lang.StringBuffer theBuffer)
Appends an XML string representing this instance to the buffer specified. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public VWAttributeInfo() throws VWException
VWException
VWException
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 setFieldValue(java.lang.String fieldName, java.lang.Object fieldValue) throws VWException
fieldName
- The name of the attribute whose value is
to be set. May not be null.fieldValue
- The object value for the named attribute.
The type for this object must be one of the basic field types.
Null is not permitted if the fieldName parameter
does not name an existing attribute.
VWException
- Causes include the following conditions:
getFieldType(String)
,
VWFieldType
public java.lang.Object getFieldValue(java.lang.String fieldName) throws VWException
fieldName
- The input name to specify the attribute
(VWAttributeInfo field).
VWException
- Thrown if the fieldName parameter is null.getFieldType(String)
,
setFieldValue(String, Object)
public int getFieldType(java.lang.String fieldName) throws VWException
fieldName
- The name of the field
whose type will be returned.
VWException
- Thrown if the fieldName parameter is null.public boolean isFieldArray(java.lang.String fieldName) throws VWException
fieldName
- The name of the field to check.
VWException
- Thrown if the fieldName parameter is null.public void deleteField(java.lang.String fieldName) throws VWException
fieldName
- The name of the field to be deleted.
VWException
- Thrown if it cannot
delete the specified field entry--for example, if the
field name does not exist.public java.lang.String[] getAttributeNames() throws VWException
VWException
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
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |