Impact Acquire SDK Java
TPROPHANDLING_ERROR Class Reference

Error codes of the module handling everything related to properties. More...

Static Public Attributes

static final int PROPHANDLING_ACCESSTOKEN_CREATION_FAILED = acquireJNI.PROPHANDLING_ACCESSTOKEN_CREATION_FAILED_get()
 An access token object couldn't be created.
 
static final int PROPHANDLING_CANT_ALLOCATE_LIST = acquireJNI.PROPHANDLING_CANT_ALLOCATE_LIST_get()
 This error will occur when the modules internal representation of the tree structure does not allow the allocation of a new list.
 
static final int PROPHANDLING_CANT_REGISTER_COMPONENT = acquireJNI.PROPHANDLING_CANT_REGISTER_COMPONENT_get()
 The referenced list has no space left to register this component at the desired position.
 
static final int PROPHANDLING_CANT_SERIALIZE_DATA = acquireJNI.PROPHANDLING_CANT_SERIALIZE_DATA_get()
 The user tried to save(serialize) a property list without having the right to do this.
 
static final int PROPHANDLING_COMPONENT_ALREADY_REGISTERED = acquireJNI.PROPHANDLING_COMPONENT_ALREADY_REGISTERED_get()
 It has been tried to register the same component at twice in the same list.
 
static final int PROPHANDLING_COMPONENT_HAS_OWNER_ALREADY = acquireJNI.PROPHANDLING_COMPONENT_HAS_OWNER_ALREADY_get()
 The specified component already has an owner.
 
static final int PROPHANDLING_COMPONENT_ID_INVALID = acquireJNI.PROPHANDLING_COMPONENT_ID_INVALID_get()
 An invalid component within a list has been referenced.
 
static final int PROPHANDLING_COMPONENT_NO_CALLBACK_REGISTERED = acquireJNI.PROPHANDLING_COMPONENT_NO_CALLBACK_REGISTERED_get()
 The user tried to modify a registered callback, but no callback has been registered for this component.
 
static final int PROPHANDLING_COMPONENT_NOT_FOUND = acquireJNI.PROPHANDLING_COMPONENT_NOT_FOUND_get()
 The specified component could not be found.
 
static final int PROPHANDLING_IMPLEMENTATION_MISSING = acquireJNI.PROPHANDLING_IMPLEMENTATION_MISSING_get()
 A feature that is not implemented so far has been requested.
 
static final int PROPHANDLING_INCOMPATIBLE_COMPONENTS = acquireJNI.PROPHANDLING_INCOMPATIBLE_COMPONENTS_get()
 The two involved components are not compatible.
 
static final int PROPHANDLING_INPUT_BUFFER_TOO_SMALL = acquireJNI.PROPHANDLING_INPUT_BUFFER_TOO_SMALL_get()
 The user tried to read data into a user supplied storage location, but the buffer was too small to accommodate the result.
 
static final int PROPHANDLING_INVALID_FILE_CONTENT = acquireJNI.PROPHANDLING_INVALID_FILE_CONTENT_get()
 The user tried to use a file to update or create a component list, that does not contain valid data for this operation.
 
static final int PROPHANDLING_INVALID_INPUT_PARAMETER = acquireJNI.PROPHANDLING_INVALID_INPUT_PARAMETER_get()
 A invalid input parameter has been passed to a function of this module.
 
static final int PROPHANDLING_INVALID_PROP_VALUE = acquireJNI.PROPHANDLING_INVALID_PROP_VALUE_get()
 It has been tried to assign an invalid value to a property.
 
static final int PROPHANDLING_INVALID_PROP_VALUE_TYPE = acquireJNI.PROPHANDLING_INVALID_PROP_VALUE_TYPE_get()
 An invalid value has been passed to the property.
 
static final int PROPHANDLING_LAST_VALID_ERROR_CODE = acquireJNI.PROPHANDLING_LAST_VALID_ERROR_CODE_get()
 Defines the last valid error code value for the property module.
 
static final int PROPHANDLING_LIST_CANT_ACCESS_DATA = acquireJNI.PROPHANDLING_LIST_CANT_ACCESS_DATA_get()
 The desired data can't be accessed or found.
 
static final int PROPHANDLING_LIST_ENTRY_OCCUPIED = acquireJNI.PROPHANDLING_LIST_ENTRY_OCCUPIED_get()
 The specified list index is occupied.
 
static final int PROPHANDLING_LIST_ID_INVALID = acquireJNI.PROPHANDLING_LIST_ID_INVALID_get()
 An invalid list has been referenced.
 
static final int PROPHANDLING_METHOD_INVALID_PARAM_LIST = acquireJNI.PROPHANDLING_METHOD_INVALID_PARAM_LIST_get()
 A method object has an invalid parameter list.
 
static final int PROPHANDLING_METHOD_PTR_INVALID = acquireJNI.PROPHANDLING_METHOD_PTR_INVALID_get()
 The function pointer of the referenced method object is invalid.
 
static final int PROPHANDLING_NO_ERROR = acquireJNI.PROPHANDLING_NO_ERROR_get()
 The operation has been executed successfully.
 
static final int PROPHANDLING_NO_MODIFY_SIZE_RIGHTS = acquireJNI.PROPHANDLING_NO_MODIFY_SIZE_RIGHTS_get()
 The caller can't modify the size of this component.
 
static final int PROPHANDLING_NO_READ_RIGHTS = acquireJNI.PROPHANDLING_NO_READ_RIGHTS_get()
 The caller has no read rights for this component.
 
static final int PROPHANDLING_NO_WRITE_RIGHTS = acquireJNI.PROPHANDLING_NO_WRITE_RIGHTS_get()
 The caller has no write rights for this component.
 
static final int PROPHANDLING_NOT_A_LIST = acquireJNI.PROPHANDLING_NOT_A_LIST_get()
 This component is not a list.
 
static final int PROPHANDLING_NOT_A_METHOD = acquireJNI.PROPHANDLING_NOT_A_METHOD_get()
 This component is not a method.
 
static final int PROPHANDLING_NOT_A_PROPERTY = acquireJNI.PROPHANDLING_NOT_A_PROPERTY_get()
 This component is not a property.
 
static final int PROPHANDLING_PROP_TRANSLATION_TABLE_CORRUPTED = acquireJNI.PROPHANDLING_PROP_TRANSLATION_TABLE_CORRUPTED_get()
 The properties translation table has been corrupted.
 
static final int PROPHANDLING_PROP_TRANSLATION_TABLE_NOT_DEFINED = acquireJNI.PROPHANDLING_PROP_TRANSLATION_TABLE_NOT_DEFINED_get()
 This property doesn't define a translation table.
 
static final int PROPHANDLING_PROP_VAL_ID_OUT_OF_BOUNDS = acquireJNI.PROPHANDLING_PROP_VAL_ID_OUT_OF_BOUNDS_get()
 Invalid value index.
 
static final int PROPHANDLING_PROP_VAL_TOO_LARGE = acquireJNI.PROPHANDLING_PROP_VAL_TOO_LARGE_get()
 A too large value has been passed.
 
static final int PROPHANDLING_PROP_VAL_TOO_SMALL = acquireJNI.PROPHANDLING_PROP_VAL_TOO_SMALL_get()
 A too small value has been passed.
 
static final int PROPHANDLING_PROP_VALIDATION_FAILED = acquireJNI.PROPHANDLING_PROP_VALIDATION_FAILED_get()
 The user tried to assign a value to a property, that is invalid.
 
static final int PROPHANDLING_SIZE_MISMATCH = acquireJNI.PROPHANDLING_SIZE_MISMATCH_get()
 Different sized value buffers have been passed.
 
