Modules
	Lists of tags for objects that have been modified (changed or deleted)

	Type Errors

	Type Specific Messages

Data Structures
struct	TCTYPE_availablerel_s

Macros
#define	TC_set_description_msg "IMAN_set_description"

#define	TC_set_id_msg "IMAN_set_id"

#define	TC_set_name_msg "IMAN_set_name"

#define	TC_set_type_directly_msg "IMAN_set_type_directly"

#define	TC_set_type_msg "IMAN_set_type"

#define	TCTYPE_class_name_size_c 27

#define	TCTYPE_DISABLE_UPDATE_LIST 0

#define	TCTYPE_ENABLE_UPDATE_LIST 1

#define	TCTYPE_name_size_c 32

#define	TCTYPE_RESUME_UPDATE_LIST 3

#define	TCTYPE_SUSPEND_UPDATE_LIST 2

#define	TCTYPE_UPDATE_ALL_PROPS "_update_all_"

Typedefs
typedef struct TCTYPE_availablerel_s	TCTYPE_availablerel_t

typedef enum TCTYPE_category_e	TCTYPE_category_t

typedef enum TCTYPE_compounding_ctxt_e	TCTYPE_compounding_ctxt_t

typedef enum TCTYPE_display_e	TCTYPE_display_t

typedef enum TCTYPE_operation_input_e	TCTYPE_operation_input_t

typedef enum TCTYPE_save_operation_context_e	TCTYPE_save_operation_context_t

Enumerations
enum	TCTYPE_category_e { TCTYPE_Persistent, TCTYPE_Runtime, TCTYPE_OperationInput, TCTYPE_Root, TCTYPE_Dynamic, TCTYPE_All }

enum	TCTYPE_compounding_ctxt_e { TCTYPE_compounding_ctxt_unknown, TCTYPE_compounding_ctxt_relation, TCTYPE_compounding_ctxt_secondary }

enum	TCTYPE_display_e { TCTYPE_DISPLAYABLE =0, TCTYPE_HIDDEN_AT_SYSTEM_LEVEL, TCTYPE_HIDDEN_AT_SITE_LEVEL, TCTYPE_HIDDEN_AT_PARENT_LEVEL, TCTYPE_HIDDEN_AT_CURRENT_LEVEL }

enum	TCTYPE_operation_input_e { TCTYPE_OPERATIONINPUT_CREATE, TCTYPE_OPEARTIONINPUT_REVISE, TCTYPE_OPERATIONINPUT_SAVEAS, TCTYPE_OPERATIONINPUT_ANY }

enum	TCTYPE_save_operation_context_e { TCTYPE_save_on_create, TCTYPE_save_on_saveas, TCTYPE_save_on_revise, TCTYPE_save_on_update, TCTYPE_save_on_clone, TCTYPE_unknown_operation_context }

Functions
TCCORE_API int	TCTYPE_add_relation_property (tag_t type_tag, const char prop_name, tag_t rel_type, tag_t pd_tag)

TCCORE_API int	TCTYPE_add_runtime_array_property (tag_t type_tag, const char prop_name, PROP_value_type_t valuetype, int maxstrlen, int maxnumelements, tag_t pd_tag)

TCCORE_API int	TCTYPE_add_runtime_property (tag_t type_tag, const char prop_name, PROP_value_type_t valuetype, int maxstrlen, tag_t pd_tag)

TCCORE_API int	TCTYPE_ask_available_relation_names (tag_t type_tag, int relationNameCount, char relationDisplayNames, char *relationActualNames)

TCCORE_API int	TCTYPE_ask_available_relations (tag_t type_tag, int relationCount, TCTYPE_availablerel_t *relationNames)

TCCORE_API int	TCTYPE_ask_child_primary_types (tag_t type_tag, int numOfChildTypes, tag_t *listOfChildTypes)

TCCORE_API int	TCTYPE_ask_child_types (tag_t type_tag, logical forSameClassOnly, int numOfChildTypes, tag_t *listOfChildTypes)

TCCORE_API int	TCTYPE_ask_class_name (tag_t type_tag, char type_class[TCTYPE_class_name_size_c+1])

TCCORE_API int	TCTYPE_ask_class_name2 (tag_t type_tag, char **type_class)

TCCORE_API int	TCTYPE_ask_create_descriptor (tag_t boTypeTag, tag_t *createDescTag)

TCCORE_API int	TCTYPE_ask_create_prop_descriptors (tag_t createDescTag, int n_propDescTags, tag_t propDescTags, int n_secPropNames, char *secPropNames, tag_t secBOTypeTags, logical isRequired, logical isArray, int compoundingCtxts, tag_t secCreateDescTags)

TCCORE_API int	TCTYPE_ask_deepcopydata (tag_t object_tag, TCTYPE_operation_input_t opvar, int num_attached_objs, tag_t *deepcopydata_tags)

TCCORE_API int	TCTYPE_ask_display_name (tag_t type_tag, char **display_type_name)

TCCORE_API int	TCTYPE_ask_name (tag_t type_tag, char type_name[TCTYPE_name_size_c+1])

TCCORE_API int	TCTYPE_ask_name2 (tag_t type_tag, char **type_name)

TCCORE_API int	TCTYPE_ask_name_rule_patterns (const char boName, int n_propNames, char *propNames, int patternCountArray, int n_patterns, char **patterns)

TCCORE_API int	TCTYPE_ask_object_type (tag_t obj_tag, tag_t *type_tag)

TCCORE_API int	TCTYPE_ask_object_type_with_stubs (tag_t obj_tag, tag_t *type_tag)

TCCORE_API int	TCTYPE_ask_object_types (int number_of_objects, const tag_t obj_tags, tag_t *types)

TCCORE_API int	TCTYPE_ask_parent_type (tag_t type_tag, tag_t *parent_type_tag)

TCCORE_API int	TCTYPE_ask_property_by_display_name (tag_t type_tag, const char disp_name, tag_t pd_tag)

TCCORE_API int	TCTYPE_ask_property_by_name (tag_t type_tag, const char prop_name, tag_t pd_tag)

TCCORE_API int	TCTYPE_ask_revise_descriptor (tag_t object_type_tag, tag_t *revise_desc_tag)

TCCORE_API int	TCTYPE_ask_save_operation_context (TCTYPE_save_operation_context_t *opEnmSvOprnCtxt)

TCCORE_API int	TCTYPE_ask_saveas_descriptor (tag_t objectTypeTag, tag_t *saveAsDescTag)

TCCORE_API int	TCTYPE_ask_saveas_prop_descriptors (tag_t saveasDescTag, int n_propDescTags, tag_t *propDescTags)

TCCORE_API int	TCTYPE_ask_subtypes (tag_t type_tag, logical forSameClassOnly, int numOfSubtypes, tag_t *listOfSubtypes)

TCCORE_API int	TCTYPE_ask_subtypes_with_exclusions (tag_t type_tag, logical for_same_class_only, int n_exclusion_bo_names, const char *exclusion_bo_names, int num_of_sub_types, tag_t **list_of_sub_types)

TCCORE_API int	TCTYPE_ask_target_deepcopydata (tag_t objectTag, int numAttachedObjs, tag_t *deepCopyDataTags)

TCCORE_API int	TCTYPE_ask_type (const char type_name, tag_t type_tag)

TCCORE_API int	TCTYPE_construct_create_input (tag_t boTypeTag, tag_t *createInputTag)

TCCORE_API int	TCTYPE_construct_operationinput (tag_t targetObjTypeTag, TCTYPE_operation_input_t opvar, tag_t *targetSaveAsInputTag)

TCCORE_API int	TCTYPE_construct_saveasinput (tag_t boTypeTag, tag_t *saveAsInputTag)

TCCORE_API int	TCTYPE_create_object (tag_t creInputTag, tag_t *boTag)

TCCORE_API int	TCTYPE_create_objects (int n_bulks, int quantities, tag_t create_inputs, int n_objects, tag_t *objects)

TCCORE_API int	TCTYPE_create_single_objects (int n_bulks, const tag_t create_inputs, int n_objects, tag_t **objects)

TCCORE_API int	TCTYPE_exit_module ()

TCCORE_API int	TCTYPE_extent (int number_of_types, tag_t *type_tags)

TCCORE_API int	TCTYPE_extent_by_category (TCTYPE_category_t type_category, int number_of_types, tag_t *type_tags)

TCCORE_API int	TCTYPE_find_alltypes_for_class (const char class_name, int number_of_types, tag_t **type_tags)

TCCORE_API int	TCTYPE_find_displayable_business_objects (const char boName, int n_exclusionBONames, const char exclusionBONames, int n_displayableTypeTags, tag_t **displayableTypeTags)

TCCORE_API int	TCTYPE_find_displayable_types_for_class (const char class_name, logical include_subclasses, int number_of_types, tag_t **type_tags)

TCCORE_API int	TCTYPE_find_displayable_types_for_class_and_accessor (const char class_name, tag_t accessor_tag, logical include_subclasses, int number_of_types, tag_t **type_tags)

TCCORE_API int	TCTYPE_find_hidden_types_for_class_and_accessor (const char class_name, tag_t accessor_tag, logical include_subclasses, int number_of_types, tag_t type_tags, TCTYPE_display_t details)

TCCORE_API int	TCTYPE_find_type (const char type_name, const char class_name, tag_t *type_tag)

TCCORE_API int	TCTYPE_find_types_for_class (const char class_name, int number_of_types, tag_t **type_tags)

TCCORE_API int	TCTYPE_free_deepcopydata (int numDeepCopyData, tag_t *deepCopyDataTags)

TCCORE_API int	TCTYPE_init_module ()

TCCORE_API logical	TCTYPE_is_extent_already_called ()

TCCORE_API int	TCTYPE_is_type_of (tag_t type, tag_t parent_type, logical *answer)

TCCORE_API int	TCTYPE_is_type_of_as_str (tag_t type_tag, const char parent_type_name, logical answer)

TCCORE_API int	TCTYPE_list_displayable_properties (tag_t type_tag, int num, tag_t *pd_tags)

TCCORE_API int	TCTYPE_list_primary_rtypes (tag_t primary_type, int n_rtypes, tag_t *rtypes)

TCCORE_API int	TCTYPE_list_properties (tag_t type_tag, int num, tag_t *pd_tags)

TCCORE_API int	TCTYPE_load_all_delayed_types ()

TCCORE_API int	TCTYPE_property_exists (tag_t type_tag, const char prop_name, logical verdict)

TCCORE_API int	TCTYPE_refresh (tag_t type_tag, logical lock_or_not)

TCCORE_API int	TCTYPE_register_properties (USER_prop_init_entry_t *user_types_methods, int array_size)

TCCORE_API int	TCTYPE_revise_objects (int num_target_objs, tag_t target_object_tags, tag_t revise_input_tags, int num_attached_objs, tag_t deepcopydata_tags, tag_t target_copy_tags, int ifails)

TCCORE_API int	TCTYPE_saveas_object (tag_t targetObjectTag, tag_t saveAsInputTag, int numAttachedObjects, tag_t deepCopyDataTags, tag_t targetCopyTag)

TCCORE_API int	TCTYPE_set_create_display_value (tag_t creInputTag, char propName, int n_dispValues, const char *dispValues)

TCCORE_API int	TCTYPE_set_OperationInput_DisplayValue (tag_t opInputTag, char propName, const char *dispValues)

TCCORE_API int	TCTYPE_UIF_find_displayable_business_objects (const char boName, int n_exclusionBONames, const char exclusionBONames, int n_displayableTypeTags, tag_t displayableTypeTags, char typeNames, char **displayTypeNames)

TCCORE_API int	TCTYPE_UIF_find_displayable_types_for_class (const char class_name, logical include_subclasses, int number_of_types, tag_t type_tags, char type_names, char **display_type_names)

TCCORE_API int	TCTYPE_UIF_find_generically_creatable_business_objects (const char bo_name, int n_exclusion_bo_names, const char exclusion_bo_names, int n_displayable_type_tags, tag_t displayable_type_tags, char type_names, char **display_type_names)

Detailed Description

A type represents some object in the user's business environment. Some examples are: Part, Equipment, Employee. In Teamcenter, a type is implemented by a class. Some common Teamcenter classes are: Item, Form, and Person. This section describes the ITK interface for types.

A type can have properties and methods which define it and dictate its behavior. Go to Properties and Methods for additional information.

By default, a type implemented by a class will have a property for each class attribute. Any of those properties can be removed from the type and additional properties can be added to the type. Those additional properties can be:

run-time	Value is derived at run-time.
relation	Implemented by an TcRelation.
compound	Uses a property from another object.

Macro Definition Documentation

#define TC_set_description_msg "IMAN_set_description"

Definition at line 49 of file tctype.h.

#define TC_set_id_msg "IMAN_set_id"

Definition at line 47 of file tctype.h.

#define TC_set_name_msg "IMAN_set_name"

Definition at line 48 of file tctype.h.

#define TC_set_type_directly_msg "IMAN_set_type_directly"

Definition at line 51 of file tctype.h.

#define TC_set_type_msg "IMAN_set_type"

Definition at line 50 of file tctype.h.

#define TCTYPE_class_name_size_c 27

Definition at line 61 of file tctype.h.

#define TCTYPE_DISABLE_UPDATE_LIST 0

This is used to enable client server update list.

Definition at line 70 of file tctype.h.

#define TCTYPE_ENABLE_UPDATE_LIST 1

Definition at line 71 of file tctype.h.

#define TCTYPE_name_size_c 32

Definition at line 60 of file tctype.h.

#define TCTYPE_RESUME_UPDATE_LIST 3

Definition at line 73 of file tctype.h.

#define TCTYPE_SUSPEND_UPDATE_LIST 2

Definition at line 72 of file tctype.h.

#define TCTYPE_UPDATE_ALL_PROPS "_update_all_"

This is used to indicate all loaded properties needs to be processed.

Definition at line 78 of file tctype.h.

Typedef Documentation

typedef struct TCTYPE_availablerel_s TCTYPE_availablerel_t

typedef enum TCTYPE_category_e TCTYPE_category_t

Defines the business objects category that could be on a type.
This enumeration can be used by TCTYPE_extent_by_category.
If category is TCTYPE_Persistent, it returns all the business object types of persistent.
If category is TCTYPE_Runtime, it returns all the business object types of runtime.
If category is TCTYPE_OperationInput, it returns all the business object types of operation input.
If category is TCTYPE_Dynamic, it returns all the business object types of dynamic types.
If the category is #TCTYPE_ALL or #TC_TYPE_ROOT, it returns all the business object types of runtime, persistent and dynamic types.

typedef enum TCTYPE_compounding_ctxt_e TCTYPE_compounding_ctxt_t

This is used to indicate the context for secondary object creation when a primary object is created.

typedef enum TCTYPE_display_e TCTYPE_display_t

typedef enum TCTYPE_operation_input_e TCTYPE_operation_input_t

Defines the supported operation input types. These types correspond to the OperationInput types defined in BMIDE and can be used as input of MetaModel operations.

typedef enum TCTYPE_save_operation_context_e TCTYPE_save_operation_context_t

The options listed by the enum lets the user understand the context during a deferred save operation, especially when implementing PostAction extensions that have been manually moved.

Enumeration Type Documentation

enum TCTYPE_category_e

Defines the business objects category that could be on a type.
This enumeration can be used by TCTYPE_extent_by_category.
If category is TCTYPE_Persistent, it returns all the business object types of persistent.
If category is TCTYPE_Runtime, it returns all the business object types of runtime.
If category is TCTYPE_OperationInput, it returns all the business object types of operation input.
If category is TCTYPE_Dynamic, it returns all the business object types of dynamic types.
If the category is #TCTYPE_ALL or #TC_TYPE_ROOT, it returns all the business object types of runtime, persistent and dynamic types.

Enumerator
TCTYPE_Persistent	Indicates persistent business objects
TCTYPE_Runtime	Indicates runtime business objects
TCTYPE_OperationInput	Indicates operation input business objects
TCTYPE_Root	Indicates root object
TCTYPE_Dynamic	Indicates programmatically created business object
TCTYPE_All	Indicates all business objects

Definition at line 97 of file tctype.h.

enum TCTYPE_compounding_ctxt_e

This is used to indicate the context for secondary object creation when a primary object is created.

Enumerator
TCTYPE_compounding_ctxt_unknown	Context for secondary object is unknown
TCTYPE_compounding_ctxt_relation	The secondary object is a relation object. This is useful in cases where properties on relation need to be configured for generic creation.
TCTYPE_compounding_ctxt_secondary	The secondary object is a Business Object that is not a relation e.g Item Master is the secondary object created when an Item is created.

Definition at line 115 of file tctype.h.

enum TCTYPE_display_e

Enumerator
TCTYPE_DISPLAYABLE	Type is displayable.
TCTYPE_HIDDEN_AT_SYSTEM_LEVEL	Type is hidden at System level
TCTYPE_HIDDEN_AT_SITE_LEVEL	Type is hidden at Site level
TCTYPE_HIDDEN_AT_PARENT_LEVEL	Type is hidden at Parent level
TCTYPE_HIDDEN_AT_CURRENT_LEVEL	Type is hidden at Current level

Definition at line 80 of file tctype.h.

enum TCTYPE_operation_input_e

Defines the supported operation input types. These types correspond to the OperationInput types defined in BMIDE and can be used as input of MetaModel operations.

Enumerator
TCTYPE_OPERATIONINPUT_CREATE	Create operation input type
TCTYPE_OPEARTIONINPUT_REVISE	Revise operation input type
TCTYPE_OPERATIONINPUT_SAVEAS	SaveAs operation input type
TCTYPE_OPERATIONINPUT_ANY	Generic operation input type

Definition at line 126 of file tctype.h.

enum TCTYPE_save_operation_context_e

The options listed by the enum lets the user understand the context during a deferred save operation, especially when implementing PostAction extensions that have been manually moved.

Enumerator
TCTYPE_save_on_create	Save operation in the context of Create
TCTYPE_save_on_saveas	Save operation in the context of SaveAs
TCTYPE_save_on_revise	Save operation in the context of Revise
TCTYPE_save_on_update	Save operation in the context of Update
TCTYPE_save_on_clone	Save operation in the context of Clone
TCTYPE_unknown_operation_context	Save operation in the context of Unknown

Definition at line 138 of file tctype.h.

Function Documentation

TCCORE_API int TCTYPE_add_relation_property	(	tag_t	type_tag,
		const char *	prop_name,
		tag_t	rel_type,
		tag_t *	pd_tag
	)

Deprecated:: This function is deprecated and will be removed from Tc10. In Tc8.3 onwards, please define the relation properties from BMIDE.

Creates a relation property descriptor and adds it to the list of properties that define the specified type. A "relation" property represents a relationship between an object of this type and an object or Objects of another type.

Parameters

type_tag	(I) The tag of this type
prop_name	(I) The name of the property to add. This is the name the property is internally referred to. The property can also have a presentation name which is displayed to the Teamcenter user interface. Go to Properties User Interface (PROP_UIF) for additional information about how to change the presentation name of the property.
rel_type	(I) The tag of the relation type
pd_tag	(O) The tag of the new property descriptor

TCCORE_API int TCTYPE_add_runtime_array_property	(	tag_t	type_tag,
		const char *	prop_name,
		PROP_value_type_t	valuetype,
		int	maxstrlen,
		int	maxnumelements,
		tag_t *	pd_tag
	)

Deprecated:: This function is deprecated and will be removed from Tc10. In Tc8.3 onwards, please define the runtime array properties from BMIDE.

Creates a run-time multi-valued array property descriptor and adds it to the list of properties that define the specified type. The term "multi-valued" indicates that the property can have fixed no. or unlimited no. of values associated with it. The term "run-time" indicates that this property derives its value at run-time, instead of storing it in the database.

Parameters

type_tag	(I) The tag for the type
prop_name	(I) The name of the property to add. This is the name that the property is internally referred to. The property can also have a presentation name which is displayed to the Teamcenter user interface. Go to Properties User Interface (PROP_UIF) for additional information about how to change the presentation name of the property.
valuetype	(I) The type of value this property holds (e.g., string, integer, logical). It will correspond to one of the value types defined by the PROP_type_t enumeration.
maxstrlen	(I) The maximum size of the valuetype PROP_string. This parameter is ignored if valuetype is an integer or logical.
maxnumelements	(I) The maximum number of elements of the valuetype. (-1 for unspecified (variable) no. of values , 1 for single value, greater than 1 for specifying the no. of values)
pd_tag	(O) The tag of the new property descriptor

TCCORE_API int TCTYPE_add_runtime_property	(	tag_t	type_tag,
		const char *	prop_name,
		PROP_value_type_t	valuetype,
		int	maxstrlen,
		tag_t *	pd_tag
	)

Deprecated:: This function is deprecated and will be removed from Tc10. In Tc8.3 onwards, please define the runtime properties from BMIDE.

Creates a run-time property descriptor and adds it to the list of properties that define the specified type. The term "run-time" indicates that this property derives its value at run-time, instead of storing it in the database.

Parameters

type_tag	(I) The tag for the type
prop_name	(I) The name of the property to add. This is the name that the property is internally referred to. The property can also have a presentation name which is displayed to the Teamcenter user interface. Go to Properties User Interface (PROP_UIF) for additional information about how to change the presentation name of the property.
valuetype	(I) The type of value this property holds (e.g., string, integer, logical). It will correspond to one of the value types defined by the PROP_type_t enumeration.
maxstrlen	(I) The maximum size of the valuetype PROP_string. This parameter is ignored if valuetype is an integer or logical.
pd_tag	(O) The tag of the new property descriptor

TCCORE_API int TCTYPE_ask_available_relation_names	(	tag_t	type_tag,
		int *	relationNameCount,
		char ***	relationDisplayNames,
		char ***	relationActualNames
	)

Parameters

type_tag	(I)
relationNameCount	(O)
relationDisplayNames	(OF) relationNameCount
relationActualNames	(OF) relationNameCount

TCCORE_API int TCTYPE_ask_available_relations	(	tag_t	type_tag,
		int *	relationCount,
		TCTYPE_availablerel_t **	relationNames
	)

Parameters

type_tag	(I)
relationCount	(O)
relationNames	(OF) relationCount

TCCORE_API int TCTYPE_ask_child_primary_types	(	tag_t	type_tag,
		int *	numOfChildTypes,
		tag_t **	listOfChildTypes
	)

This function will return a list of child types of a given type. Each of the returned child types is also a primary type.

Parameters

type_tag	(I) a type tag
numOfChildTypes	(O) the number of types found
listOfChildTypes	(OF) the list of child primary types found

TCCORE_API int TCTYPE_ask_child_types	(	tag_t	type_tag,
		logical	forSameClassOnly,
		int *	numOfChildTypes,
		tag_t **	listOfChildTypes
	)

This function will return a list of immediate child types of a given type. Note that forSameClassOnly is used to scope what the returned list of subtypes will include. If the value is "true", then the returned list of child subtypes will include only child subtypes that are created for the same class as for the given type. The returned subtypes will be the subtypes that are one-level down in the type hierarchy from the given type. If the value is "false" and the given type is a primary type, then the returned list of subtypes will include the immediate subtypes for the same class as well as all primary types for the immediate subclasses of the class of the given type.

Parameters

type_tag	(I) a type tag
forSameClassOnly	(I) a flag indicating whether the scope of the search is limited to types for the same class
numOfChildTypes	(O) the number of types found
listOfChildTypes	(OF) the list of child types found

