|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWExposedFieldDefinition
public final class VWExposedFieldDefinition
Use this class to designate specific search fields for roster, queue, and log classes. To initially use this class, you must call methods from any of the following VWSystemConfiguration-derived classes:
VWLogDefinition
,
VWQueueDefinition
,
VWRosterDefinition
,
VWSystemConfiguration
,
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 |
getAuthoredName()
Gets the authored, untranslated name of this exposed data field. |
int |
getFieldSourceType()
Gets the search data source field type. |
int |
getFieldType()
Gets the search data field type. |
int |
getLength()
Gets the byte length of string data to be stored in the database search data field. |
java.lang.String |
getName()
Gets the the name of this instance. |
java.lang.String |
getPrompt()
Gets the the prompt of this instance. |
java.lang.String |
getSourceName()
Gets the source name of this instance. |
boolean |
hasChanged()
Returns whether or not this exposed field has changed. |
boolean |
isMandatorySystemField()
Indicates whether the system data field is a mandatory or not. |
boolean |
isSystemField()
Determines whether the data field is a system field. |
void |
setLength(int theLength)
Sets the byte length of string data to be stored in the search data field. |
void |
setPrompt(java.lang.String thePrompt)
Sets the the prompt of this instance. |
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 |
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 int getFieldType()
Basic data field types are:
public int getLength()
public void setLength(int theLength) throws VWException
theLength
- An integer value that specifies the number of
bytes to store in the database field.
VWException
- Thrown if the data
field is a system field or if the data field type is not String.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).
public java.lang.String getAuthoredName() throws VWException
VWException
public boolean isSystemField()
public boolean isMandatorySystemField()
public boolean hasChanged()
public int getFieldSourceType()
public java.lang.String getSourceName()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
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 java.lang.String getPrompt()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
public void setPrompt(java.lang.String thePrompt)
thePrompt
- prompt string for the exposed field.
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |