Package net.webpdf.wsclient.schema.operation

Class BillingType

  • All Implemented Interfaces:
    ParameterInterface
    public class BillingType
extends Object
implements ParameterInterface
     <?xml version="1.0" encoding="UTF-8"?><p xmlns:p644063_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p831178_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">The <code>billing</code> element can be used to affect the values that are written to the server's statistics logs (called "billing logs") for the web service call.
                 </p>

    Java class for BillingType complex type

    .

    The following schema fragment specifies the expected content contained within this class.

    
 <complexType name="BillingType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <attribute name="customerCode" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="userName" type="{http://www.w3.org/2001/XMLSchema}string" default="" />
       <attribute name="applicationName" type="{http://www.w3.org/2001/XMLSchema}string" default="external" />
     </restriction>
   </complexContent>
 </complexType>

    • Field Detail

      • customerCode

        protected String customerCode
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p644063_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p831178_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">A free text that identifies the customer calling the web service. This attribute makes it possible to analyze the logs with regard to specific customers, for example.</p>

      • userName

        protected String userName
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p644063_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p831178_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">A free text that specifies the name of the user calling the web service. This attribute makes it possible to analyze the logs with regard to specific users, for example.
                     </p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p644063_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p831178_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         If the web service is called from the server's portal and a user is logged in, the user's name will be entered automatically.
                     </p>

      • applicationName

        protected String applicationName
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p644063_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p831178_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">A free text that specifies the name of the application calling the web service. This attribute makes it possible to analyze the logs with regard to specific applications, for example.
 
                     </p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p644063_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p831178_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         If the web service is called by an external application that does not set its own value for "applicationName", a value of "external" will be entered automatically. If the web service is called from the server's portal, a value of "portal" will be entered automatically.
                     </p>

    • Constructor Detail

      • BillingType

        public BillingType()

    • Method Detail

      • getCustomerCode

        public String getCustomerCode()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p644063_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p831178_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">A free text that identifies the customer calling the web service. This attribute makes it possible to analyze the logs with regard to specific customers, for example.</p>
        Returns:
        possible object is String

      • setCustomerCode

        public void setCustomerCode​(String value)
        Sets the value of the customerCode property.
        Parameters:
        value - allowed object is String
        See Also:
        getCustomerCode()

      • isSetCustomerCode

        public boolean isSetCustomerCode()

      • getUserName

        public String getUserName()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p644063_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p831178_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">A free text that specifies the name of the user calling the web service. This attribute makes it possible to analyze the logs with regard to specific users, for example.
                     </p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p644063_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p831178_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         If the web service is called from the server's portal and a user is logged in, the user's name will be entered automatically.
                     </p>
        Returns:
        possible object is String

      • setUserName

        public void setUserName​(String value)
        Sets the value of the userName property.
        Parameters:
        value - allowed object is String
        See Also:
        getUserName()

      • isSetUserName

        public boolean isSetUserName()

      • getApplicationName

        public String getApplicationName()
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p644063_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p831178_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema">A free text that specifies the name of the application calling the web service. This attribute makes it possible to analyze the logs with regard to specific applications, for example.
 
                     </p>
 
         <?xml version="1.0" encoding="UTF-8"?><p xmlns:p644063_="urn:jaxb.jvnet.org:plugin:inheritance" xmlns:p831178_="https://jakarta.ee/xml/ns/jaxb" xmlns:tns="http://schema.webpdf.de/1.0/operation" xmlns:xs="http://www.w3.org/2001/XMLSchema"><b>Important:</b>
                         If the web service is called by an external application that does not set its own value for "applicationName", a value of "external" will be entered automatically. If the web service is called from the server's portal, a value of "portal" will be entered automatically.
                     </p>
        Returns:
        possible object is String

      • setApplicationName

        public void setApplicationName​(String value)
        Sets the value of the applicationName property.
        Parameters:
        value - allowed object is String
        See Also:
        getApplicationName()

      • isSetApplicationName

        public boolean isSetApplicationName()