|
IBM BPM API for Web Service Clients v8.0.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.lombardisoftware.webapi.SearchColumnMetaData
public class SearchColumnMetaData
Constructor Summary | |
---|---|
SearchColumnMetaData()
|
|
SearchColumnMetaData(java.lang.String type,
java.lang.String name,
java.lang.String displayName,
javax.xml.namespace.QName valueType,
boolean usableInSearchCondition)
|
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
|
static org.apache.axis.encoding.Deserializer |
getDeserializer(java.lang.String mechType,
java.lang.Class _javaType,
javax.xml.namespace.QName _xmlType)
Get Custom Deserializer |
java.lang.String |
getDisplayName()
Gets the displayName value for this SearchColumnMetaData. |
java.lang.String |
getName()
Gets the name value for this SearchColumnMetaData. |
static org.apache.axis.encoding.Serializer |
getSerializer(java.lang.String mechType,
java.lang.Class _javaType,
javax.xml.namespace.QName _xmlType)
Get Custom Serializer |
java.lang.String |
getType()
Gets the type value for this SearchColumnMetaData. |
static org.apache.axis.description.TypeDesc |
getTypeDesc()
Return type metadata object |
javax.xml.namespace.QName |
getValueType()
Gets the valueType value for this SearchColumnMetaData. |
int |
hashCode()
|
boolean |
isUsableInSearchCondition()
Gets the usableInSearchCondition value for this SearchColumnMetaData. |
void |
setDisplayName(java.lang.String displayName)
Sets the displayName value for this SearchColumnMetaData. |
void |
setName(java.lang.String name)
Sets the name value for this SearchColumnMetaData. |
void |
setType(java.lang.String type)
Sets the type value for this SearchColumnMetaData. |
void |
setUsableInSearchCondition(boolean usableInSearchCondition)
Sets the usableInSearchCondition value for this SearchColumnMetaData. |
void |
setValueType(javax.xml.namespace.QName valueType)
Sets the valueType value for this SearchColumnMetaData. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public SearchColumnMetaData()
public SearchColumnMetaData(java.lang.String type, java.lang.String name, java.lang.String displayName, javax.xml.namespace.QName valueType, boolean usableInSearchCondition)
Method Detail |
---|
public java.lang.String getType()
public void setType(java.lang.String type)
type
- * The name of the searchable type containing the column. Currently
supported searchable types are:
public java.lang.String getName()
The name of the column in the searchable type. Currently supported searchable column names are for the corresponding searchable types are:
These column names are also made available via the SearchableProcessColumn, SearchableProcessInstanceColumn, and SearchableTaskColumn enumeration types respectively for the convenience of the client programmer.
BusinessData is considered to be a special type since the available columns are determined at authoring time. There are two ways of accessing business data in a search:
In both cases BusinessData columns are limited to single simple values -- no lists of simple values or complex values are returned.
public void setName(java.lang.String name)
name
- * The name of the column in the searchable type. Currently supported searchable column names are for the corresponding searchable types are:
These column names are also made available via the SearchableProcessColumn, SearchableProcessInstanceColumn, and SearchableTaskColumn enumeration types respectively for the convenience of the client programmer.
BusinessData is considered to be a special type since the available columns are determined at authoring time. There are two ways of accessing business data in a search:
In both cases BusinessData columns are limited to single simple values -- no lists of simple values or complex values are returned.
public java.lang.String getDisplayName()
The display name of the column in the searchable type. Currently this is either localized name of the column or business data alias. Business data alias can be entered through the portal.
public void setDisplayName(java.lang.String displayName)
displayName
- * The display name of the column in the searchable type. Currently this is either localized name of the column or business data alias. Business data alias can be entered through the portal.
public javax.xml.namespace.QName getValueType()
public void setValueType(javax.xml.namespace.QName valueType)
valueType
- * The XML Schema qualified type name of the values for this column.
This can be used by the client to implement sorting
logic or to limit
search conditions based on type.public boolean isUsableInSearchCondition()
public void setUsableInSearchCondition(boolean usableInSearchCondition)
usableInSearchCondition
- * UsableInSearchCondition is a flag that indicates that this
column can
be used as part of a search condition. It always returns
true since
any column that is available in search results can also
be used as part
of a search condition.public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public static org.apache.axis.description.TypeDesc getTypeDesc()
public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType)
|
IBM BPM API for Web Service Clients v8.0.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |