io.cryptolens.methods

Class Data

java.lang.Object

io.cryptolens.methods.Data

public class Data
extends java.lang.Object

The following methods allow you to work with data objects (aka. metadata or custom variables) associated with a license key or a machine code (i.e. an activation). Data objects can be used to store specific properties (eg. username, OS version). More importantly though, they are used if you plan to implement a usage-based licensing model.

Access token remarks: When you create an access token for any of the methods below, we recommend to specify the product and to set the keylock to -1.

Remarks for machine code data objects: In order to work with data objects associated with a machine code, the machine code needs to be assigned to a license key. After deactivation, it will not be possible to retrieve the data objects using the methods below (it is, however, possible to retrieve them using the Web API).

Constructor Summary

Constructors

Constructor and Description
Data()

Method Summary

Modifier and Type	Method and Description
static BasicResult	AddDataObject(java.lang.String token, AddDataObjectToKeyModel model)
static BasicResult	AddDataObject(java.lang.String token, AddDataObjectToMachineCodeModel model)
static BasicResult	AddDataObject(java.lang.String token, LicenseKey license, java.lang.String name, int intValue, java.lang.String stringValue) Adds a new data object to a license key.
static BasicResult	AddDataObject(java.lang.String token, LicenseKey license, java.lang.String name, int intValue, java.lang.String stringValue, boolean checkForDuplicates) Adds a new data object to a license key.
static BasicResult	AddDataObject(java.lang.String token, LicenseKey license, java.lang.String machineCode, java.lang.String name, int intValue, java.lang.String stringValue) Adds a new data object to an existing activation (machine code).
static BasicResult	AddDataObject(java.lang.String token, LicenseKey license, java.lang.String machineCode, java.lang.String name, int intValue, java.lang.String stringValue, boolean checkForDuplicates) Adds a new data object to an existing activation (machine code).
static BasicResult	DecrementIntValue(java.lang.String token, DecrementIntValueToKeyModel model)
static BasicResult	DecrementIntValue(java.lang.String token, DecrementIntValueToMachineCodeModel model)
static BasicResult	DecrementIntValue(java.lang.String token, LicenseKey license, long id, int intValue) This method will decrement the integer value in a Data Object by a certain constant (non-negative).
static BasicResult	DecrementIntValue(java.lang.String token, LicenseKey license, long id, int intValue, boolean enableBound, int bound) This method will decrement the integer value in a Data Object by a certain constant (non-negative).
static BasicResult	DecrementIntValue(java.lang.String token, LicenseKey license, java.lang.String name, int intValue) This method will decrement the integer value in a Data Object by a certain constant (non-negative).
static BasicResult	DecrementIntValue(java.lang.String token, LicenseKey license, java.lang.String name, int intValue, boolean enableBound, int bound) This method will decrement the integer value in a Data Object by a certain constant (non-negative).
static BasicResult	DecrementIntValue(java.lang.String token, LicenseKey license, java.lang.String machineCode, long id, int intValue) This method will decrement the integer value in a Data Object by a certain constant (non-negative).
static BasicResult	DecrementIntValue(java.lang.String token, LicenseKey license, java.lang.String machineCode, long id, int intValue, boolean enableBound, int bound) This method will decrement the integer value in a Data Object by a certain constant (non-negative).
static BasicResult	DecrementIntValue(java.lang.String token, LicenseKey license, java.lang.String machineCode, java.lang.String name, int intValue) This method will decrement the integer value in a Data Object by a certain constant (non-negative).
static BasicResult	DecrementIntValue(java.lang.String token, LicenseKey license, java.lang.String machineCode, java.lang.String name, int intValue, boolean enableBound, int bound) This method will decrement the integer value in a Data Object by a certain constant (non-negative).
static BasicResult	IncrementIntValue(java.lang.String token, IncrementIntValueToKeyModel model)
static BasicResult	IncrementIntValue(java.lang.String token, IncrementIntValueToMachineCodeModel model)
static BasicResult	IncrementIntValue(java.lang.String token, LicenseKey license, long id, int intValue) This method will increment the integer value in a Data Object by a certain constant (non-negative).
static BasicResult	IncrementIntValue(java.lang.String token, LicenseKey license, long id, int intValue, boolean enableBound, int bound) This method will increment the integer value in a Data Object by a certain constant (non-negative).
static BasicResult	IncrementIntValue(java.lang.String token, LicenseKey license, java.lang.String name, int intValue) This method will increment the integer value in a Data Object by a certain constant (non-negative).
static BasicResult	IncrementIntValue(java.lang.String token, LicenseKey license, java.lang.String name, int intValue, boolean enableBound, int bound) This method will increment the integer value in a Data Object by a certain constant (non-negative).
static BasicResult	IncrementIntValue(java.lang.String token, LicenseKey license, java.lang.String machineCode, long id, int intValue) This method will increment the integer value in a Data Object by a certain constant (non-negative).
static BasicResult	IncrementIntValue(java.lang.String token, LicenseKey license, java.lang.String machineCode, long id, int intValue, boolean enableBound, int bound) This method will increment the integer value in a Data Object by a certain constant (non-negative).
static BasicResult	IncrementIntValue(java.lang.String token, LicenseKey license, java.lang.String machineCode, java.lang.String name, int intValue) This method will increment the integer value in a Data Object by a certain constant (non-negative).
static BasicResult	IncrementIntValue(java.lang.String token, LicenseKey license, java.lang.String machineCode, java.lang.String name, int intValue, boolean enableBound, int bound) This method will increment the integer value in a Data Object by a certain constant (non-negative).
static ListOfDataObjectsResult	ListDataObjects(java.lang.String token, LicenseKey license, java.lang.String contains) List data objects of a certain license.
static ListOfDataObjectsResult	ListDataObjects(java.lang.String token, LicenseKey license, java.lang.String machineCode, java.lang.String contains) List data objects of an existing activation (machine code).
static ListOfDataObjectsResult	ListDataObjects(java.lang.String token, ListDataObjectsToKeyModel model)
static ListOfDataObjectsResult	ListDataObjects(java.lang.String token, ListDataObjectsToMachineCodeModel model)
static BasicResult	RemoveDataObject(java.lang.String token, LicenseKey license, long id) This method will remove an existing Data Object.
static BasicResult	RemoveDataObject(java.lang.String token, LicenseKey license, java.lang.String name) This method will remove an existing Data Object.
static BasicResult	RemoveDataObject(java.lang.String token, LicenseKey license, java.lang.String machineCode, long id) This method will remove an existing Data Object.
static BasicResult	RemoveDataObject(java.lang.String token, LicenseKey license, java.lang.String machineCode, java.lang.String name) This method will remove an existing Data Object.
static BasicResult	RemoveDataObject(java.lang.String token, RemoveDataObjectToKeyModel model)
static BasicResult	RemoveDataObject(java.lang.String token, RemoveDataObjectToMachineCodeModel model)
static BasicResult	SetIntValue(java.lang.String token, LicenseKey license, long id, int intValue) This method will assign a new integer value to a Data Object.
static BasicResult	SetIntValue(java.lang.String token, LicenseKey license, java.lang.String name, int intValue) This method will assign a new integer value to a Data Object.
static BasicResult	SetIntValue(java.lang.String token, LicenseKey license, java.lang.String machineCode, long id, int intValue) This method will assign a new integer value to a Data Object.
static BasicResult	SetIntValue(java.lang.String token, LicenseKey license, java.lang.String machineCode, java.lang.String name, int intValue) This method will assign a new integer value to a Data Object.
static BasicResult	SetIntValue(java.lang.String token, SetIntValueToKeyModel model)
static BasicResult	SetIntValue(java.lang.String token, SetIntValueToMachineCodeModel model)
static BasicResult	SetStringValue(java.lang.String token, LicenseKey license, long id, java.lang.String stringValue) This method will assign a new string value to a Data Object.
static BasicResult	SetStringValue(java.lang.String token, LicenseKey license, java.lang.String machineCode, long id, java.lang.String stringValue) This method will assign a new string value to a Data Object.
static BasicResult	SetStringValue(java.lang.String token, LicenseKey license, java.lang.String name, java.lang.String stringValue) This method will assign a new string value to a Data Object.
static BasicResult	SetStringValue(java.lang.String token, LicenseKey license, java.lang.String machineCode, java.lang.String name, java.lang.String stringValue) This method will assign a new string value to a Data Object.
static BasicResult	SetStringValue(java.lang.String token, SetStringValueToKeyModel model)
static BasicResult	SetStringValue(java.lang.String token, SetStringValueToMachineCodeModel model)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Data

public Data()

Method Detail

AddDataObject

public static BasicResult AddDataObject(java.lang.String token,
                                        LicenseKey license,
                                        java.lang.String name,
                                        int intValue,
                                        java.lang.String stringValue)

Adds a new data object to a license key.

Parameters:

token - The access token with 'AddDataObject' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

name - The name of the data object. Max 10 characters.

intValue - An int value (int32) to store.

stringValue - A string value (text) to store. Max 10000 characters.

Returns:

AddDataObject

public static BasicResult AddDataObject(java.lang.String token,
                                        LicenseKey license,
                                        java.lang.String name,
                                        int intValue,
                                        java.lang.String stringValue,
                                        boolean checkForDuplicates)

Adds a new data object to a license key.

Parameters:

token - The access token with 'AddDataObject' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

name - The name of the data object. Max 10 characters.

intValue - An int value (int32) to store.

stringValue - A string value (text) to store. Max 10000 characters.

checkForDuplicates - If set to true, this method will check that no other data object with the same name exists. Note: setting this to true may affect performance.

Returns:

AddDataObject

public static BasicResult AddDataObject(java.lang.String token,
                                        LicenseKey license,
                                        java.lang.String machineCode,
                                        java.lang.String name,
                                        int intValue,
                                        java.lang.String stringValue)