static final int PROPHANDLING_SWIG_ERROR = acquireJNI.PROPHANDLING_SWIG_ERROR_get()
 This indicates an internal error occurred within the SWIG generated wrapper code, when working under Python.
 
static final int PROPHANDLING_UNSUPPORTED_OPERATION = acquireJNI.PROPHANDLING_UNSUPPORTED_OPERATION_get()
 The user tried to execute an operation, which is not supported by the component he is referring to.
 
static final int PROPHANDLING_UNSUPPORTED_PARAMETER = acquireJNI.PROPHANDLING_UNSUPPORTED_PARAMETER_get()
 One or more of the specified parameters are not supported by the function.
 
static final int PROPHANDLING_WRONG_PARAM_COUNT = acquireJNI.PROPHANDLING_WRONG_PARAM_COUNT_get()
 The number of parameters is incorrect.
 

Detailed Description

Error codes of the module handling everything related to properties.

Member Data Documentation

◆ PROPHANDLING_ACCESSTOKEN_CREATION_FAILED

final int PROPHANDLING_ACCESSTOKEN_CREATION_FAILED = acquireJNI.PROPHANDLING_ACCESSTOKEN_CREATION_FAILED_get()
static

An access token object couldn't be created.

This can either happen, because the caller has not the rights required to create an access token or because the system runs very low on memory.
Deprecated: This error code currently is not used anywhere within this framework. It might be removed in a future version.

◆ PROPHANDLING_CANT_ALLOCATE_LIST

final int PROPHANDLING_CANT_ALLOCATE_LIST = acquireJNI.PROPHANDLING_CANT_ALLOCATE_LIST_get()
static

This error will occur when the modules internal representation of the tree structure does not allow the allocation of a new list.

In this case either new list can't be allocated. The only way to solve this problem is to delete another list.

◆ PROPHANDLING_CANT_REGISTER_COMPONENT

final int PROPHANDLING_CANT_REGISTER_COMPONENT = acquireJNI.PROPHANDLING_CANT_REGISTER_COMPONENT_get()
static

The referenced list has no space left to register this component at the desired position.

There might however be an empty space within the list where this element could be registered, but no more components can be registered at the end of this list.

◆ PROPHANDLING_CANT_SERIALIZE_DATA

final int PROPHANDLING_CANT_SERIALIZE_DATA = acquireJNI.PROPHANDLING_CANT_SERIALIZE_DATA_get()
static

The user tried to save(serialize) a property list without having the right to do this.

◆ PROPHANDLING_COMPONENT_ALREADY_REGISTERED

final int PROPHANDLING_COMPONENT_ALREADY_REGISTERED = acquireJNI.PROPHANDLING_COMPONENT_ALREADY_REGISTERED_get()
static

It has been tried to register the same component at twice in the same list.

◆ PROPHANDLING_COMPONENT_HAS_OWNER_ALREADY

final int PROPHANDLING_COMPONENT_HAS_OWNER_ALREADY = acquireJNI.PROPHANDLING_COMPONENT_HAS_OWNER_ALREADY_get()
static

The specified component already has an owner.

The caller tried to assign an owner to a component that already has an owner. An owner once defined can't be modified anymore.

◆ PROPHANDLING_COMPONENT_ID_INVALID

final int PROPHANDLING_COMPONENT_ID_INVALID = acquireJNI.PROPHANDLING_COMPONENT_ID_INVALID_get()
static

An invalid component within a list has been referenced.

◆ PROPHANDLING_COMPONENT_NO_CALLBACK_REGISTERED

final int PROPHANDLING_COMPONENT_NO_CALLBACK_REGISTERED = acquireJNI.PROPHANDLING_COMPONENT_NO_CALLBACK_REGISTERED_get()
static

The user tried to modify a registered callback, but no callback has been registered for this component.

◆ PROPHANDLING_COMPONENT_NOT_FOUND

