Package net.webpdf.wsclient.openapi

Class OperationBilling

java.lang.Object

net.webpdf.wsclient.openapi.OperationBilling

public class OperationBilling
extends Object

The `billing` 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.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JSON_PROPERTY_APPLICATION_NAME
static String	JSON_PROPERTY_CUSTOMER_CODE
static String	JSON_PROPERTY_USER_NAME

Constructor Summary

Constructors

Constructor	Description
OperationBilling()

Method Summary

Modifier and Type	Method	Description
OperationBilling	applicationName(String applicationName)
OperationBilling	customerCode(String customerCode)
boolean	equals(Object o)
@Nullable String	getApplicationName()	A free text that specifies the name of the application calling the web service.
@Nullable String	getCustomerCode()	A free text that identifies the customer calling the web service.
@Nullable String	getUserName()	A free text that specifies the name of the user calling the web service.
int	hashCode()
void	setApplicationName(String applicationName)
void	setCustomerCode(String customerCode)
void	setUserName(String userName)
String	toString()
OperationBilling	userName(String userName)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

JSON_PROPERTY_APPLICATION_NAME

public static final String JSON_PROPERTY_APPLICATION_NAME

See Also:

Constant Field Values

JSON_PROPERTY_CUSTOMER_CODE

public static final String JSON_PROPERTY_CUSTOMER_CODE

See Also:

Constant Field Values

JSON_PROPERTY_USER_NAME

public static final String JSON_PROPERTY_USER_NAME

See Also:

Constant Field Values

Constructor Detail

OperationBilling

public OperationBilling()

Method Detail

applicationName

public OperationBilling applicationName(String applicationName)

getApplicationName

@Nullable
public @Nullable String getApplicationName()

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. **Important:** 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.

Returns:

applicationName

setApplicationName

public void setApplicationName(String applicationName)

customerCode

public OperationBilling customerCode(String customerCode)

getCustomerCode

@Nullable
public @Nullable String getCustomerCode()

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.

Returns:

customerCode

setCustomerCode

public void setCustomerCode(String customerCode)

userName

public OperationBilling userName(String userName)

getUserName

@Nullable
public @Nullable String getUserName()

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. **Important:** 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.

Returns:

userName

setUserName

public void setUserName(String userName)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object