IBM BPM API for Web Service Clients v8.0.0

com.lombardisoftware.webapi
Class SearchColumnMetaData

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

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

See Also:
Serialized Form

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

SearchColumnMetaData

public SearchColumnMetaData()

SearchColumnMetaData

public SearchColumnMetaData(java.lang.String type,
                            java.lang.String name,
                            java.lang.String displayName,
                            javax.xml.namespace.QName valueType,
                            boolean usableInSearchCondition)
Method Detail

getType

public java.lang.String getType()
Gets the type value for this SearchColumnMetaData.

Returns:
type * The name of the searchable type containing the column. Currently supported searchable types are:
  • BusinessData
  • Process
  • ProcessInstance
  • Task
These values are also made available via the SearchableType enumeration type for the convenience of the client programmer.

setType

public void setType(java.lang.String type)
Sets the type value for this SearchColumnMetaData.

Parameters:
type - * The name of the searchable type containing the column. Currently supported searchable types are:
  • BusinessData
  • Process
  • ProcessInstance
  • Task
These values are also made available via the SearchableType enumeration type for the convenience of the client programmer.

getName

public java.lang.String getName()
Gets the name value for this SearchColumnMetaData.

Returns:
name *

The name of the column in the searchable type. Currently supported searchable column names are for the corresponding searchable types are:

  • Process:
    • Name
  • ProcessInstance:
    • Id
    • Name
    • DueDate
    • Status
  • Task:
    • Id
    • AssignedToUser
    • AssignedToRole
    • Status
    • DueDate
    • Priority
    • Subject
    • ReceivedDate
    • ClosedDate
    • SentDate
    • ReadDate
    • ReceivedFrom
    • ClosedBy

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:

  1. Specify that the variable is visible in search in the authoring environment by enabling it for search and entering a business data search alias. This is the prefered way to search business data for process instances as it causes the process engine to store the variable values directly in the database where they can be returned in the search results and used as part of search conditions. A value returned for a given business data search alias is the latest value recorded in the process instance by either the top level process or by a sub-process.
  2. Add a search condition for Process Name to narrow the search results down to those that are related to a specific process and then include business data columns described by results of the GetSearchMetaDataForProcess operation for that process. This is not the preferred way since it will force the system to load the process instance execution data for each row in the search results to retrieve the process instance variable value. Columns specified in this fashion are not usable as part of search conditions and can only be included in the search results. Values contained in complex types with be returned using "variable.property" syntax for the column name. Access is limited to variables defined in the top level process for the process instance using this approach.

In both cases BusinessData columns are limited to single simple values -- no lists of simple values or complex values are returned.


setName

public void setName(java.lang.String name)
Sets the name value for this SearchColumnMetaData.

Parameters:
name - *

The name of the column in the searchable type. Currently supported searchable column names are for the corresponding searchable types are:

  • Process:
    • Name
  • ProcessInstance:
    • Id
    • Name
    • DueDate
    • Status
  • Task:
    • Id
    • AssignedToUser
    • AssignedToRole
    • Status
    • DueDate
    • Priority
    • Subject
    • ReceivedDate
    • ClosedDate
    • SentDate
    • ReadDate
    • ReceivedFrom
    • ClosedBy

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:

  1. Specify that the variable is visible in search in the authoring environment by enabling it for search and entering a business data search alias. This is the prefered way to search business data for process instances as it causes the process engine to store the variable values directly in the database where they can be returned in the search results and used as part of search conditions. A value returned for a given business data search alias is the latest value recorded in the process instance by either the top level process or by a sub-process.
  2. Add a search condition for Process Name to narrow the search results down to those that are related to a specific process and then include business data columns described by results of the GetSearchMetaDataForProcess operation for that process. This is not the preferred way since it will force the system to load the process instance execution data for each row in the search results to retrieve the process instance variable value. Columns specified in this fashion are not usable as part of search conditions and can only be included in the search results. Values contained in complex types with be returned using "variable.property" syntax for the column name. Access is limited to variables defined in the top level process for the process instance using this approach.

In both cases BusinessData columns are limited to single simple values -- no lists of simple values or complex values are returned.


getDisplayName

public java.lang.String getDisplayName()
Gets the displayName value for this SearchColumnMetaData.

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


setDisplayName

public void setDisplayName(java.lang.String displayName)
Sets the displayName value for this SearchColumnMetaData.

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


getValueType

public javax.xml.namespace.QName getValueType()
Gets the valueType value for this SearchColumnMetaData.

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

setValueType

public void setValueType(javax.xml.namespace.QName valueType)
Sets the valueType value for this SearchColumnMetaData.

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

isUsableInSearchCondition

public boolean isUsableInSearchCondition()
Gets the usableInSearchCondition value for this SearchColumnMetaData.

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

setUsableInSearchCondition

public void setUsableInSearchCondition(boolean usableInSearchCondition)
Sets the usableInSearchCondition value for this SearchColumnMetaData.

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

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.