Adds a new data object to an existing activation (machine code).

Parameters:

token - The access token with 'AddDataObject' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

machineCode - The machine code.

name - The name of the data object. Max 10 characters.

intValue - An int value (int32) to store.

stringValue - A string value (text) to store. Max 10000 characters.

Returns:

AddDataObject

public static BasicResult AddDataObject(java.lang.String token,
                                        LicenseKey license,
                                        java.lang.String machineCode,
                                        java.lang.String name,
                                        int intValue,
                                        java.lang.String stringValue,
                                        boolean checkForDuplicates)

Adds a new data object to an existing activation (machine code).

Parameters:

token - The access token with 'AddDataObject' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

machineCode - The machine code.

name - The name of the data object. Max 10 characters.

intValue - An int value (int32) to store.

stringValue - A string value (text) to store. Max 10000 characters.

checkForDuplicates - If set to true, this method will check that no other data object with the same name exists. Note: setting this to true may affect performance.

Returns:

AddDataObject

public static BasicResult AddDataObject(java.lang.String token,
                                        AddDataObjectToKeyModel model)

AddDataObject

public static BasicResult AddDataObject(java.lang.String token,
                                        AddDataObjectToMachineCodeModel model)

ListDataObjects

public static ListOfDataObjectsResult ListDataObjects(java.lang.String token,
                                                      LicenseKey license,
                                                      java.lang.String contains)

List data objects of a certain license.

Parameters:

token - The access token with 'ListDataObjects' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

contains - Shows only Data Objects where the name contains the following string.

Returns:

ListDataObjects

public static ListOfDataObjectsResult ListDataObjects(java.lang.String token,
                                                      LicenseKey license,
                                                      java.lang.String machineCode,
                                                      java.lang.String contains)

List data objects of an existing activation (machine code).

Parameters:

token - The access token with 'ListDataObjects' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

machineCode - The machine code.

contains - Shows only Data Objects where the name contains the following string.

Returns:

ListDataObjects

public static ListOfDataObjectsResult ListDataObjects(java.lang.String token,
                                                      ListDataObjectsToKeyModel model)

ListDataObjects

public static ListOfDataObjectsResult ListDataObjects(java.lang.String token,
                                                      ListDataObjectsToMachineCodeModel model)

SetIntValue

public static BasicResult SetIntValue(java.lang.String token,
                                      LicenseKey license,
                                      long id,
                                      int intValue)

This method will assign a new integer value to a Data Object.

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

id - The unique object id for the data object.

intValue - The new int value that should be assigned to the data object.

Returns:

SetIntValue

public static BasicResult SetIntValue(java.lang.String token,
                                      LicenseKey license,
                                      java.lang.String name,
                                      int intValue)

This method will assign a new integer value to a Data Object.

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

name - The name of the data object.

intValue - The new int value that should be assigned to the data object.

Returns:

SetIntValue

public static BasicResult SetIntValue(java.lang.String token,
                                      LicenseKey license,
                                      java.lang.String machineCode,
                                      long id,
                                      int intValue)

This method will assign a new integer value to a Data Object.

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

machineCode - The machine code.

id - The unique object id for the data object.

intValue - The new int value that should be assigned to the data object.

Returns:

SetIntValue

public static BasicResult SetIntValue(java.lang.String token,
                                      LicenseKey license,
                                      java.lang.String machineCode,
                                      java.lang.String name,
                                      int intValue)