final int PROPHANDLING_COMPONENT_NOT_FOUND = acquireJNI.PROPHANDLING_COMPONENT_NOT_FOUND_get()
static

The specified component could not be found.

◆ PROPHANDLING_IMPLEMENTATION_MISSING

final int PROPHANDLING_IMPLEMENTATION_MISSING = acquireJNI.PROPHANDLING_IMPLEMENTATION_MISSING_get()
static

A feature that is not implemented so far has been requested.

The caller requested a feature, that hasn't been implemented so far. This error code is only provided for compatibility and will be set in very rare cases only.

◆ PROPHANDLING_INCOMPATIBLE_COMPONENTS

final int PROPHANDLING_INCOMPATIBLE_COMPONENTS = acquireJNI.PROPHANDLING_INCOMPATIBLE_COMPONENTS_get()
static

The two involved components are not compatible.

An operation requiring two compatible components has been called with two components, which are not compatible.

◆ PROPHANDLING_INPUT_BUFFER_TOO_SMALL

final int PROPHANDLING_INPUT_BUFFER_TOO_SMALL = acquireJNI.PROPHANDLING_INPUT_BUFFER_TOO_SMALL_get()
static

The user tried to read data into a user supplied storage location, but the buffer was too small to accommodate the result.

◆ PROPHANDLING_INVALID_FILE_CONTENT

final int PROPHANDLING_INVALID_FILE_CONTENT = acquireJNI.PROPHANDLING_INVALID_FILE_CONTENT_get()
static

The user tried to use a file to update or create a component list, that does not contain valid data for this operation.

This e.g. might happen, if the file does not contain valid XML data or XML data that is not well formed.

◆ PROPHANDLING_INVALID_INPUT_PARAMETER

final int PROPHANDLING_INVALID_INPUT_PARAMETER = acquireJNI.PROPHANDLING_INVALID_INPUT_PARAMETER_get()
static

A invalid input parameter has been passed to a function of this module.

In most cases this might be a unassigned pointer, where a valid pointer to a user defined storage location was expected.

◆ PROPHANDLING_INVALID_PROP_VALUE

final int PROPHANDLING_INVALID_PROP_VALUE = acquireJNI.PROPHANDLING_INVALID_PROP_VALUE_get()
static

It has been tried to assign an invalid value to a property.

This can either happen if the value lies above or below the min. or max. value for a property or when it has been tried to write a value to a property, which is not in the properties translation dictionary (if it defines one).
To find out, which values are allowed for the property in question the user should
• Check if the property defines a translation dictionary.
• Check the allowed values within a translation dictionary if one is defined.
• Check the min and max value for properties, that define limits.

◆ PROPHANDLING_INVALID_PROP_VALUE_TYPE

final int PROPHANDLING_INVALID_PROP_VALUE_TYPE = acquireJNI.PROPHANDLING_INVALID_PROP_VALUE_TYPE_get()
static

An invalid value has been passed to the property.

Although properties are quite tolerant regarding the allowed assignment for them some value types can't be used to write all properties. As an example assigning a float value to an integer property would result in this error.
Another reason for this error might be when a user tried to access e.g. a float property with functions meant to be used for int properties.

◆ PROPHANDLING_LAST_VALID_ERROR_CODE

final int PROPHANDLING_LAST_VALID_ERROR_CODE = acquireJNI.PROPHANDLING_LAST_VALID_ERROR_CODE_get()
static

Defines the last valid error code value for the property module.

◆ PROPHANDLING_LIST_CANT_ACCESS_DATA

final int PROPHANDLING_LIST_CANT_ACCESS_DATA = acquireJNI.PROPHANDLING_LIST_CANT_ACCESS_DATA_get()
static

The desired data can't be accessed or found.

During loading or saving data this error can occur e.g. if it has been tried to import a setting from a location where the desired setting couldn't be found. Another reason for this error might be that the current user is not allowed to perform a certain operation on the desired data (e.g. a user tries to delete a setting that is stored with global scope but does not have elevated access rights).

◆ PROPHANDLING_LIST_ENTRY_OCCUPIED

final int PROPHANDLING_LIST_ENTRY_OCCUPIED = acquireJNI.PROPHANDLING_LIST_ENTRY_OCCUPIED_get()
static

The specified list index is occupied.

During the creation of a new component the caller tried the insert the newly created component into a list at a position already used to store another component.

◆ PROPHANDLING_LIST_ID_INVALID

final int PROPHANDLING_LIST_ID_INVALID = acquireJNI.PROPHANDLING_LIST_ID_INVALID_get()
static

An invalid list has been referenced.

◆ PROPHANDLING_METHOD_INVALID_PARAM_LIST

final int PROPHANDLING_METHOD_INVALID_PARAM_LIST = acquireJNI.PROPHANDLING_METHOD_INVALID_PARAM_LIST_get()
static

A method object has an invalid parameter list.

◆ PROPHANDLING_METHOD_PTR_INVALID

final int PROPHANDLING_METHOD_PTR_INVALID = acquireJNI.PROPHANDLING_METHOD_PTR_INVALID_get()
static

The function pointer of the referenced method object is invalid.

◆ PROPHANDLING_NO_ERROR

final int PROPHANDLING_NO_ERROR = acquireJNI.PROPHANDLING_NO_ERROR_get()
static

The operation has been executed successfully.

◆ PROPHANDLING_NO_MODIFY_SIZE_RIGHTS

final int PROPHANDLING_NO_MODIFY_SIZE_RIGHTS = acquireJNI.PROPHANDLING_NO_MODIFY_SIZE_RIGHTS_get()
static

The caller can't modify the size of this component.

It has been tried to modify the size of this list or the number of values stored by a property, but the caller doesn't have the required right to do this.

This error will also be reported if the user tried to increase the number of values handled by a property above the maximum number of values it can handle. Therefore before resizing a property check if the new size might exceeds this maximum value by calling the appropriate function.

◆ PROPHANDLING_NO_READ_RIGHTS

final int PROPHANDLING_NO_READ_RIGHTS = acquireJNI.PROPHANDLING_NO_READ_RIGHTS_get()
static

The caller has no read rights for this component.

It has been tried to read data from this component, but the caller has no read rights for this component.

◆ PROPHANDLING_NO_WRITE_RIGHTS

final int PROPHANDLING_NO_WRITE_RIGHTS = acquireJNI.PROPHANDLING_NO_WRITE_RIGHTS_get()
static

The caller has no write rights for this component.

It has been tried to modify data of this component, but the caller has no write rights for this component.

◆ PROPHANDLING_NOT_A_LIST

final int PROPHANDLING_NOT_A_LIST = acquireJNI.PROPHANDLING_NOT_A_LIST_get()
static

This component is not a list.

A list operation for this component has been called but this component does not reference a list.

◆ PROPHANDLING_NOT_A_METHOD

final int PROPHANDLING_NOT_A_METHOD = acquireJNI.PROPHANDLING_NOT_A_METHOD_get()
static

This component is not a method.

A method operation for this component has been called but this component does not reference a method.

◆ PROPHANDLING_NOT_A_PROPERTY

final int PROPHANDLING_NOT_A_PROPERTY = acquireJNI.PROPHANDLING_NOT_A_PROPERTY_get()
static

This component is not a property.

A property operation for this component has been called but this component does not reference a property.

◆ PROPHANDLING_PROP_TRANSLATION_TABLE_CORRUPTED

final int PROPHANDLING_PROP_TRANSLATION_TABLE_CORRUPTED = acquireJNI.PROPHANDLING_PROP_TRANSLATION_TABLE_CORRUPTED_get()
static

The properties translation table has been corrupted.

The properties translation table has been corrupted for an unknown reason and can't be used anymore.

◆ PROPHANDLING_PROP_TRANSLATION_TABLE_NOT_DEFINED

