com.avalara.avatax.services.base
Class Profile

java.lang.Object
  extended by com.avalara.avatax.services.base.Profile

public class Profile
extends java.lang.Object

The request profile provides information about the calling application and may be used for customized request processing.

 Example:
 EngineConfiguration config = new FileProvider("avatax4j.wsdd");

 AddressSvcLocator svcLoc = new AddressSvcLocator(config);
 AddressSvcSoap svc = svcLoc.getAddressSvcSoap(new URL("http://www.avalara.com/services/"));

 // Set the profile
 Profile profile = new Profile();
 profile.setClient("AddressSvcTest,4.0.0.0");
 svc.setProfile(profile);

 // Set security
 Security security = new Security();
 security.setAccount("account");
 security.setLicense("license number");
 svc.setSecurity(security);

 PingResult result = svc.ping("");
 


Field Summary
static java.lang.String NAMESPACE
           
static java.lang.String PROFILE_ELEMENT
           
 
Constructor Summary
Profile()
          Initializes a new instance of the class.
 
Method Summary
 java.lang.String getClient()
          Client application name and version (and plugin name and version, if applicable).
 java.lang.String getName()
          Reference to a named profile.
 org.apache.axis.message.SOAPHeaderElement getSOAPHeaderElement()
          Returns the SOAPHeaderElement for this Profile object; this method is used internally by the adapter and not intended to be used by external implementation code.
 void setClient(java.lang.String value)
          Client application name and version (and plugin name and version, if applicable).
 void setName(java.lang.String value)
          Reference to a named profile.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROFILE_ELEMENT

public static final java.lang.String PROFILE_ELEMENT
See Also:
Constant Field Values

NAMESPACE

public static final java.lang.String NAMESPACE
See Also:
Constant Field Values
Constructor Detail

Profile

public Profile()
Initializes a new instance of the class.

Method Detail

setName

public void setName(java.lang.String value)
Reference to a named profile. Designed to allow shared and custom profile. Reserved for future use.

Parameters:
value - String value to use for this profile.

getName

public java.lang.String getName()
Reference to a named profile. Designed to allow shared and custom profile. Reserved for future use.

Returns:
String value to use for this profile.

setClient

public void setClient(java.lang.String value)
Client application name and version (and plugin name and version, if applicable). This should be of the form: Application,ApplicationVersion[,Plugin,PluginVersion]. The plugin information is optional in the case of a direct or custom application integration.
SegmentDescription
ApplicationName of the application (e.g. SuperERP)
ApplicationVersionVersion of the application (e.g. 2.5.1.23)
PluginName of the plugin, if applicable (e.g. DuperPlugin)
PluginVersionVersion of the plugin, if applicable (e.g. 2.5.0.1)

Example:
[C#]
svc.Profile.Client = "SuperERP,2.5.1.23,DuperPlugin,2.5.0.1"

Parameters:
value - String containing client information

getClient

public java.lang.String getClient()
Client application name and version (and plugin name and version, if applicable). This should be of the form: Application,ApplicationVersion[,Plugin,PluginVersion]. The plugin information is optional in the case of a direct or custom application integration.
SegmentDescription
ApplicationName of the application (e.g. SuperERP)
ApplicationVersionVersion of the application (e.g. 2.5.1.23)
PluginName of the plugin, if applicable (e.g. DuperPlugin)
PluginVersionVersion of the plugin, if applicable (e.g. 2.5.0.1)

Example:
[C#]
svc.Profile.Client = "SuperERP,2.5.1.23,DuperPlugin,2.5.0.1"

Returns:
String containing client information

getSOAPHeaderElement

public org.apache.axis.message.SOAPHeaderElement getSOAPHeaderElement()
                                                               throws javax.xml.soap.SOAPException
Returns the SOAPHeaderElement for this Profile object; this method is used internally by the adapter and not intended to be used by external implementation code.

Returns:
a SOAPHeaderElement containing information about the Profile object.
Throws:
javax.xml.soap.SOAPException