This method will assign a new integer value to a Data Object.

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

machineCode - The machine code.

name - The name of the data object.

intValue - The new int value that should be assigned to the data object.

Returns:

SetIntValue

public static BasicResult SetIntValue(java.lang.String token,
                                      SetIntValueToKeyModel model)

SetIntValue

public static BasicResult SetIntValue(java.lang.String token,
                                      SetIntValueToMachineCodeModel model)

IncrementIntValue

public static BasicResult IncrementIntValue(java.lang.String token,
                                            LicenseKey license,
                                            long id,
                                            int intValue)

This method will increment the integer value in a Data Object by a certain constant (non-negative). You can always decrement it. Note, this method does not allow integer overflows, i.e. if you increment by a constant that would result in an overflow, an error will be thrown. Note also that you can use the Feature lock in the Access Token to specify the upper bound of the increment constant. So, if you only want to allow incrementing by 1, please set Feature lock field to 1 also. Please see Remarks for more details (including access token set up).

Parameters:

token - The access token with 'IncrementIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

id - The unique object id for the data object.

intValue - The constant int (non-negative) value that should be added to the current IntValue of the data object. For example, if this value is set to 5 and the old IntValue is 1, then the new IntValue will be the old one plus 5, i.e. 6. Note, if you would set this value to -5 instead, the same result would be achieved.

Returns:

IncrementIntValue

public static BasicResult IncrementIntValue(java.lang.String token,
                                            LicenseKey license,
                                            java.lang.String name,
                                            int intValue)

This method will increment the integer value in a Data Object by a certain constant (non-negative). You can always decrement it. Note, this method does not allow integer overflows, i.e. if you increment by a constant that would result in an overflow, an error will be thrown. Note also that you can use the Feature lock in the Access Token to specify the upper bound of the increment constant. So, if you only want to allow incrementing by 1, please set Feature lock field to 1 also. Please see Remarks for more details (including access token set up).

Parameters:

token - The access token with 'IncrementIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

name - The name of the data object.

intValue - The constant int (non-negative) value that should be added to the current IntValue of the data object. For example, if this value is set to 5 and the old IntValue is 1, then the new IntValue will be the old one plus 5, i.e. 6. Note, if you would set this value to -5 instead, the same result would be achieved.

Returns:

IncrementIntValue

public static BasicResult IncrementIntValue(java.lang.String token,
                                            LicenseKey license,
                                            java.lang.String machineCode,
                                            long id,
                                            int intValue)

This method will increment the integer value in a Data Object by a certain constant (non-negative). You can always decrement it. Note, this method does not allow integer overflows, i.e. if you increment by a constant that would result in an overflow, an error will be thrown. Note also that you can use the Feature lock in the Access Token to specify the upper bound of the increment constant. So, if you only want to allow incrementing by 1, please set Feature lock field to 1 also. Please see Remarks for more details (including access token set up).

Parameters:

token - The access token with 'IncrementIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

machineCode - The machine code.

id - The unique object id for the data object.

intValue - The constant int (non-negative) value that should be added to the current IntValue of the data object. For example, if this value is set to 5 and the old IntValue is 1, then the new IntValue will be the old one plus 5, i.e. 6. Note, if you would set this value to -5 instead, the same result would be achieved.

Returns:

IncrementIntValue

public static BasicResult IncrementIntValue(java.lang.String token,
                                            LicenseKey license,
                                            java.lang.String machineCode,
                                            java.lang.String name,
                                            int intValue)

This method will increment the integer value in a Data Object by a certain constant (non-negative). You can always decrement it. Note, this method does not allow integer overflows, i.e. if you increment by a constant that would result in an overflow, an error will be thrown. Note also that you can use the Feature lock in the Access Token to specify the upper bound of the increment constant. So, if you only want to allow incrementing by 1, please set Feature lock field to 1 also. Please see Remarks for more details (including access token set up).

Parameters:

token - The access token with 'IncrementIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

machineCode - The machine code.

name - The name of the data object.

intValue - The constant int (non-negative) value that should be added to the current IntValue of the data object. For example, if this value is set to 5 and the old IntValue is 1, then the new IntValue will be the old one plus 5, i.e. 6. Note, if you would set this value to -5 instead, the same result would be achieved.

Returns:

IncrementIntValue

public static BasicResult IncrementIntValue(java.lang.String token,
                                            LicenseKey license,
                                            long id,
                                            int intValue,
                                            boolean enableBound,
                                            int bound)

This method will increment the integer value in a Data Object by a certain constant (non-negative). You can always decrement it. Note, this method does not allow integer overflows, i.e. if you increment by a constant that would result in an overflow, an error will be thrown. Note also that you can use the Feature lock in the Access Token to specify the upper bound of the increment constant. So, if you only want to allow incrementing by 1, please set Feature lock field to 1 also. Please see Remarks for more details (including access token set up).

Parameters:

token - The access token with 'IncrementIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

id - The unique object id for the data object.

intValue - The constant int (non-negative) value that should be added to the current IntValue of the data object. For example, if this value is set to 5 and the old IntValue is 1, then the new IntValue will be the old one plus 5, i.e. 6. Note, if you would set this value to -5 instead, the same result would be achieved.

enableBound - If set to true, it will be possible to specify an upper bound. For example, if you set the Bound parameter (below) to 10, you will be able to increment the int value until you reach ten (inclusive). Once the upper bound is reached, an error will be thrown.

bound - This is the upper bound that will be enforced on the increment operation. It will only be enforced if EnableBound is set to true. Please read the description about enableBound.

Returns:

IncrementIntValue

public static BasicResult IncrementIntValue(java.lang.String token,
                                            LicenseKey license,
                                            java.lang.String name,
                                            int intValue,
                                            boolean enableBound,
                                            int bound)

This method will increment the integer value in a Data Object by a certain constant (non-negative). You can always decrement it. Note, this method does not allow integer overflows, i.e. if you increment by a constant that would result in an overflow, an error will be thrown. Note also that you can use the Feature lock in the Access Token to specify the upper bound of the increment constant. So, if you only want to allow incrementing by 1, please set Feature lock field to 1 also. Please see Remarks for more details (including access token set up).

Parameters:

token - The access token with 'IncrementIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

name - The name of the data object.

intValue - The constant int (non-negative) value that should be added to the current IntValue of the data object. For example, if this value is set to 5 and the old IntValue is 1, then the new IntValue will be the old one plus 5, i.e. 6. Note, if you would set this value to -5 instead, the same result would be achieved.

enableBound - If set to true, it will be possible to specify an upper bound. For example, if you set the Bound parameter (below) to 10, you will be able to increment the int value until you reach ten (inclusive). Once the upper bound is reached, an error will be thrown.

bound - This is the upper bound that will be enforced on the increment operation. It will only be enforced if EnableBound is set to true. Please read the description about enableBound.

Returns:

IncrementIntValue

public static BasicResult IncrementIntValue(java.lang.String token,
                                            LicenseKey license,
                                            java.lang.String machineCode,
                                            long id,
                                            int intValue,
                                            boolean enableBound,
                                            int bound)

This method will increment the integer value in a Data Object by a certain constant (non-negative). You can always decrement it. Note, this method does not allow integer overflows, i.e. if you increment by a constant that would result in an overflow, an error will be thrown. Note also that you can use the Feature lock in the Access Token to specify the upper bound of the increment constant. So, if you only want to allow incrementing by 1, please set Feature lock field to 1 also. Please see Remarks for more details (including access token set up).

Parameters:

token - The access token with 'IncrementIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

machineCode - The machine code.

id - The unique object id for the data object.

intValue - The constant int (non-negative) value that should be added to the current IntValue of the data object. For example, if this value is set to 5 and the old IntValue is 1, then the new IntValue will be the old one plus 5, i.e. 6. Note, if you would set this value to -5 instead, the same result would be achieved.

enableBound - If set to true, it will be possible to specify an upper bound. For example, if you set the Bound parameter (below) to 10, you will be able to increment the int value until you reach ten (inclusive). Once the upper bound is reached, an error will be thrown.

bound - This is the upper bound that will be enforced on the increment operation. It will only be enforced if EnableBound is set to true. Please read the description about enableBound.

Returns:

IncrementIntValue

public static BasicResult IncrementIntValue(java.lang.String token,
                                            LicenseKey license,
                                            java.lang.String machineCode,
                                            java.lang.String name,
                                            int intValue,
                                            boolean enableBound,
                                            int bound)

This method will increment the integer value in a Data Object by a certain constant (non-negative). You can always decrement it. Note, this method does not allow integer overflows, i.e. if you increment by a constant that would result in an overflow, an error will be thrown. Note also that you can use the Feature lock in the Access Token to specify the upper bound of the increment constant. So, if you only want to allow incrementing by 1, please set Feature lock field to 1 also. Please see Remarks for more details (including access token set up).

Parameters:

token - The access token with 'IncrementIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

machineCode - The machine code.

name - The name of the data object.

intValue - The constant int (non-negative) value that should be added to the current IntValue of the data object. For example, if this value is set to 5 and the old IntValue is 1, then the new IntValue will be the old one plus 5, i.e. 6. Note, if you would set this value to -5 instead, the same result would be achieved.

enableBound - If set to true, it will be possible to specify an upper bound. For example, if you set the Bound parameter (below) to 10, you will be able to increment the int value until you reach ten (inclusive). Once the upper bound is reached, an error will be thrown.

bound - This is the upper bound that will be enforced on the increment operation. It will only be enforced if EnableBound is set to true. Please read the description about enableBound.

Returns:

IncrementIntValue

public static BasicResult IncrementIntValue(java.lang.String token,
                                            IncrementIntValueToKeyModel model)

IncrementIntValue

public static BasicResult IncrementIntValue(java.lang.String token,
                                            IncrementIntValueToMachineCodeModel model)

DecrementIntValue

public static BasicResult DecrementIntValue(java.lang.String token,
                                            LicenseKey license,
                                            long id,
                                            int intValue)

This method will decrement the integer value in a Data Object by a certain constant (non-negative). You can always increment it. Note, this method does not allow integer overflows, i.e. if you decrement by a constant that would result in an overflow, an error will be thrown. Note also that you can use the Feature lock in the Access Token to specify the upper bound of the decrement constant. So, if you only want to allow decrementing by 1, please set Feature lock field to 1 also. Please see Remarks for more details (including access token setup).

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

id - The unique object id for the data object.

intValue - The constant int value that should be subtracted to the current IntValue of the data object. For example, if this value is set to 5 and the old IntValue is 11, then the new IntValue will be the old one minus 5, i.e. 6. Note, if you would set this value to -5 instead, the same result would be achieved.

Returns:

DecrementIntValue

public static BasicResult DecrementIntValue(java.lang.String token,
                                            LicenseKey license,
                                            java.lang.String name,
                                            int intValue)

This method will decrement the integer value in a Data Object by a certain constant (non-negative). You can always increment it. Note, this method does not allow integer overflows, i.e. if you decrement by a constant that would result in an overflow, an error will be thrown. Note also that you can use the Feature lock in the Access Token to specify the upper bound of the decrement constant. So, if you only want to allow decrementing by 1, please set Feature lock field to 1 also. Please see Remarks for more details (including access token setup).

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

name - The name of the data object.

intValue - The constant int value that should be subtracted to the current IntValue of the data object. For example, if this value is set to 5 and the old IntValue is 11, then the new IntValue will be the old one minus 5, i.e. 6. Note, if you would set this value to -5 instead, the same result would be achieved.

Returns:

DecrementIntValue

public static BasicResult DecrementIntValue(java.lang.String token,
                                            LicenseKey license,
                                            java.lang.String machineCode,
                                            long id,
                                            int intValue)

This method will decrement the integer value in a Data Object by a certain constant (non-negative). You can always increment it. Note, this method does not allow integer overflows, i.e. if you decrement by a constant that would result in an overflow, an error will be thrown. Note also that you can use the Feature lock in the Access Token to specify the upper bound of the decrement constant. So, if you only want to allow decrementing by 1, please set Feature lock field to 1 also. Please see Remarks for more details (including access token setup).

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

machineCode - The machine code.

id - The unique object id for the data object.

intValue - The constant int value that should be subtracted to the current IntValue of the data object. For example, if this value is set to 5 and the old IntValue is 11, then the new IntValue will be the old one minus 5, i.e. 6. Note, if you would set this value to -5 instead, the same result would be achieved.

Returns:

DecrementIntValue

public static BasicResult DecrementIntValue(java.lang.String token,
                                            LicenseKey license,
                                            java.lang.String machineCode,
                                            java.lang.String name,
                                            int intValue)

This method will decrement the integer value in a Data Object by a certain constant (non-negative). You can always increment it. Note, this method does not allow integer overflows, i.e. if you decrement by a constant that would result in an overflow, an error will be thrown. Note also that you can use the Feature lock in the Access Token to specify the upper bound of the decrement constant. So, if you only want to allow decrementing by 1, please set Feature lock field to 1 also. Please see Remarks for more details (including access token setup).

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

