|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWIndexDefinition
public final class VWIndexDefinition
Use this class to define an index that contains concatenated field names--names which consist of the exposed or system fields. Arrays are not allowed. These indices conserve resources when searching rosters, queues, and logs.
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[] |
getAuthoredFieldNames()
Returns the authored (untranslated) field names of the concatenated index. |
java.lang.String |
getAuthoredName()
Gets the string containing the authored, untranslated name of the index field. |
java.lang.String[] |
getFieldNames()
Returns the field names of the concatenated index. |
java.lang.String |
getName()
Gets the index name associated with the index definition. |
boolean |
isMandatorySystemIndex()
Indicates whether or not the index is a mandatory system index. |
boolean |
isSystemIndex()
Indicates whether or not the index is a system index. |
void |
setFieldNames(java.lang.String[] theFieldNames)
Sets the index definition to the specified field names. |
java.lang.String |
toString()
Gets a string version of the VWIndexDefinition object. |
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, 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 java.lang.String[] getFieldNames()
Note: The translation is done only at runtime, so will not appear in design-time applications (such as the Process Designer or Configuration Console).
Note: Certain system index fields are for internal use only and are not exposed.
public java.lang.String[] getAuthoredFieldNames()
Note: Certain system index fields are not made visible and are for internal use only.
public void setFieldNames(java.lang.String[] theFieldNames) throws VWException
theFieldNames
- The field names that define the concatenated
index.
VWException
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 toString()
toString
in class java.lang.Object
public java.lang.String getAuthoredName() throws VWException
VWException
public boolean isSystemIndex()
true
if the index is
a system index; otherwise, false.public boolean isMandatorySystemIndex()
true
if the index is
a mandatory system index; otherwise, false.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 |