IBM BPM API for Web Service Clients v8.0.0

com.lombardisoftware.webapi
Class ClientInfo

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

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

The ClientInfo type is used in a SOAP header to pass information about the client invoking a WebAPI operation. It is required for all operations in the WebAPI except for TestConnection.

See Also:
Serialized Form

Constructor Summary
ClientInfo()
           
ClientInfo(java.lang.String timeZone, java.lang.String locale, boolean acceptsTimeZone, java.lang.String version, java.lang.Boolean safelyIgnoresExtraXml)
           
 
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 getLocale()
          Gets the locale value for this ClientInfo.
 java.lang.Boolean getSafelyIgnoresExtraXml()
          Gets the safelyIgnoresExtraXml value for this ClientInfo.
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 getTimeZone()
          Gets the timeZone value for this ClientInfo.
static org.apache.axis.description.TypeDesc getTypeDesc()
          Return type metadata object
 java.lang.String getVersion()
          Gets the version value for this ClientInfo.
 int hashCode()
           
 boolean isAcceptsTimeZone()
          Gets the acceptsTimeZone value for this ClientInfo.
 void setAcceptsTimeZone(boolean acceptsTimeZone)
          Sets the acceptsTimeZone value for this ClientInfo.
 void setLocale(java.lang.String locale)
          Sets the locale value for this ClientInfo.
 void setSafelyIgnoresExtraXml(java.lang.Boolean safelyIgnoresExtraXml)
          Sets the safelyIgnoresExtraXml value for this ClientInfo.
 void setTimeZone(java.lang.String timeZone)
          Sets the timeZone value for this ClientInfo.
 void setVersion(java.lang.String version)
          Sets the version value for this ClientInfo.
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ClientInfo

public ClientInfo()

ClientInfo

public ClientInfo(java.lang.String timeZone,
                  java.lang.String locale,
                  boolean acceptsTimeZone,
                  java.lang.String version,
                  java.lang.Boolean safelyIgnoresExtraXml)
Method Detail

getTimeZone

public java.lang.String getTimeZone()
Gets the timeZone value for this ClientInfo.

Returns:
timeZone * The time zone offset from GMT in the form (('+' | '-') hh ':' mm) that is used when interpreting dateTime, time, and date that have no time zone information. Examples: -06:00, +02:00

setTimeZone

public void setTimeZone(java.lang.String timeZone)
Sets the timeZone value for this ClientInfo.

Parameters:
timeZone - * The time zone offset from GMT in the form (('+' | '-') hh ':' mm) that is used when interpreting dateTime, time, and date that have no time zone information. Examples: -06:00, +02:00

getLocale

public java.lang.String getLocale()
Gets the locale value for this ClientInfo.

Returns:
locale * The locale of the client in the form [language]-[country] where language and country are the two letter abbreviations from the ISO 639 and ISO 3166 standards. Examples: en-US (English/United States), fr (French), de (German).

setLocale

public void setLocale(java.lang.String locale)
Sets the locale value for this ClientInfo.

Parameters:
locale - * The locale of the client in the form [language]-[country] where language and country are the two letter abbreviations from the ISO 639 and ISO 3166 standards. Examples: en-US (English/United States), fr (French), de (German).

isAcceptsTimeZone

public boolean isAcceptsTimeZone()
Gets the acceptsTimeZone value for this ClientInfo.

Returns:
acceptsTimeZone * A flag indicating that the client can accept time zone information for dateTime, time, and date data types.

setAcceptsTimeZone

public void setAcceptsTimeZone(boolean acceptsTimeZone)
Sets the acceptsTimeZone value for this ClientInfo.

Parameters:
acceptsTimeZone - * A flag indicating that the client can accept time zone information for dateTime, time, and date data types.

getVersion

public java.lang.String getVersion()
Gets the version value for this ClientInfo.

Returns:
version * The version of this API that the client is using in X.Y.Z format. This value can be found in this WSDL file in the "api" annotation element. Defaults to 5.5.5 (the API version used by LFO 1.0 SP1) if no value is provided.

setVersion

public void setVersion(java.lang.String version)
Sets the version value for this ClientInfo.

Parameters:
version - * The version of this API that the client is using in X.Y.Z format. This value can be found in this WSDL file in the "api" annotation element. Defaults to 5.5.5 (the API version used by LFO 1.0 SP1) if no value is provided.

getSafelyIgnoresExtraXml

public java.lang.Boolean getSafelyIgnoresExtraXml()
Gets the safelyIgnoresExtraXml value for this ClientInfo.

Returns:
safelyIgnoresExtraXml * A flag indicating that the client safely ignores extra XML elements and attributes that might be present on data in the response returned by the server. A .NET client should set this to true since the .NET XML serialization implementation ignores extra XML. Axis 1.3 clients should pass false since the Axis XML serialization implementation will throw an exception when it encounters extra elements/attributes. Defaults to false if no value is provided.

setSafelyIgnoresExtraXml

public void setSafelyIgnoresExtraXml(java.lang.Boolean safelyIgnoresExtraXml)
Sets the safelyIgnoresExtraXml value for this ClientInfo.

Parameters:
safelyIgnoresExtraXml - * A flag indicating that the client safely ignores extra XML elements and attributes that might be present on data in the response returned by the server. A .NET client should set this to true since the .NET XML serialization implementation ignores extra XML. Axis 1.3 clients should pass false since the Axis XML serialization implementation will throw an exception when it encounters extra elements/attributes. Defaults to false if no value is provided.

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.