final int PROPHANDLING_PROP_TRANSLATION_TABLE_NOT_DEFINED = acquireJNI.PROPHANDLING_PROP_TRANSLATION_TABLE_NOT_DEFINED_get()
static

This property doesn't define a translation table.

The caller tried to modify a translation table, that hasn't been defined for this property.

◆ PROPHANDLING_PROP_VAL_ID_OUT_OF_BOUNDS

final int PROPHANDLING_PROP_VAL_ID_OUT_OF_BOUNDS = acquireJNI.PROPHANDLING_PROP_VAL_ID_OUT_OF_BOUNDS_get()
static

Invalid value index.

The caller tried to read a value from an invalid index from a property. Most properties store one value only, thus the only valid positive value index will be 0 (some negative index values are reserved for special values like e.g. the min/max value of a property). However some properties might store more than one value, thus the max. allowed index might be higher. The highest index allowed will always be the value count of a property minus one for properties with the mvIMPACT.acquire.TComponentFlag.cfFixedSize flag set. Other properties will automatically adjust the size once the user writes to an index out of bounds.

◆ PROPHANDLING_PROP_VAL_TOO_LARGE

final int PROPHANDLING_PROP_VAL_TOO_LARGE = acquireJNI.PROPHANDLING_PROP_VAL_TOO_LARGE_get()
static

A too large value has been passed.

One or more of the values the caller tried to write to the property are larger than the max. allowed value for this property.

◆ PROPHANDLING_PROP_VAL_TOO_SMALL

final int PROPHANDLING_PROP_VAL_TOO_SMALL = acquireJNI.PROPHANDLING_PROP_VAL_TOO_SMALL_get()
static

A too small value has been passed.

One or more of the values the caller tried to write to the property are smaller than the min. allowed value for this property.

◆ PROPHANDLING_PROP_VALIDATION_FAILED

final int PROPHANDLING_PROP_VALIDATION_FAILED = acquireJNI.PROPHANDLING_PROP_VALIDATION_FAILED_get()
static

The user tried to assign a value to a property, that is invalid.

This will result in a detailed error message in the log-file. This error might arise e.g. when a string property doesn't allow the string to contain numbers. In this case trying to set the properties value to 'blabla7bla' would cause this error.

◆ PROPHANDLING_SIZE_MISMATCH

final int PROPHANDLING_SIZE_MISMATCH = acquireJNI.PROPHANDLING_SIZE_MISMATCH_get()
static

Different sized value buffers have been passed.

While trying to read value pairs the caller passed two different sized value buffers to a function while one is too small to hold all the information.

◆ PROPHANDLING_SWIG_ERROR

final int PROPHANDLING_SWIG_ERROR = acquireJNI.PROPHANDLING_SWIG_ERROR_get()
static

This indicates an internal error occurred within the SWIG generated wrapper code, when working under Python.

◆ PROPHANDLING_UNSUPPORTED_OPERATION

final int PROPHANDLING_UNSUPPORTED_OPERATION = acquireJNI.PROPHANDLING_UNSUPPORTED_OPERATION_get()
static

The user tried to execute an operation, which is not supported by the component he is referring to.

◆ PROPHANDLING_UNSUPPORTED_PARAMETER

final int PROPHANDLING_UNSUPPORTED_PARAMETER = acquireJNI.PROPHANDLING_UNSUPPORTED_PARAMETER_get()
static

One or more of the specified parameters are not supported by the function.

This error might also be generated if a certain feature is not available on the current platform.

◆ PROPHANDLING_WRONG_PARAM_COUNT

final int PROPHANDLING_WRONG_PARAM_COUNT = acquireJNI.PROPHANDLING_WRONG_PARAM_COUNT_get()
static

The number of parameters is incorrect.

This error might occur if the user called a function with a variable number of input or output parameters and the number of parameters passed to the function does not match the number of required parameters.