TCCORE_API int TCTYPE_ask_class_name	(	tag_t	type_tag,
		char	type_class[TCTYPE_class_name_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use TCTYPE_ask_class_name2

Asks the type for the name of the class that implements it.

Parameters

type_tag	(I) The tag for the type
type_class	(O) The name of the class

TCCORE_API int TCTYPE_ask_class_name2	(	tag_t	type_tag,
		char **	type_class
	)

Asks the type for the name of the class that implements it.

Parameters

type_tag	(I) The tag for the type
type_class	(OF) The name of the class

TCCORE_API int TCTYPE_ask_create_descriptor	(	tag_t	boTypeTag,
		tag_t *	createDescTag
	)

Returns the CreateInput Type object tag for the input BO.

Parameters

boTypeTag	(I)
createDescTag	(O)

TCCORE_API int TCTYPE_ask_create_prop_descriptors	(	tag_t	createDescTag,
		int *	n_propDescTags,
		tag_t **	propDescTags,
		int *	n_secPropNames,
		char ***	secPropNames,
		tag_t **	secBOTypeTags,
		logical **	isRequired,
		logical **	isArray,
		int **	compoundingCtxts,
		tag_t **	secCreateDescTags
	)

Returns all the property descriptors and compound object data for the input CreateInput object type.

Parameters

createDescTag	(I)
n_propDescTags	(O)
propDescTags	(OF) n_propDescTags
n_secPropNames	(O)
secPropNames	(OF) n_secPropNames
secBOTypeTags	(OF) n_secPropNames
isRequired	(OF) n_secPropNames
isArray	(OF) n_secPropNames
compoundingCtxts	(OF) n_secPropNames
secCreateDescTags	(OF) n_secPropNames

TCCORE_API int TCTYPE_ask_deepcopydata	(	tag_t	object_tag,
		TCTYPE_operation_input_t	opvar,
		int *	num_attached_objs,
		tag_t **	deepcopydata_tags
	)

Returns the DeepCopyData tag(s) for the input object, a top-level object undergoing the operation type specified by opvar, such as SaveAs or Revise.

Parameters

object_tag	(I) The tag of the top-level object being revised or saved
opvar	(I) The operation type
num_attached_objs	(O) The number of objects related to the top-level object through a relation or reference property
deepcopydata_tags	(OF) num_attached_objs Array of the DeepCopyData tags

TCCORE_API int TCTYPE_ask_display_name	(	tag_t	type_tag,
		char **	display_type_name
	)

Asks a type for its display name.

Parameters

type_tag	(I) The tag for the type
display_type_name	(OF) The display name of the type

TCCORE_API int TCTYPE_ask_name	(	tag_t	type_tag,
		char	type_name[TCTYPE_name_size_c+1]
	)

Deprecated:: This function is deprecated and will be removed from Tc12. In Tc10 onwards, please use TCTYPE_ask_name2

Asks a type for its name.

Parameters

type_tag	(I) The tag for the type
type_name	(O) The name of the type

TCCORE_API int TCTYPE_ask_name2	(	tag_t	type_tag,
		char **	type_name
	)

Asks a type for its name.

Parameters

type_tag	(I) The tag for the type
type_name	(OF) The name of the type

TCCORE_API int TCTYPE_ask_name_rule_patterns	(	const char *	boName,
		int *	n_propNames,
		char ***	propNames,
		int **	patternCountArray,
		int *	n_patterns,
		char ***	patterns
	)

Gets the relevant name rule patterns for the properties of a given type

Parameters

boName	(I) Name of the BusinessObject
n_propNames	(O) number of properties having name rule patterns, can be NULL
propNames	(OF) names of properties having name rule patterns, can be NULL
patternCountArray	(OF) array representing pattern count for each of the above properties, can be NULL
n_patterns	(O) total number of patterns for all the above properties, can be 0
patterns	(OF) all the patterns for all the above properties, can be NULL

TCCORE_API int TCTYPE_ask_object_type	(	tag_t	obj_tag,
		tag_t *	type_tag
	)

Asks an object for its type.

Parameters

obj_tag	(I) The tag of the object
type_tag	(O) The tag of the type

TCCORE_API int TCTYPE_ask_object_type_with_stubs	(	tag_t	obj_tag,
		tag_t *	type_tag
	)

Asks an object for its type. but honoring stubs as well

Parameters

obj_tag	(I) The tag of the object
type_tag	(O) The tag of the type

TCCORE_API int TCTYPE_ask_object_types	(	int	number_of_objects,
		const tag_t *	obj_tags,
		tag_t **	types
	)

Retrieves the types of an array of objects without loading them.

Returns: ITK_ok always

Note: If any of the input objects is invalid or NULLTAG, the corresponding entry in types will be NULLTAG.

Parameters

number_of_objects	(I) The number of objects in the input array
obj_tags	(I) The tags of the objects
types	(O) number_of_objects Object types

TCCORE_API int TCTYPE_ask_parent_type	(	tag_t	type_tag,
		tag_t *	parent_type_tag
	)

This function will return the parent type tag of a given type.

Parameters

type_tag	(I) a type tag
parent_type_tag	(O) a parent type tag that represents the parent type of the given type tag

TCCORE_API int TCTYPE_ask_property_by_display_name	(	tag_t	type_tag,
		const char *	disp_name,
		tag_t *	pd_tag
	)

Returns the property based on the specified type and the display name of the property for that type; returns PROP_not_found if unable to find property with the specified name.

Parameters

type_tag	(I) Tag of a type
disp_name	(I) Display name of the property
pd_tag	(O) Tag of the property

TCCORE_API int TCTYPE_ask_property_by_name	(	tag_t	type_tag,
		const char *	prop_name,
		tag_t *	pd_tag
	)

Asks a type for its property descriptor that has prop_name as its name.

Parameters

type_tag	(I) The tag of the type
prop_name	(I) The name of the property
pd_tag	(O) The tag of the property descriptor

TCCORE_API int TCTYPE_ask_revise_descriptor	(	tag_t	object_type_tag,
		tag_t *	revise_desc_tag
	)

Returns the ReviseInput Type object tag for the input type.

Parameters

object_type_tag	(I) The tag for the type
revise_desc_tag	(O) The tag for the revise descriptor

TCCORE_API int TCTYPE_ask_save_operation_context ( TCTYPE_save_operation_context_t * opEnmSvOprnCtxt )

Gets the context during a deferred save operation

Parameters

opEnmSvOprnCtxt (O) the context during a deferred save operation

TCCORE_API int TCTYPE_ask_saveas_descriptor	(	tag_t	objectTypeTag,
		tag_t *	saveAsDescTag
	)

Returns the SaveAsInput Type object tag for the input BO.

Parameters

objectTypeTag	(I)
saveAsDescTag	(O)

TCCORE_API int TCTYPE_ask_saveas_prop_descriptors	(	tag_t	saveasDescTag,
		int *	n_propDescTags,
		tag_t **	propDescTags
	)

Returns all the property descriptors and for the input SaveAsInput object type.

Parameters

saveasDescTag	(I)
n_propDescTags	(O)
propDescTags	(OF) n_propDescTags

TCCORE_API int TCTYPE_ask_subtypes	(	tag_t	type_tag,
		logical	forSameClassOnly,
		int *	numOfSubtypes,
		tag_t **	listOfSubtypes
	)

This function will return a list of subtypes of a given type. Note that forSameClassOnly is used to scope what the returned list of subtypes will include. If the value is "true", then the returned list of subtypes will include only subtypes that are created for the same class as for the given type. If the value is "false" and the given type is a primary type, then the returned list of subtypes will include subtypes for the same class as well as all types for each subclass of the class of the given type.

Parameters

type_tag	(I) a type tag
forSameClassOnly	(I) a flag indicating whether the scope of the search is limited to types for the same class
numOfSubtypes	(O) the number of types found
listOfSubtypes	(OF) numOfSubtypes

TCCORE_API int TCTYPE_ask_subtypes_with_exclusions	(	tag_t	type_tag,
		logical	for_same_class_only,
		int	n_exclusion_bo_names,
		const char **	exclusion_bo_names,
		int *	num_of_sub_types,
		tag_t **	list_of_sub_types
	)

Retrieves a list of subtypes for the given type. The given exclusion list is used to exclude the subtype names from the output.

Returns

ITK_ok on success
CXPOM_invalid_tag, if the type_tag is invalid.
TYPE_unknown_type, if The specified type does not exist.

Parameters

type_tag	(I) A type tag
for_same_class_only	(I) Flag indicating whether the scope of the search is limited to types of the same class
n_exclusion_bo_names	(I) Number of the Business Object names to be excluded from output
exclusion_bo_names	(I) Array of names for the Business Objects to be excluded from output
num_of_sub_types	(O) Number of found types
list_of_sub_types	(OF) num_of_sub_types Array of tags for the found subtypes

TCCORE_API int TCTYPE_ask_target_deepcopydata	(	tag_t	objectTag,
		int *	numAttachedObjs,
		tag_t **	deepCopyDataTags
	)

Returns the DeepCopyData tag for the input BO.

Parameters

objectTag	(I)
numAttachedObjs	(O)
deepCopyDataTags	(OF) numAttachedObjs

TCCORE_API int TCTYPE_ask_type	(	const char *	type_name,
		tag_t *	type_tag
	)

Retrieves the type tag from the provided type name.
If the type name is invalid, the value of the parameter #type_tag will be NULLTAG.

Returns: ITK_ok always, even of the type is not found.

Parameters

type_name	(I) The name of the type
type_tag	(O) The tag of the found type

TCCORE_API int TCTYPE_construct_create_input	(	tag_t	boTypeTag,
		tag_t *	createInputTag
	)

Constructs an CreateInput object for the input BO. Use this CreateInput object to hold input data for the creation of an object.

Parameters

boTypeTag	(I)
createInputTag	(O)

TCCORE_API int TCTYPE_construct_operationinput	(	tag_t	targetObjTypeTag,
		TCTYPE_operation_input_t	opvar,
		tag_t *	targetSaveAsInputTag
	)

Constructs an SaveAsInput object for the input BO. Use this SaveAsInput object to hold input data for the creation of an object.

Parameters

targetObjTypeTag	(I)
opvar	(I)
targetSaveAsInputTag	(O)

TCCORE_API int TCTYPE_construct_saveasinput	(	tag_t	boTypeTag,
		tag_t *	saveAsInputTag
	)

Constructs an SaveAsInput object for the input BO. Use this SaveAsInput object to hold input data for the creation of an object.

Parameters

boTypeTag	(I)
saveAsInputTag	(O)

TCCORE_API int TCTYPE_create_object	(	tag_t	creInputTag,
		tag_t *	boTag
	)

Creates an object according to the creation data in the CreateInput object

Parameters

creInputTag	(I)
boTag	(O)

TCCORE_API int TCTYPE_create_objects	(	int	n_bulks,
		int *	quantities,
		tag_t *	create_inputs,
		int *	n_objects,
		tag_t **	objects
	)

Creates objects of the given quantity for the specified types, according to the creation data in the CreateInput objects.
The supported types are Item, ItemRevision, Dataset and Form
If any error is detected, no objects will be created.

Note: The references to the created compound objects are cleared

Returns

ITK_ok on success
TCCORE_bulk_create_not_supported if the type of the object to create is not Item, ItemRevision, Dataset or Form
ITK_internal_error if the CreateInput object is invalid
Possibly other errors

Parameters

n_bulks	(I) Number of CreateInput objects
quantities	(I) n_bulks Array of number of objects to create for each CreateInput object
create_inputs	(I) n_bulks Array of CreateInput objects
n_objects	(O) Number of created objects
objects	(OF) n_objects Array of created objects

TCCORE_API int TCTYPE_create_single_objects	(	int	n_bulks,
		const tag_t *	create_inputs,
		int *	n_objects,
		tag_t **	objects
	)

Creates single objects of the specified types, according to the creation data in the CreateInput objects.
The supported types are Item, ItemRevision, Dataset and Form
If any error is detected, no objects will be created.

Returns

ITK_ok on success
TCCORE_bulk_create_not_supported if the type of the object to create is not Item, ItemRevision, Dataset or Form
Possibly other errors

Parameters

n_bulks	(I) Number of CreateInput objects
create_inputs	(I) Array of CreateInput objects
n_objects	(O) Number of objects created
objects	(OF) n_objects Array of objects created

TCCORE_API int TCTYPE_exit_module ( )

TCCORE_API int TCTYPE_extent	(	int *	number_of_types,
		tag_t **	type_tags
	)

Parameters

number_of_types	(O) The number of types found
type_tags	(OF) number_of_types The tags of the found types (NULL if none found)

TCCORE_API int TCTYPE_extent_by_category	(	TCTYPE_category_t	type_category,
		int *	number_of_types,
		tag_t **	type_tags
	)

Retrieves business object types for the specified type category.
If the category is #TCTYPE_ALL or #TC_TYPE_ROOT, it returns all the business object types of runtime, persistent and dynamic types.

Returns

ITK_ok on success
Possibly other POM errors coming from query executions to retrieve business objects from the database.

Parameters

type_category	(I) The type category
number_of_types	(O) The number of types found
type_tags	(OF) number_of_types The tags of the found types (NULL if none found)

TCCORE_API int TCTYPE_find_alltypes_for_class	(	const char *	class_name,
		int *	number_of_types,
		tag_t **	type_tags
	)

Parameters

class_name	(I)
number_of_types	(O)
type_tags	(OF) number_of_types

TCCORE_API int TCTYPE_find_displayable_business_objects	(	const char *	boName,
		int	n_exclusionBONames,
		const char **	exclusionBONames,
		int *	n_displayableTypeTags,
		tag_t **	displayableTypeTags
	)

Finds the types for the Business Object that are displayable to the login user in the object creation dialog.

Parameters

boName	(I) Name of the BusinessObject
n_exclusionBONames	(I) number of the BO names to be excluded;
exclusionBONames	(I) array of the BO names to be excluded
n_displayableTypeTags	(O) number of the displayable type tags
displayableTypeTags	(OF) n_displayableTypeTags array of the displayable type tags

TCCORE_API int TCTYPE_find_displayable_types_for_class	(	const char *	class_name,
		logical	include_subclasses,
		int *	number_of_types,
		tag_t **	type_tags
	)

Finds the types implemented by the given class that are displayable to the login user in the object creation dialog. If the value of include_subclasses is TRUE, then the function finds the displayable types implemented by the subclasses of the given class also.

Parameters

class_name	(I) Name of the class
include_subclasses	(I) TRUE: Find displayable types implemented by the given class and its subclasses FALSE: Find displayable types implemented by the given class only.
number_of_types	(O) The number of types found
type_tags	(OF) number_of_types Tags of the found types

TCCORE_API int TCTYPE_find_displayable_types_for_class_and_accessor	(	const char *	class_name,
		tag_t	accessor_tag,
		logical	include_subclasses,
		int *	number_of_types,
		tag_t **	type_tags
	)

Finds the types implemented by the given class that are displayable to the given accessor in the object creation dialog. If the value of include_subclasses is TRUE, then the function finds the displayable types implemented by the subclasses of the given class also.

Parameters

class_name	(I) Name of the class
accessor_tag	(I) Tag of the accessor (Group, Role-in-Group)
include_subclasses	(I) TRUE: Find displayable types, for the given accessor, implemented by the given class and its subclasses FALSE: Find displayable types, for the given accessor, implemented by the given class only.
number_of_types	(O) The number of types found
type_tags	(OF) number_of_types Tags of the found types

TCCORE_API int TCTYPE_find_hidden_types_for_class_and_accessor	(	const char *	class_name,
		tag_t	accessor_tag,
		logical	include_subclasses,
		int *	number_of_types,
		tag_t **	type_tags,
		TCTYPE_display_t **	details
	)

Finds the types implemented by the given class that are not displayable to the given accessor in the object creation dialog. If the value of include_subclasses is TRUE, then the function finds the non-displayable types (hidden types) implemented by the subclasses of the given class also.

Parameters

class_name	(I) Name of the class
accessor_tag	(I) Tag of the accessor ( Group, Role-in-Group )
include_subclasses	(I) TRUE: Find non-displayable types, for the given accessor, implemented by the given class and its subclasses FALSE: Find non-displayable types, for the given accessor, implemented by the given class only.
number_of_types	(O) The number of types found
type_tags	(OF) number_of_types Tags of the found types
details	(OF) number_of_types Tells if the type is non-displayable because of system-level rule or site-wide rule or parent-level rule or the rules defined at the given accessor level.

TCCORE_API int TCTYPE_find_type	(	const char *	type_name,
		const char *	class_name,
		tag_t *	type_tag
	)

Finds the type that has the type_name and class_name provided.

Returns: ITK_ok always, even of the type is not found.
The caller needs to check the value returned in the type_tag argument.

Parameters

type_name	(I) The name of the type
class_name	(I) The name of the class. A null or a wrong name is allowed. In that case, if a non-zero length type name is specified TCTYPE_find_type will search for the type tag for the given type name.
type_tag	(O) The tag of the found type (NULLTAG if not found)

TCCORE_API int TCTYPE_find_types_for_class	(	const char *	class_name,
		int *	number_of_types,
		tag_t **	type_tags
	)

Finds types implemented by the given class.

Parameters

class_name	(I) The name of the type
number_of_types	(O) The number of types found
type_tags	(OF) number_of_types The tags of the found types (NULL if none found)

TCCORE_API int TCTYPE_free_deepcopydata	(	int	numDeepCopyData,
		tag_t *	deepCopyDataTags
	)

Constructs an SaveAsInput object for the input BO. Use this SaveAsInput object to hold input data for the creation of an object.

Parameters

numDeepCopyData	(I)
deepCopyDataTags	(I)

TCCORE_API int TCTYPE_init_module ( )

Initializes the TCTYPE module. This function can be called in ITK_user_main before using any other TCTYPE module functions. Currently, it is called during Teamcenter startup and before installing types in the install_types utility.

TCCORE_API logical TCTYPE_is_extent_already_called ( )

Finds all types in the database.

TCCORE_API int TCTYPE_is_type_of	(	tag_t	type,
		tag_t	parent_type,
		logical *	answer
	)

Determines if a given type is the same as or a subtype of the input parent type.

Returns

ITK_ok on success
TYPE_unknown_type if any of the given types does not exist.

Parameters

type	(I) The tag for the type to compare
parent_type	(I) The tag for a parent type to check if type_tag is its subtype
answer	(O) Indicates if the `type` is the same as or subtype of the `parent_type`

TCCORE_API int TCTYPE_is_type_of_as_str	(	tag_t	type_tag,
		const char *	parent_type_name,
		logical *	answer
	)

Determines if a provided type (through argument #type_tag) is a sub-type of another one (parameter #parent_type_name).
The value of the parameter #answer will also be true if the two types are identical.

Returns

ITK_ok on success
TYPE_unknown_type if the specified type does not exist.

Parameters

type_tag	(I) The tag for the type
parent_type_name	(I) Parent type name
answer	(O) Flag indicating whether type_tag is of the same type as parent_type_name or one of its sub-types

TCCORE_API int TCTYPE_list_displayable_properties	(	tag_t	type_tag,
		int *	num,
		tag_t **	pd_tags
	)

Parameters

type_tag	(I)
num	(O)
pd_tags	(OF) num

TCCORE_API int TCTYPE_list_primary_rtypes	(	tag_t	primary_type,
		int *	n_rtypes,
		tag_t **	rtypes
	)

Lists all types of GRM relation which can have primary objects of this type. This is used to populate the Revision Information dialog box. The Revision Information dialog box displays all GRM relation types for a particular Item or Item Revision. You can then show or hide these in Workspace. This list is built up by finding all <rel_type_name>_relation_primary preferences that specify this type as a valid primary.

Parameters

primary_type	(I) Tag of the object type
n_rtypes	(O) Number of relation types
rtypes	(OF) n_rtypes Array of relation type tags

TCCORE_API int TCTYPE_list_properties	(	tag_t	type_tag,
		int *	num,
		tag_t **	pd_tags
	)

Asks a type for a list of the property descriptors that define it. If there is an error, num is set to 0 and pd_tags is set to NULL.

Parameters

type_tag	(I) The tag of the type
num	(O) The number of property descriptors returned
pd_tags	(OF) num The tags of the property descriptors that define the type

TCCORE_API int TCTYPE_load_all_delayed_types ( )

This function will load all delay types/classes

TCCORE_API int TCTYPE_property_exists	(	tag_t	type_tag,
		const char *	prop_name,
		logical *	verdict
	)

Returns verdict = true if the input property exists on the input type. It does not return PROP_not_found if the property is not found on the input type.

Returns

ITK_ok on success
TYPE_no_find_type, if the type_tag is invalid.
TYPE_unknown_type, if the specified type does not exist.
PROP_not_found, if the prop_name is NULL or empty string.

Parameters

type_tag	(I) The tag of the type
prop_name	(I) The name of the property
verdict	(O) Does the property exist

TCCORE_API int TCTYPE_refresh	(	tag_t	type_tag,
		logical	lock_or_not
	)

Refreshes a type that has been created.

Parameters

type_tag	(I) The tag for the type to refresh
lock_or_not	(I) Indicates whether to lock the type. True is yes.

TCCORE_API int TCTYPE_register_properties	(	USER_prop_init_entry_t *	user_types_methods,
		int	array_size
	)

Deprecated:: This function is deprecated and will be removed from Tc10. In Tc8.3 onwards, please register the properties from BMIDE.

This function is an internal call used in $TC_ROOT/sample/properties/user_init.c and is used to register the methods against the specified types (as indicated in user_types_methods in user_init.c) against message TCTYPE_init_user_props_msg. This function is only called in user_init.c and should not be used elsewhere. To register methods against a type, add an entry to the user_types_methods structure.

Parameters

user_types_methods	(I) Array is used for registering Methods that initialize properties on types. Add an entry in this array to indicate the object Type. The array should be terminated with a NULL entry.
array_size	(I) Size of the user_types_methods array

TCCORE_API int TCTYPE_revise_objects	(	int	num_target_objs,
		tag_t *	target_object_tags,
		tag_t *	revise_input_tags,
		int *	num_attached_objs,
		tag_t *	deepcopydata_tags,
		tag_t **	target_copy_tags,
		int **	ifails
	)

Revises the specified input objects according to the revise data in the ReviseInput objects and deep copies the attached objects based on the DeepCopyData provided.

This ITK always returns ITK_ok. It is necessary to check the returned ifails array to determine the error status of a particular object. Possible errors returned include

An error TCCORE_revise_not_supported (252082) will be returned if the target object is not configured to allow the revise operation.

An error ITEM_duplicate_rev (48038) will be returned if a revision with a requested revision id already exists.

Parameters

num_target_objs	(I) The number of objects to be revised
target_object_tags	(I) num_target_objs Array of target objects (objects being revised)
revise_input_tags	(I) num_target_objs Array of ReviseInput tags for the target objects, containing user input
num_attached_objs	(I) num_target_objs Array of ints in which the value of nth element in num_attached_objs is the number of the objects attached to nth element in target_object_tags
deepcopydata_tags	(I) Array of DeepCopyData tags for the attached objects
target_copy_tags	(OF) num_target_objs Array of tags of the revised objects
ifails	(OF) num_target_objs Array of ifail errors for the top-level target objects

TCCORE_API int TCTYPE_saveas_object	(	tag_t	targetObjectTag,
		tag_t	saveAsInputTag,
		int	numAttachedObjects,
		tag_t *	deepCopyDataTags,
		tag_t *	targetCopyTag
	)

Performs a SaveAs operation on the specified object according to the SaveAs data in the SaveAsInput objects and deep copies the attached objects based upon the DeepCopyData provided. DeepCopyData for an object may be null if no Deep Copy Rule is defined for its type.

Possible errors returned include

An error ITEM_create_id_gen_failed (48049) will be returned if the system is unable to generate a valid item ID.

An error METAFRAMEWORK_businessObj_creation_fail (236012) will be returned if the system is unable to create the object.

An exception will be thrown if invalid tags are provided in targetObjectTag or saveAsInputTag.

Parameters

targetObjectTag	(I) The tag of the target object (objects being saved)
saveAsInputTag	(I) The tag of the SaveAsInput for the target object, containing user input
numAttachedObjects	(I) The number of objects attached to the target object
deepCopyDataTags	(I) Array of DeepCopyData tags for the attached objects
targetCopyTag	(O) The tag of the copy of the top-level object saved

TCCORE_API int TCTYPE_set_create_display_value	(	tag_t	creInputTag,
		char *	propName,
		int	n_dispValues,
		const char **	dispValues
	)

Set display values for a property on CreateInput.

Parameters

creInputTag	(I)
propName	(I)
n_dispValues	(I) number of the secondary BOs to set display value on
dispValues	(I) array of the display values. Each display value is assigned to a secondary BO under propName n_displayValues is normally equal to 1. n_displayValues can be greater than 1 only if the property is VLA and multiple secondary BOs need to be created

TCCORE_API int TCTYPE_set_OperationInput_DisplayValue	(	tag_t	opInputTag,
		char *	propName,
		const char **	dispValues
	)

Deprecated:: This function is deprecated and will be removed from Tc13. From Tc10.1.4 onwards, please use type-safe AOM set ITK APIs such as AOM_set_value_string, and AOM_set_value_strings, or use C++ set APIs such as #setString and #setStringArray, based on the value-type of the property.

Sets display value(s) for a property on OperationInput type object. Only single array of char* for dispValues is supported (char *dispValues[1]). For single-valued properties, pointer to the display value is expected as input, while pointer to a string with comma-separated display values is expected as input for array-type properties.

Parameters

opInputTag	(I) The tag of the OperationInput type object
propName	(I) The name of the property
dispValues	(I) Pointer to the display value(s) to set for the `propName` property

TCCORE_API int TCTYPE_UIF_find_displayable_business_objects	(	const char *	boName,
		int	n_exclusionBONames,
		const char **	exclusionBONames,
		int *	n_displayableTypeTags,
		tag_t **	displayableTypeTags,
		char ***	typeNames,
		char ***	displayTypeNames
	)

Finds the types for the Business Object that are displayable to the login user in the object creation dialog. In addition we get the real and display type names for the displayable types for the connection locale.

Parameters

boName	(I) Name of the BusinessObject
n_exclusionBONames	(I) number of the BO names to be excluded;
exclusionBONames	(I) array of the BO names to be excluded
n_displayableTypeTags	(O) number of the displayable type tags
displayableTypeTags	(OF) n_displayableTypeTags array of the displayable type tags
typeNames	(OF) n_displayableTypeTags array of type names
displayTypeNames	(OF) n_displayableTypeTags array of display type names

TCCORE_API int TCTYPE_UIF_find_displayable_types_for_class	(	const char *	class_name,
		logical	include_subclasses,
		int *	number_of_types,
		tag_t **	type_tags,
		char ***	type_names,
		char ***	display_type_names
	)

Finds the types implemented by the given class that are displayable to the login user in the object creation dialog. If the value of include_subclasses is TRUE, then the function finds the displayable types implemented by the subclasses of the given class also. In addition we get the real and display type names for the displayable types for the connection locale.

Parameters

class_name	(I) Name of the class
include_subclasses	(I) TRUE: Find displayable types implemented by the given class and its subclasses FALSE: Find displayable types implemented by the given class only.
number_of_types	(O) The number of types found
type_tags	(OF) number_of_types Tags of the found types
type_names	(OF) number_of_types array of type names
display_type_names	(OF) number_of_types array of display type names

TCCORE_API int TCTYPE_UIF_find_generically_creatable_business_objects	(	const char *	bo_name,
		int	n_exclusion_bo_names,
		const char **	exclusion_bo_names,
		int *	n_displayable_type_tags,
		tag_t **	displayable_type_tags,
		char ***	type_names,
		char ***	display_type_names
	)

Finds the types for the Business Object that are displayable to the login user in object creation dialogs and configured in BMIDE to be displayed by generic create dialogs. Same as TCTYPE_UIF_find_displayable_business_objects except that it also excludes types on which the Fnd0EnableUsageOfDialog constant value on the CreateInput is false. Also gets the internal and display type names for the displayable types. The display names are in the server locale.

An error TYPE_unknown_type (39014) will be returned if the BusinessObject name provided is not that of a known type.

Parameters

bo_name	(I) Internal name of the Business Object
n_exclusion_bo_names	(I) Number of the BO names to be excluded from the returned types
exclusion_bo_names	(I) Array of the BO names to be excluded from the returned types
n_displayable_type_tags	(O) Number of the displayable type tags
displayable_type_tags	(OF) n_displayable_type_tags Array of the displayable type tags
type_names	(OF) n_displayable_type_tags Array of internal type names
display_type_names	(OF) n_displayable_type_tags Array of display type names

Modules

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation