IBM BPM API for Web Service Clients v8.0.0

com.lombardisoftware.webapi
Class Search

java.lang.Object
  extended by com.lombardisoftware.webapi.Search
All Implemented Interfaces:
java.io.Serializable

public class Search
extends java.lang.Object
implements java.io.Serializable

A search object describes a search to be performed against process runtime data including tasks and process instances.

See Also:
Serialized Form

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

Search

public Search()

Search

public Search(java.lang.String organizedByType,
              SearchColumn[] columns,
              SearchCondition[] conditions,
              SearchOrdering[] orderBy)
Method Detail

getOrganizedByType

public java.lang.String getOrganizedByType()
Gets the organizedByType value for this Search.

Returns:
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.

setOrganizedByType

public void setOrganizedByType(java.lang.String organizedByType)
Sets the organizedByType value for this Search.

Parameters:
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.

getColumns

public SearchColumn[] getColumns()
Gets the columns value for this Search.

Returns:
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.

setColumns

public void setColumns(SearchColumn[] columns)
Sets the columns value for this Search.

Parameters:
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.

getConditions

public SearchCondition[] getConditions()
Gets the conditions value for this Search.

Returns:
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.

setConditions

public void setConditions(SearchCondition[] conditions)
Sets the conditions value for this Search.

Parameters:
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.

getOrderBy

public SearchOrdering[] getOrderBy()
Gets the orderBy value for this Search.

Returns:
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.

setOrderBy

public void setOrderBy(SearchOrdering[] orderBy)
Sets the orderBy value for this Search.

Parameters:
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.

equals

public boolean equals(java.lang.Object obj)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()
Return type metadata object


getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)
Get Custom Serializer


getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)
Get Custom Deserializer


IBM BPM API for Web Service Clients v8.0.0

(C) Copyright IBM Corporation 2011. All Rights Reserved.