machineCode - The machine code.

name - The name of the data object.

intValue - The constant int value that should be subtracted to the current IntValue of the data object. For example, if this value is set to 5 and the old IntValue is 11, then the new IntValue will be the old one minus 5, i.e. 6. Note, if you would set this value to -5 instead, the same result would be achieved.

Returns:

DecrementIntValue

public static BasicResult DecrementIntValue(java.lang.String token,
                                            LicenseKey license,
                                            long id,
                                            int intValue,
                                            boolean enableBound,
                                            int bound)

This method will decrement the integer value in a Data Object by a certain constant (non-negative). You can always increment it. Note, this method does not allow integer overflows, i.e. if you decrement by a constant that would result in an overflow, an error will be thrown. Note also that you can use the Feature lock in the Access Token to specify the upper bound of the decrement constant. So, if you only want to allow decrementing by 1, please set Feature lock field to 1 also. Please see Remarks for more details (including access token setup).

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

id - The unique object id for the data object.

intValue - The constant int value that should be subtracted to the current IntValue of the data object. For example, if this value is set to 5 and the old IntValue is 11, then the new IntValue will be the old one minus 5, i.e. 6. Note, if you would set this value to -5 instead, the same result would be achieved.

enableBound - If set to true, it will be possible to specify a lower bound. For example, if you set the Bound parameter (below) to 0, you will be able to decrement the int value until you reach zero (inclusive). Once the lower bound is reached, an error will be thrown.

bound - This is the lower bound that will be enforced on the decrement operation. It will only be enforced if EnableBound is set to true. Please read the description above.

Returns:

DecrementIntValue

public static BasicResult DecrementIntValue(java.lang.String token,
                                            LicenseKey license,
                                            java.lang.String name,
                                            int intValue,
                                            boolean enableBound,
                                            int bound)

This method will decrement the integer value in a Data Object by a certain constant (non-negative). You can always increment it. Note, this method does not allow integer overflows, i.e. if you decrement by a constant that would result in an overflow, an error will be thrown. Note also that you can use the Feature lock in the Access Token to specify the upper bound of the decrement constant. So, if you only want to allow decrementing by 1, please set Feature lock field to 1 also. Please see Remarks for more details (including access token setup).

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

name - The name of the data object.

intValue - The constant int value that should be subtracted to the current IntValue of the data object. For example, if this value is set to 5 and the old IntValue is 11, then the new IntValue will be the old one minus 5, i.e. 6. Note, if you would set this value to -5 instead, the same result would be achieved.

enableBound - If set to true, it will be possible to specify a lower bound. For example, if you set the Bound parameter (below) to 0, you will be able to decrement the int value until you reach zero (inclusive). Once the lower bound is reached, an error will be thrown.

bound - This is the lower bound that will be enforced on the decrement operation. It will only be enforced if EnableBound is set to true. Please read the description above.

Returns:

DecrementIntValue

public static BasicResult DecrementIntValue(java.lang.String token,
                                            LicenseKey license,
                                            java.lang.String machineCode,
                                            long id,
                                            int intValue,
                                            boolean enableBound,
                                            int bound)

This method will decrement the integer value in a Data Object by a certain constant (non-negative). You can always increment it. Note, this method does not allow integer overflows, i.e. if you decrement by a constant that would result in an overflow, an error will be thrown. Note also that you can use the Feature lock in the Access Token to specify the upper bound of the decrement constant. So, if you only want to allow decrementing by 1, please set Feature lock field to 1 also. Please see Remarks for more details (including access token setup).

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

machineCode - The machine code.

id - The unique object id for the data object.

intValue - The constant int value that should be subtracted to the current IntValue of the data object. For example, if this value is set to 5 and the old IntValue is 11, then the new IntValue will be the old one minus 5, i.e. 6. Note, if you would set this value to -5 instead, the same result would be achieved.

enableBound - If set to true, it will be possible to specify a lower bound. For example, if you set the Bound parameter (below) to 0, you will be able to decrement the int value until you reach zero (inclusive). Once the lower bound is reached, an error will be thrown.

bound - This is the lower bound that will be enforced on the decrement operation. It will only be enforced if EnableBound is set to true. Please read the description above.

Returns:

DecrementIntValue

public static BasicResult DecrementIntValue(java.lang.String token,
                                            LicenseKey license,
                                            java.lang.String machineCode,
                                            java.lang.String name,
                                            int intValue,
                                            boolean enableBound,
                                            int bound)

