|
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.Search
public class Search
A search object describes a search to be performed against process runtime data including tasks and process instances.
Constructor Summary | |
---|---|
Search()
|
|
Search(java.lang.String organizedByType,
SearchColumn[] columns,
SearchCondition[] conditions,
SearchOrdering[] orderBy)
|
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
|
SearchColumn[] |
getColumns()
Gets the columns value for this Search. |
SearchCondition[] |
getConditions()
Gets the conditions value for this Search. |
static org.apache.axis.encoding.Deserializer |
getDeserializer(java.lang.String mechType,
java.lang.Class _javaType,
javax.xml.namespace.QName _xmlType)
Get Custom Deserializer |
SearchOrdering[] |
getOrderBy()
Gets the orderBy value for this Search. |
java.lang.String |
getOrganizedByType()
Gets the organizedByType value for this Search. |
static org.apache.axis.encoding.Serializer |
getSerializer(java.lang.String mechType,
java.lang.Class _javaType,
javax.xml.namespace.QName _xmlType)
Get Custom Serializer |
static org.apache.axis.description.TypeDesc |
getTypeDesc()
Return type metadata object |
int |
hashCode()
|
void |
setColumns(SearchColumn[] columns)
Sets the columns value for this Search. |
void |
setConditions(SearchCondition[] conditions)
Sets the conditions value for this Search. |
void |
setOrderBy(SearchOrdering[] orderBy)
Sets the orderBy value for this Search. |
void |
setOrganizedByType(java.lang.String organizedByType)
Sets the organizedByType value for this Search. |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Search()
public Search(java.lang.String organizedByType, SearchColumn[] columns, SearchCondition[] conditions, SearchOrdering[] orderBy)
Method Detail |
---|
public java.lang.String getOrganizedByType()
public void setOrganizedByType(java.lang.String organizedByType)
organizedByType
- * Valid values for OrganizedByType are Task or ProcessInstance.
When a search is
organized by Task, it will result a row for each task
that matches the search
criteria. When a search is organized by ProcessInstance,
it will return a row
for each process instance. If the search contains task
fields, only information
for the most important task will be included in the
result row.public SearchColumn[] getColumns()
public void setColumns(SearchColumn[] columns)
columns
- * The Columns collection specifies the columns to be returned
in the search results.
See the documentation for SearchColumn for details on
how columns are specified.public SearchCondition[] getConditions()
public void setConditions(SearchCondition[] conditions)
conditions
- * The Conditions collection specifies the conditions to be used
to narrow the
search results. See the documentation for SearchCondition
for details on how
conditions are specified.public SearchOrdering[] getOrderBy()
public void setOrderBy(SearchOrdering[] orderBy)
orderBy
- * The OrderBy collection specifies how the search results are
ordered. See the documentation
for SearchOrdering for details on how the ordering is
specified. Note that there
is a limit of two orderings in OrderBy collection.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 |