Data Structures
struct	PROP_values_stat_s

struct	PRULE_val_s

Typedefs
typedef enum PROP_field_type_e	PROP_field_type_t

typedef enum PROP_lov_attach_category_e	PROP_lov_attach_category_t

typedef enum PROP_protection_e	PROP_protection_t

typedef enum PROP_type_e	PROP_type_t

typedef enum PROP_valid_e	PROP_valid_t

typedef enum PROP_value_type_e	PROP_value_type_t

typedef struct PROP_values_stat_s	PROP_values_stat_t

typedef struct PRULE_val_s	PRULE_val_t

Enumerations
enum	PROP_field_type_e { PROP_field_unknown, PROP_simple_property, PROP_compound_object, PROP_compound_relation }

enum	PROP_lov_attach_category_e { PROP_lov_no_attaches, PROP_lov_istrue_attaches, PROP_lov_session_attaches, PROP_lov_object_based_attaches }

enum	PROP_protection_e { PROP_write, PROP_read, PROP_write_only_if_null }

enum	PROP_type_e { PROP_unknown, PROP_attribute, PROP_reference, PROP_relation, PROP_compound, PROP_runtime, PROP_operationinput }

enum	PROP_valid_e { PROP_valid_id, PROP_invalid_id, PROP_override_id, PROP_duplicate_id }

enum	PROP_value_type_e { PROP_untyped, PROP_char, PROP_date, PROP_double, PROP_float, PROP_int, PROP_logical, PROP_short, PROP_string, PROP_typed_reference, PROP_untyped_reference, PROP_external_reference, PROP_note, PROP_typed_relation, PROP_untyped_relation }

Functions
PROPERTY_API int	PROPDESC_ask_base_descriptor (tag_t prop_tag, tag_t base_prop_tag, tag_t base_type_tag)

PROPERTY_API int	PROPDESC_ask_compound_object_type (tag_t prop_tag, tag_t *compound_type_tag)

PROPERTY_API int	PROPDESC_ask_display_name (tag_t prop_tag, char **disp_name)

PROPERTY_API int	PROPDESC_ask_display_name_by_name (const char name, char *disp_name)

PROPERTY_API int	PROPDESC_ask_display_values_from_LOV_attachments (tag_t prop_tag, int n_values, const char values, char *display_values)

PROPERTY_API int	PROPDESC_ask_field_type (tag_t prop_tag, PROP_field_type_t *field_type)

PROPERTY_API int	PROPDESC_ask_lov (tag_t prop_tag, tag_t *lov_tag)

PROPERTY_API int	PROPDESC_ask_lov_attach_dep_order (tag_t prop_tag, int *order)

PROPERTY_API int	PROPDESC_ask_lov_attach_parent_number (tag_t prop_tag, int *n_parent)

PROPERTY_API int	PROPDESC_ask_lov_interdependents (tag_t prop_tag, tag_t lov_tag, int n_props, tag_t props, int orders, int n_parents, logical descAttaches)

PROPERTY_API int	PROPDESC_ask_max_num_elements (tag_t prop_tag, int *maxnumelem)

PROPERTY_API int	PROPDESC_ask_max_string_length (tag_t prop_tag, int *maxstrlen)

PROPERTY_API int	PROPDESC_ask_name (tag_t prop_tag, char **name)

PROPERTY_API int	PROPDESC_ask_object_type (tag_t prop_tag, tag_t *type_tag)

PROPERTY_API int	PROPDESC_ask_parent_descriptor (tag_t prop_tag, tag_t parent_prop_tag, tag_t parent_type_tag)

PROPERTY_API int	PROPDESC_ask_property_type (tag_t prop_tag, PROP_type_t proptype, char *proptype_n)

PROPERTY_API int	PROPDESC_ask_protection (tag_t prop_tag, PROP_protection_t *protection)

PROPERTY_API int	PROPDESC_ask_prule_init_value (tag_t prop_tag, char **prule_init_value)

PROPERTY_API int	PROPDESC_ask_source_object (tag_t object_tag, tag_t prop_tag, tag_t *source_obj_tag)

PROPERTY_API int	PROPDESC_ask_value_type (tag_t prop_tag, PROP_value_type_t valtype, char *valtype_n)

PROPERTY_API int	PROPDESC_describe_prule (tag_t prop_tag, PRULE_val_t **argList)

PROPERTY_API void	PROPDESC_free_prule_struct (PRULE_val_t **argList)

PROPERTY_API int	PROPDESC_generate_next_values (int n_prop_desc_tags, tag_t prop_desc_tags, char pattern_strings, char rule_suffix, char basis_name, tag_t operation_in_tag, tag_t source_tag, tag_t relation_type, logical is_modifiable_flags, char next_values, int error_codes)

PROPERTY_API int	PROPDESC_get_auto_assign_info (tag_t prop_desc_tag, char rule_suffix, logical is_autoassignable, int n_patterns, char pattern_strings, logical has_counter, char **last_selected_pattern)

PROPERTY_API int	PROPDESC_get_next_rev_options (tag_t prop_desc_tag, tag_t item_rev_tag, int n_formats, int rev_formats, char rev_options, char rev_descs, char *excluded_letters)

PROPERTY_API int	PROPDESC_is_copyfromoriginal (tag_t propDescTag, logical *isCopyFromOriginal)

PROPERTY_API int	PROPDESC_is_displayable (tag_t prop_tag, logical *display_flag)

PROPERTY_API int	PROPDESC_is_enabled (tag_t prop_tag, logical *enab_flag)

PROPERTY_API int	PROPDESC_is_lov_desc_attach (tag_t prop_tag, logical *verdict)

PROPERTY_API int	PROPDESC_is_lov_localizable (tag_t propDescTag, logical *isLOVLocalizable)

PROPERTY_API int	PROPDESC_is_modifiable (tag_t prop_tag, logical *mod_flag)

PROPERTY_API int	PROPDESC_is_required (tag_t prop_tag, logical *req_flag)

PROPERTY_API int	PROPDESC_is_validatable (tag_t prop_tag, logical *validatable_flag)

PROPERTY_API int	PROPDESC_next_values_in_bulk (const char type_name, int quantity, const char prop_name, const tag_t item_tag, const char ds_id, const char preferred_type_name, const char default_type_name, const tag_t parent_tag, const char rule_suffix, const char base_rev_id, const char pattern, char ***next_ids)

PROPERTY_API int	PROPDESC_set_display_name (tag_t prop_tag, const char *disp_name)

PROPERTY_API int	PROPDESC_validate_values (int num_of_prop_desc_tags, tag_t prop_desc_tags, tag_t oprn_input_tag, int operation_type, logical is_unique, PROP_values_stat_t **values_status)

Detailed Description

A property is a piece of information about an object of a particular type. A property descriptor defines (i.e., is the name of) a property. The interface for actual instances of a property is defined in imanproperty.h

Typedef Documentation

typedef enum PROP_field_type_e PROP_field_type_t

OperationInput Dialog Field Type

typedef enum PROP_lov_attach_category_e PROP_lov_attach_category_t

Defines the LOV attachment category information

typedef enum PROP_protection_e PROP_protection_t

Defines the protection types that might be on a property

typedef enum PROP_type_e PROP_type_t

Defines the different types of properties that are supported

typedef enum PROP_valid_e PROP_valid_t

Defines the property validation status for each attribute NOTE: This is needed since multiple attributes can exist and status for each is needed

typedef enum PROP_value_type_e PROP_value_type_t

Defines the different types of values a property might hold

typedef struct PROP_values_stat_s PROP_values_stat_t

structure to return property validation status to caller

typedef struct PRULE_val_s PRULE_val_t

Defines the property rule name value pair structure NOTE: Duplicate of RULE_val_t structure defined internally only in the businessrule.hxx

Enumeration Type Documentation

enum PROP_field_type_e

OperationInput Dialog Field Type

Enumerator
PROP_field_unknown
PROP_simple_property
PROP_compound_object
PROP_compound_relation

Definition at line 89 of file propdesc.h.

enum PROP_lov_attach_category_e

Defines the LOV attachment category information

Enumerator
PROP_lov_no_attaches	No attachments
PROP_lov_istrue_attaches	Only isTrue condition is attached
PROP_lov_session_attaches	Only Session Based Conditions are attached
PROP_lov_object_based_attaches	One or More Object Based Conditions are attached

Definition at line 100 of file propdesc.h.

enum PROP_protection_e

Defines the protection types that might be on a property

Enumerator
PROP_write	Property can be written to and read
PROP_read	Property can be read, but not written to
PROP_write_only_if_null	Property can be written to only if the existing value is null or empty

Definition at line 70 of file propdesc.h.

enum PROP_type_e

Defines the different types of properties that are supported

Enumerator
PROP_unknown	Property type is Unknown
PROP_attribute	Based on a POM Attribute (int, string, ...)
PROP_reference	Based on a POM Reference
PROP_relation	Based on an ImanRelation
PROP_compound	Based on a property from another Type
PROP_runtime	Based on a computed value
PROP_operationinput	Based on the source property on a BO

Definition at line 36 of file propdesc.h.

enum PROP_valid_e

Defines the property validation status for each attribute NOTE: This is needed since multiple attributes can exist and status for each is needed

Enumerator
PROP_valid_id	valid property
PROP_invalid_id	invalid property
PROP_override_id	modified property
PROP_duplicate_id	duplicate property

Definition at line 112 of file propdesc.h.

enum PROP_value_type_e

Defines the different types of values a property might hold

Enumerator
PROP_untyped	No Value type
PROP_char	Value is a single character
PROP_date	Value is a date
PROP_double	Value is a double
PROP_float	Value is a float
PROP_int	Value is an integer
PROP_logical	Value is a logical
PROP_short	Value is a short
PROP_string	Value is a character string
PROP_typed_reference	Value is a typed reference
PROP_untyped_reference	Value is an untyped reference
PROP_external_reference	Value is an external reference
PROP_note	Value is a note
PROP_typed_relation	Value is a typed relation
PROP_untyped_relation	Value is an untyped relation

Definition at line 49 of file propdesc.h.

Function Documentation

PROPERTY_API int PROPDESC_ask_base_descriptor	(	tag_t	prop_tag,
		tag_t *	base_prop_tag,
		tag_t *	base_type_tag
	)

Retrieves the base property descriptor (i.e. the top most ancestor) of the given property.

Returns

ITK_ok on success
PROP_invalid_descriptor if the property tag is invalid
Potentially other errors

Parameters

prop_tag	(I) The tag of the property descriptor
base_prop_tag	(O) The tag of the base property descriptor
base_type_tag	(O) The tag of the type of the base property descriptor

PROPERTY_API int PROPDESC_ask_compound_object_type	(	tag_t	prop_tag,
		tag_t *	compound_type_tag
	)

Asks the compound object type that the compound property descriptor defines.

Returns

ITK_ok on success
PROP_invalid_descriptor if the property tag is invalid
Potentially other errors

Parameters

prop_tag	(I) The tag of the property descriptor
compound_type_tag	(O) The tag of the compound type

PROPERTY_API int PROPDESC_ask_display_name	(	tag_t	prop_tag,
		char **	disp_name
	)

Asks display name of a property.

Parameters

prop_tag	(I) The tag of the property descriptor
disp_name	(OF) The display name of the property

PROPERTY_API int PROPDESC_ask_display_name_by_name	(	const char *	name,
		char **	disp_name
	)

Deprecated:: This function is not supported after Tc10.1. Please use PROPDESC_ask_display_name as the replacement ITK

Parameters

name	(I)
disp_name	(OF)

PROPERTY_API int PROPDESC_ask_display_values_from_LOV_attachments	(	tag_t	prop_tag,
		int	n_values,
		const char **	values,
		char ***	display_values
	)

For a given property, retrieves the display values of the attached LOV.

Returns

ITK_ok on success
PROP_invalid_descriptor if the property tag is invalid
Potentially other errors

Parameters

prop_tag	(I) The tag of the property descriptor
n_values	(I) Number of requested values
values	(I) n_values Values internal names
display_values	(OF) n_values Display values. This string array is packed and must be freed using MEM_free

PROPERTY_API int PROPDESC_ask_field_type	(	tag_t	prop_tag,
		PROP_field_type_t *	field_type
	)

Asks the field type that the property descriptor defines. It is useful for operation descriptor property.
The field type could be either of the following:

PROP_field_unknown
PROP_simple_property
PROP_compound_object
PROP_compound_relation

Returns

ITK_ok on success
PROP_invalid_descriptor if the property tag is invalid
Potentially other errors

Parameters

prop_tag	(I) The tag of the property descriptor
field_type	(O) The field type of the property descriptor

PROPERTY_API int PROPDESC_ask_lov	(	tag_t	prop_tag,
		tag_t *	lov_tag
	)

Retrieves the LOV associated with the specified property.

Parameters

prop_tag	(I) The property
lov_tag	(O) The LOV associated with the property

PROPERTY_API int PROPDESC_ask_lov_attach_dep_order	(	tag_t	prop_tag,
		int *	order
	)

Parameters

prop_tag	(I) The tag of the property descriptor
order	(O) The order at which the property is attached to the LOV The default is 0 (the whole LOV)

PROPERTY_API int PROPDESC_ask_lov_attach_parent_number	(	tag_t	prop_tag,
		int *	n_parent
	)

Parameters

prop_tag	(I) The tag of the property descriptor
n_parent	(O) The parent number for lov-property attachment if found

PROPERTY_API int PROPDESC_ask_lov_interdependents	(	tag_t	prop_tag,
		tag_t *	lov_tag,
		int *	n_props,
		tag_t **	props,
		int **	orders,
		int **	n_parents,
		logical **	descAttaches
	)

Parameters

prop_tag	(I)
lov_tag	(O)
n_props	(O) number of interdependent property descriptors
props	(OF) n_props interdependent property descriptors
orders	(OF) n_props orders for each interdepenent LOV property attachment
n_parents	(OF) n_props n_parent for each interdepenent LOV property attachment
descAttaches	(OF) n_props descAttach flag for each interdepenent LOV property attachment

PROPERTY_API int PROPDESC_ask_max_num_elements	(	tag_t	prop_tag,
		int *	maxnumelem
	)

Asks maximum number of elements for a property.

Parameters

prop_tag	(I) The tag of the property descriptor
maxnumelem	(O) The maximum number of elements for the property. Will be 1 for a single-valued property, -1 for a list property and a positive integer for an array property.

PROPERTY_API int PROPDESC_ask_max_string_length	(	tag_t	prop_tag,
		int *	maxstrlen
	)

Asks maximum string length for a property. The property must be type PROP_string.

Parameters

prop_tag	(I) The tag of the property descriptor
maxstrlen	(O) The maximum string length of the property value

PROPERTY_API int PROPDESC_ask_name	(	tag_t	prop_tag,
		char **	name
	)

Asks name of a property.

Parameters

prop_tag	(I) The tag of the property descriptor
name	(OF) The name of the property

PROPERTY_API int PROPDESC_ask_object_type	(	tag_t	prop_tag,
		tag_t *	type_tag
	)

Asks the type that the property descriptor defines.

Parameters

prop_tag	(I) The tag of the property descriptor
type_tag	(O) The tag of the type

PROPERTY_API int PROPDESC_ask_parent_descriptor	(	tag_t	prop_tag,
		tag_t *	parent_prop_tag,
		tag_t *	parent_type_tag
	)

Retrieves the immediate parent property descriptor of the given property.
Immediate parent is the material or source from which property descriptor is derived.

Returns

ITK_ok on success
PROP_invalid_descriptor if the property tag is invalid
NULLTAG if the given property is a base property (i.e. the top most ancestor).
Potentially other errors

Parameters

prop_tag	(I) The tag of the property descriptor
parent_prop_tag	(O) The property descriptor tag for the immediate parent
parent_type_tag	(O) The type of the property descriptor tag for the immediate parent

PROPERTY_API int PROPDESC_ask_property_type	(	tag_t	prop_tag,
		PROP_type_t *	proptype,
		char **	proptype_n
	)

Returns the property type.

Parameters

prop_tag	(I) The tag of the property descriptor
proptype	(O) The property type of the property
proptype_n	(OF) The name of the property type

PROPERTY_API int PROPDESC_ask_protection	(	tag_t	prop_tag,
		PROP_protection_t *	protection
	)

Asks default protection of a property.

Parameters

prop_tag	(I) The tag of the property descriptor
protection	(O) The default protection for the property. See PROP_protection_t for additional information about protections.

PROPERTY_API int PROPDESC_ask_prule_init_value	(	tag_t	prop_tag,
		char **	prule_init_value
	)

Asks the initial value (if any defined in a property rule) for the given property descriptor.

Parameters

prop_tag	(I) The property descriptor tag
prule_init_value	(OF) Initial value (if any) specified on the property rule

PROPERTY_API int PROPDESC_ask_source_object	(	tag_t	object_tag,
		tag_t	prop_tag,
		tag_t *	source_obj_tag
	)

For a given object and property, retrieves the source object from which the property is derived.

For example, for a given runtime line item and its property, this ITK retrieves the underlying object (e.g. Item) whose the line�s property is derived.

This ITK supports the following property types :

Configured Runtime Properties
Compound Properties

For any other property type, this ITK will simply set the source object as the input object.

Returns

ITK_ok on success
PROP_invalid_descriptor if the property tag is invalid
ITK_internal_error if the object tag is invalid
Potentially other errors

Parameters

object_tag	(I) The tag of the object
prop_tag	(I) The tag of the property descriptor
source_obj_tag	(O) The tag of the source object

PROPERTY_API int PROPDESC_ask_value_type	(	tag_t	prop_tag,
		PROP_value_type_t *	valtype,
		char **	valtype_n
	)

Returns the value type of a property.

Parameters

prop_tag	(I) The tag of the property descriptor
valtype	(O) The value type of the property
valtype_n	(OF) The name of the value type

PROPERTY_API int PROPDESC_describe_prule	(	tag_t	prop_tag,
		PRULE_val_t **	argList
	)

Describes all of the properties from a property rule.

Parameters

prop_tag	(I) The property descriptor tag
argList	(OF) Structure of Property Rule property name/value pairs

PROPERTY_API void PROPDESC_free_prule_struct ( PRULE_val_t ** argList )

Free memory for all members of the PRULE_val_t structure.

Parameters

argList (I/O) Structure of Property Rule property name/value pairs

PROPERTY_API int PROPDESC_generate_next_values	(	int	n_prop_desc_tags,
		tag_t *	prop_desc_tags,
		char **	pattern_strings,
		char *	rule_suffix,
		char *	basis_name,
		tag_t	operation_in_tag,
		tag_t	source_tag,
		tag_t	relation_type,
		logical **	is_modifiable_flags,
		char ***	next_values,
		int **	error_codes
	)

Retrieves the next ID based on the User Exits or Naming rules.
If there is a Customer User Exit defined for a property then it is given priority over the Naming rule.