This method will decrement the integer value in a Data Object by a certain constant (non-negative). You can always increment it. Note, this method does not allow integer overflows, i.e. if you decrement by a constant that would result in an overflow, an error will be thrown. Note also that you can use the Feature lock in the Access Token to specify the upper bound of the decrement constant. So, if you only want to allow decrementing by 1, please set Feature lock field to 1 also. Please see Remarks for more details (including access token setup).

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

machineCode - The machine code.

name - The name of the data object.

intValue - The constant int value that should be subtracted to the current IntValue of the data object. For example, if this value is set to 5 and the old IntValue is 11, then the new IntValue will be the old one minus 5, i.e. 6. Note, if you would set this value to -5 instead, the same result would be achieved.

enableBound - If set to true, it will be possible to specify a lower bound. For example, if you set the Bound parameter (below) to 0, you will be able to decrement the int value until you reach zero (inclusive). Once the lower bound is reached, an error will be thrown.

bound - This is the lower bound that will be enforced on the decrement operation. It will only be enforced if EnableBound is set to true. Please read the description above.

Returns:

DecrementIntValue

public static BasicResult DecrementIntValue(java.lang.String token,
                                            DecrementIntValueToKeyModel model)

DecrementIntValue

public static BasicResult DecrementIntValue(java.lang.String token,
                                            DecrementIntValueToMachineCodeModel model)

SetStringValue

public static BasicResult SetStringValue(java.lang.String token,
                                         LicenseKey license,
                                         long id,
                                         java.lang.String stringValue)

This method will assign a new string value to a Data Object.

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

id - The unique object id for the data object.

stringValue - A string value (text) to store. Max 10000 characters.

Returns:

SetStringValue

public static BasicResult SetStringValue(java.lang.String token,
                                         LicenseKey license,
                                         java.lang.String name,
                                         java.lang.String stringValue)

This method will assign a new string value to a Data Object.

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

name - The name of the data object.

stringValue - A string value (text) to store. Max 10000 characters.

Returns:

SetStringValue

public static BasicResult SetStringValue(java.lang.String token,
                                         LicenseKey license,
                                         java.lang.String machineCode,
                                         long id,
                                         java.lang.String stringValue)

This method will assign a new string value to a Data Object.

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

machineCode - The machine code.

id - The unique object id for the data object.

stringValue - A string value (text) to store. Max 10000 characters.

Returns:

SetStringValue

public static BasicResult SetStringValue(java.lang.String token,
                                         LicenseKey license,
                                         java.lang.String machineCode,
                                         java.lang.String name,
                                         java.lang.String stringValue)

This method will assign a new string value to a Data Object.

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

machineCode - The machine code.

name - The name of the data object.

stringValue - A string value (text) to store. Max 10000 characters.

Returns:

SetStringValue

public static BasicResult SetStringValue(java.lang.String token,
                                         SetStringValueToKeyModel model)

SetStringValue

public static BasicResult SetStringValue(java.lang.String token,
                                         SetStringValueToMachineCodeModel model)

RemoveDataObject

public static BasicResult RemoveDataObject(java.lang.String token,
                                           LicenseKey license,
                                           long id)

This method will remove an existing Data Object.

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

id - The unique object id for the data object.

Returns:

RemoveDataObject

public static BasicResult RemoveDataObject(java.lang.String token,
                                           LicenseKey license,
                                           java.lang.String name)

This method will remove an existing Data Object.

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

name - The name of the data object.

Returns:

RemoveDataObject

public static BasicResult RemoveDataObject(java.lang.String token,
                                           LicenseKey license,
                                           java.lang.String machineCode,
                                           long id)

This method will remove an existing Data Object.

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

machineCode - The machine code.

id - The unique object id for the data object.

Returns:

RemoveDataObject

public static BasicResult RemoveDataObject(java.lang.String token,
                                           LicenseKey license,
                                           java.lang.String machineCode,
                                           java.lang.String name)

This method will remove an existing Data Object.

Parameters:

token - The access token with 'SetIntValue' permission and KeyLock set to '-1'.

license - The license key object (it's used to get the product id and key string).

machineCode - The machine code.

name - The name of the data object.

Returns:

RemoveDataObject

public static BasicResult RemoveDataObject(java.lang.String token,
                                           RemoveDataObjectToKeyModel model)

RemoveDataObject

public static BasicResult RemoveDataObject(java.lang.String token,
                                           RemoveDataObjectToMachineCodeModel model)