|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWWorkBasketColumnDefinition
public class VWWorkBasketColumnDefinition
Use this class to create, read, delete, or modify workbasket column definition properties.
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. |
VWAttributeInfo |
getAttributeInfo()
Gets the workbasket column definition attributes as paired labels (hashtable keys) and values in String format. |
java.lang.String |
getAuthoredName()
Gets the name originally assigned to the workbasket column definition. |
VWExposedFieldDefinition |
getColumn()
Gets the VWExposedFieldDefinition for the workbasket column definition. |
java.lang.String |
getIndexName()
|
java.lang.String |
getName()
Gets the current name for the workbasket column definition. |
java.lang.String |
getPrompt()
Gets the prompt used for the workbasket column definition. |
int |
getType()
Gets the field type used for the workbasket column field. |
boolean |
isSortable()
Indicates whether or not the workbasket column can be sorted. |
void |
setAttributeInfo(VWAttributeInfo theAttributeInfo)
Sets the attributes property value for the workbasket column definition. |
void |
setColumn(VWExposedFieldDefinition column)
Gets the VWExposedFieldDefinition for the workbasket column definition. |
void |
setIndexName(java.lang.String indexName)
|
void |
setPrompt(java.lang.String thePrompt)
Sets the name for the workbasket column definition. |
void |
setSortable(boolean bIsSortable)
|
java.lang.String |
toString()
Gets the String version of this workbasket column definition. |
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 getName() throws VWException
VWException
public java.lang.String getAuthoredName() throws VWException
VWException
public java.lang.String getPrompt() throws VWException
VWException
public void setPrompt(java.lang.String thePrompt) throws VWException
theName
- A String containing the name to assign to the workbasket column definition.
VWException
- Thrown if the name is null or invalid.public boolean isSortable() throws VWException
VWException
public void setSortable(boolean bIsSortable)
public int getType() throws VWException
VWException
VWExposedFieldDefinition.getFieldType()
public VWExposedFieldDefinition getColumn() throws VWException
VWException
public void setColumn(VWExposedFieldDefinition column) throws VWException
A
- VWExposedFieldDefinition object identifying the workbasket column definition.
VWException
public java.lang.String getIndexName() throws VWException
VWException
public void setIndexName(java.lang.String indexName) throws VWException
VWException
public VWAttributeInfo getAttributeInfo() throws VWException
VWException
setAttributeInfo(filenet.vw.api.VWAttributeInfo)
public void setAttributeInfo(VWAttributeInfo theAttributeInfo) throws VWException
theAttributeInfo
- A VWAttributeInfo object containing the string and value pairs representing the
attributes for the workbasket column definition.
VWException
getAttributeInfo()
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.
toXML
in interface IVWtoXML
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 |