Returns

ITK_ok on success
PROP_source_object_missing if an invalid source tag is provided.
NR_invalid_rule_suffix if an invalid values is provided as rule suffix.
PROP_error_autogenerate if invalid values are provided as input.
PROP_not_autoassignable if the given property is not auto assignable.

Parameters

n_prop_desc_tags	(I) The number of the property descriptor tags whose values are to be generated
prop_desc_tags	(I) Property descriptor tags whose values are to be generated
pattern_strings	(I) Pattern strings selected for each respective property in prop_desc_tags. Empty string if no pattern is selected
rule_suffix	(I) The string that determines whether baseline action is performed. 'PDR' is passed in case of Baseline action and an empty string in all other cases
basis_name	(I) A string that is passed from the application to form the basis of the Dataset, Form, Folder name . This input is only required during Dataset, Form, Folder creation and save as operation . If basisName is not specified then the Dataset, Form, Folder name is generated based on its parent object
operation_in_tag	(I) The operation input tag
source_tag	(I) The object that is being Revised/SaveAs or the parent object during Dataset, Form, Folder creation.It is optional in case of Dataset, Form, Folder creation
relation_type	(I) The relationship type between the dataset and its owning Item revision.This input is only required during Dataset creation and save as . This may not be specified if the relationship type is not known
is_modifiable_flags	(OF) n_prop_desc_tags For each property in prop_desc_tags specifies if the user can modify the generated value in the user Interface
next_values	(OF) n_prop_desc_tags Next value for each property in prop_desc_tags containing the value generated based on User Exit or Naming Rule configured on the property
error_codes	(OF) n_prop_desc_tags Error code for each property in prop_desc_tags containing the error encountered during the auto generation of its value

PROPERTY_API int PROPDESC_get_auto_assign_info	(	tag_t	prop_desc_tag,
		char *	rule_suffix,
		logical *	is_autoassignable,
		int *	n_patterns,
		char ***	pattern_strings,
		logical **	has_counter,
		char **	last_selected_pattern
	)

Retrieves the auto-assign information such as naming rules for a property of the given type.
If the property is item_revision_id and a revision naming rule is attached to it then no patterns are returned.

Returns

ITK_ok on success
PROP_error_autogenerate if invalid values are provided as input.
NR_invalid_rule_suffix if an invalid value is provided as rule suffix.
PROP_not_autoassignable if the given property is not auto assignable.

Parameters

prop_desc_tag	(I) The tag of the property descriptor for which the auto assign information is requested
rule_suffix	(I) The string that determines whether baseline action is performed. 'PDR' is passed in case of Baseline action and an empty string in all other cases
is_autoassignable	(O) The auto assign flag
n_patterns	(O) number of Patterns the Naming Rule contains
pattern_strings	(OF) n_patterns Pattern string for each pattern defined for Naming Rule. This string array is packed and should be freed by caller by calling SM_free or MEM_free.
has_counter	(OF) n_patterns Specifies if each pattern has a counter.
last_selected_pattern	(OF) The pattern that is previously selected for the given type, property combination

PROPERTY_API int PROPDESC_get_next_rev_options	(	tag_t	prop_desc_tag,
		tag_t	item_rev_tag,
		int *	n_formats,
		int **	rev_formats,
		char ***	rev_options,
		char ***	rev_descs,
		char **	excluded_letters
	)

Retrieves the revision naming rule information attached to the given type.
If there is no revision naming rule attached but a Naming Rule is attached to item_revision_id then the revision naming rule is returned as null.
If Naming Rule is also not attached then the parent type revision naming rule is returned.

Returns

ITK_ok on success.
ITEM_invalid_object if the item revision tag is invalid.
NR_invalid_prop_for_rev_nr if an invalid property is used for querying the Revision Naming Rule information.

Parameters

prop_desc_tag	(I) The tag of the property descriptor for which the Revision Naming Rule information is requested
item_rev_tag	(I) The tag of the Item Revision for which the Revision Naming Rule information is requested. NULLTAG should be passed in case of new Item creation
n_formats	(O) number Revision Naming Rule formats which is always 3(initial, secondary, supplemental). 0 if no revision naming rule is attached
rev_formats	(OF) n_formats Revision format for each Revision Naming Rule format of initial, secondary, supplemental revisions in the same order.If no format is defined then 0 is returned.
rev_options	(OF) n_formats Revision option for each next avilable revision ID of initial, secondary, supplemental revisions in the same order. An empty string is returned if the revision type is not applicable. This string array is packed and should be freed by caller by calling SM_free or MEM_free
rev_descs	(OF) n_formats Revision description for each revision type description of initial, secondary, supplemental revisions in the same order. An empty string is returned if the revision description is not defined. This string array is packed and should be freed by caller by calling SM_free or MEM_free
excluded_letters	(OF) The excluded letters that are not to be used in revision Id�s

PROPERTY_API int PROPDESC_is_copyfromoriginal	(	tag_t	propDescTag,
		logical *	isCopyFromOriginal
	)

Parameters

propDescTag	(I)
isCopyFromOriginal	(O)

PROPERTY_API int PROPDESC_is_displayable	(	tag_t	prop_tag,
		logical *	display_flag
	)

This function is obsoleted from tc8.0.1 release. If used it will cause data model corruption issues for the database and the Business Modeler IDE.
Use the Business Modeler IDE instead of this API.
Sets the default protection of a property.

extern PROPERTY_API int PROPDESC_set_protection( tag_t prop_tag, *< (I) The tag of the property descriptor PROP_protection_t protection *< (I) The default protection for the property. See PROP_protection_t for additional information about protections. );

Deprecated:: This function is not supported after V2009.0.0 Use CONSTANTS_get_property_constant_value instead, with signature (PROPERTY_CONST_VISIBLE, ..., ..., ... ).

Parameters

prop_tag	(I)
display_flag	(O)

PROPERTY_API int PROPDESC_is_enabled	(	tag_t	prop_tag,
		logical *	enab_flag
	)

Returns true is the property has to be enabled in the UI

Parameters

prop_tag	(I)
enab_flag	(O)

PROPERTY_API int PROPDESC_is_lov_desc_attach	(	tag_t	prop_tag,
		logical *	verdict
	)

Parameters

prop_tag	(I) The tag of the property descriptor
verdict	(O) whether the property is attached to the value description of the LOV

PROPERTY_API int PROPDESC_is_lov_localizable	(	tag_t	propDescTag,
		logical *	isLOVLocalizable
	)

Determines if a property is attached with any of static string LOVs.

Parameters

propDescTag	(I)
isLOVLocalizable	(O)

PROPERTY_API int PROPDESC_is_modifiable	(	tag_t	prop_tag,
		logical *	mod_flag
	)

Deprecated:: This function is not supported after V2009.0.0 Use CONSTANTS_get_property_constant_value instead, with signature (PROPERTY_CONST_MODIFIABLE, ..., ..., ... ).

Parameters

prop_tag	(I)
mod_flag	(O)

PROPERTY_API int PROPDESC_is_required	(	tag_t	prop_tag,
		logical *	req_flag
	)

Deprecated:: This function is not supported after V2009.0.0 Use CONSTANTS_get_property_constant_value instead, with signature (PROPERTY_CONST_REQUIRED, ..., ..., ... ).

Parameters

prop_tag	(I)
req_flag	(O)

PROPERTY_API int PROPDESC_is_validatable	(	tag_t	prop_tag,
		logical *	validatable_flag
	)

Determines if a property can be validated, that is if a "user-exit" or "name-rule" rule is available to validate the property.

Returns

ITK_ok on success
Error code on failure

Parameters

prop_tag	(I) Tag of the property descriptor
validatable_flag	(O) The validation status: true if the property can be validated, false otherwise.

PROPERTY_API int PROPDESC_next_values_in_bulk	(	const char *	type_name,
		int	quantity,
		const char *	prop_name,
		const tag_t	item_tag,
		const char *	ds_id,
		const char *	preferred_type_name,
		const char *	default_type_name,
		const tag_t	parent_tag,
		const char *	rule_suffix,
		const char *	base_rev_id,
		const char *	pattern,
		char ***	next_ids
	)

Retrieves a sequential number of next IDs values, as would be generated by a bulk creation, for a particular pattern in the Naming Rule attached to the given property of a business object.

This ITK is a generalized ITK for generating next IDs in case of :

next item IDs
next revision IDs
next revision IDs generated from the pattern in the alternate rule
next alternate IDs generated from the pattern in rule
next dataset IDs
next dataset revision IDs
for any property's next values on a type.

This ITK generates the next IDs corresponding to the input pattern of a Naming Rule that is attached to the property.

If no input pattern is matched, the next IDs will be generated using the first pattern of the Naming Rule.
If the next_ids array is returned as NULL, either no Naming Rule is defined, or a Naming Rule without any counters is defined for the given input.

When the input parameter "type_name" is empty, the input parameters "preferred_type_name", "default_type_name" and "parent_tag" are used for next alternate IDs generation. If "rule_suffix" and "base_rev_id" parameters are supplied, the next revision IDs are generated from the pattern in the alternate rule. If "ds_id" parameter is supplied and the input property is "rev", the next available ID in the Naming Rule counter is set from latest revision id of the "ds_id" dataset.

Returns

ITK_ok on success
NR_autogen_not_set, if no counters are set with the given Naming Rule.
NR_no_counters_found, if no counters are found with the given Naming Rule.

Parameters

type_name	(I) Teamcenter internal type name, i.e. "Item"
quantity	(I) Number of ID of the specified type to be created
prop_name	(I) Property internal name, i.e. "item_id", "item_revision_id", "object_name"
item_tag	(I) The tag of the parent type used in next alternate revision ID
ds_id	(I) Dataset ID to be used for resetting next available ID
preferred_type_name	(I) Preferred type name used in case of next alternate ID
default_type_name	(I) Default type name used in case of next alternate ID
parent_tag	(I) Used in case of next alternate ID
rule_suffix	(I) Used in case of next revision ID generated from the pattern in the alternate rule
base_rev_id	(I) Used in case of next revision ID generated from the pattern in the alternate rule
pattern	(I) The input Naming Rule Pattern for which the next id is to be generated
next_ids	(OF) quantity Array of generated next IDs

PROPERTY_API int PROPDESC_set_display_name	(	tag_t	prop_tag,
		const char *	disp_name
	)

Sets the display name of a property.

Parameters

prop_tag	(I) The tag of the property
disp_name	(I) The new display name of the property

PROPERTY_API int PROPDESC_validate_values	(	int	num_of_prop_desc_tags,
		tag_t *	prop_desc_tags,
		tag_t	oprn_input_tag,
		int	operation_type,
		logical *	is_unique,
		PROP_values_stat_t **	values_status
	)

Returns applicable enumerated validation status for each input property: PROP_valid_id , PROP_invalid_id , PROP_override_id , PROP_duplicate_id .

Returns

ITK_ok on success
PROP_null_input_not_allowed if a null input tag is received
PROP_invalid_prop_type if the input property type is invalid

Parameters

num_of_prop_desc_tags	(I) Number of property descriptors
prop_desc_tags	(I) Corresponding property descriptor tags
oprn_input_tag	(I) Operation input object
operation_type	(I) For future use, pass -1 for now
is_unique	(O) If the given input makes up unique MFK
values_status	(OF) num_of_prop_desc_tags Validation status list for input properties

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

Enumeration Type Documentation

Function Documentation