setLMVariable

Sets a variable value for a given licensee, customer, and product combination.

Which level of value is set depends on the input parameters. Specifying only licensee will set a licensee-level default. Specifying only licensee and product will set a licensee/product-level default. Specifying only licensee and customer will set a customer-level value. Specifying licensee, customer and product will set a customer/product-level value.

Parameters:

Field
Type
Required Description
sessionid String yes The sessionid returned by loginLMLicensee()
licensee String yes The company code (not the company name) for the Licensee.
customer String no The company code (not the company name) for the Customer.
product String no The product code (not the product name) for the product.
value VarValueInfo yes The variable and value(s) to set.

VarValueInfo

Field
Type
Description
name String The name of the variable to set.
value String The value to set, if this is a non-list variable.
valueList Array of String The values to set, if this is a list variable.


Return values: A VariableReturn structure:

Field
Type
Description
fault FaultData If an error has occurred on the server, this will contain information about the error. This field will be null if no error occurred.
valueSet VariableValue The value that was set, echoed back.

VariableValue

Field
Type
Description
isList Boolean Whether this is a list variable.
name String The name of the variable.
value String The variable value, if this is a non-list variable.
valueList Array of String The variable values, if this is a list variable.


Example:

NitroAdminAccessServiceLocator service = new NitroAdminAccessServiceLocator();
NitroAdminAccess server = service.getNitroAdminAccess();
VariableReturn ret = server.setLMVariable(sessionid, "smith", "testcust", "myProduct",
                new VarValueInfo("SAN_LEMUR", "test value", null));
if (ret.getFault()!=null) {
	System.err.println("Error: " + ret.getFault().getFaultString());
	return;
}
Comments