IDM

Macros
#define	IDM_attachment_rel   6
#define	IDM_bom_view_rel   7
#define	IDM_bvr_rel   8
#define	IDM_item_master_rel   1
#define	IDM_manifestation_rel   2
#define	IDM_requirements_rel   3
#define	IDM_revisions_rel   4
#define	IDM_specification_rel   5

Functions
TCCORE_API int	IDM_add_item_related (tag_t item, int relation, tag_t related_object)
TCCORE_API int	IDM_ask_item_id (tag_t item, char item_id[WSO_name_size_c+1])
TCCORE_API int	IDM_ask_item_related (tag_t item, int relation, int *count, tag_t **related_objects)
TCCORE_API int	IDM_create_item (const char *item_id, const char *item_name, const char *item_description, const char *revision_id, const char *revision_name, tag_t *new_item, tag_t *new_item_revision)
TCCORE_API int	IDM_exit_module (void)
TCCORE_API int	IDM_find_item (const char *item_id, tag_t *item)
TCCORE_API int	IDM_init_module (void)
TCCORE_API int	IDM_initialize_item (tag_t item, const char *item_id, const char *item_name, const char *item_description, const char *revision_id, const char *revision_name)
TCCORE_API int	IDM_item_extent (int *n_instances, tag_t **instances)
TCCORE_API int	IDM_remove_item_related (tag_t item, int relation, tag_t related_object)

Item Revision ITK
TCCORE_API int	IDM_initialize_item_revision (tag_t item_revision, const char *revision_id, const char *revision_name, const char *revision_desc, tag_t item)
TCCORE_API int	IDM_item_revision_extent (int *n_instances, tag_t **instances)
TCCORE_API int	IDM_find_item_revision (const char *item_id, const char *revision_id, tag_t *item_revision)
TCCORE_API int	IDM_copy_item_revision (tag_t item_revision, const char *new_revision_id, tag_t *new_item_revision)
TCCORE_API int	IDM_ask_revision_id (tag_t item_revision, char revision_id[WSO_name_size_c+1])
TCCORE_API int	IDM_ask_item (tag_t item_revision, tag_t *item)
TCCORE_API int	IDM_ask_revision_related (tag_t item_revision, int relation, int *count, tag_t **related_objects)
TCCORE_API int	IDM_add_revision_related (tag_t item_revision, int relation, tag_t related_object)
TCCORE_API int	IDM_remove_revision_related (tag_t item_revision, int relation, tag_t related_object)

Detailed Description

Macro Definition Documentation

#define IDM_attachment_rel   6

Definition at line 119 of file idm.h.

#define IDM_bom_view_rel   7

Definition at line 120 of file idm.h.

#define IDM_bvr_rel   8

A relationship of Item Revisions only

Definition at line 123 of file idm.h.

#define IDM_item_master_rel   1

Definition at line 114 of file idm.h.

#define IDM_manifestation_rel   2

Definition at line 115 of file idm.h.

#define IDM_requirements_rel   3

Definition at line 116 of file idm.h.

#define IDM_revisions_rel   4

Definition at line 117 of file idm.h.

#define IDM_specification_rel   5

Definition at line 118 of file idm.h.

Function Documentation

TCCORE_API int IDM_add_item_related	(	tag_t	item,
		int	relation,
		tag_t	related_object
	)

DEPRECATED FUNCTION

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_create_relation, followed by AOM_save to commit the resulting relation object to the database, then AOM_unlock to release its write lock.

Parameters

item	(I)
relation	(I)
related_object	(I)

TCCORE_API int IDM_add_revision_related	(	tag_t	item_revision,
		int	relation,
		tag_t	related_object
	)

DEPRECATED FUNCTION

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_create_relation, followed by AOM_save to commit the resulting relation object to the database, then AOM_unlock to release its write lock.

Parameters

item_revision	(I)
relation	(I)
related_object	(I)

TCCORE_API int IDM_ask_item	(	tag_t	item_revision,
		tag_t *	item
	)

DEPRECATED FUNCTION

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. Use ITEM_ask_item_of_rev instead.

Parameters

item_revision	(I)
item	(O)

TCCORE_API int IDM_ask_item_id	(	tag_t	item,
		char	item_id[WSO_name_size_c+1]
	)

DEPRECATED FUNCTION

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. Use ITEM_ask_id instead.

Parameters

item	(I)
item_id	(O)

TCCORE_API int IDM_ask_item_related	(	tag_t	item,
		int	relation,
		int *	count,
		tag_t **	related_objects
	)

DEPRECATED FUNCTION

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_list_secondary_objects_only, passing relation type tag equivalent to relation.

Parameters

item	(I)
relation	(I)
count	(O)
related_objects	(OF) count

TCCORE_API int IDM_ask_revision_id	(	tag_t	item_revision,
		char	revision_id[WSO_name_size_c+1]
	)

DEPRECATED FUNCTION

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. Use ITEM_ask_rev_id instead.

Parameters

item_revision	(I)
revision_id	(O)

TCCORE_API int IDM_ask_revision_related	(	tag_t	item_revision,
		int	relation,
		int *	count,
		tag_t **	related_objects
	)

DEPRECATED FUNCTION

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_list_secondary_objects_only, passing relation type tag equivalent to relation.

Parameters

item_revision	(I)
relation	(I)
count	(O)
related_objects	(OF) count

TCCORE_API int IDM_copy_item_revision	(	tag_t	item_revision,
		const char *	new_revision_id,
		tag_t *	new_item_revision
	)

DEPRECATED FUNCTION

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. Use ITEM_copy_rev instead.

Parameters

item_revision	(I)
new_revision_id	(I)
new_item_revision	(O)

TCCORE_API int IDM_create_item	(	const char *	item_id,
		const char *	item_name,
		const char *	item_description,
		const char *	revision_id,
		const char *	revision_name,
		tag_t *	new_item,
		tag_t *	new_item_revision
	)

DEPRECATED FUNCTION

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use ITEM_create_item, followed by ITEM_set_description(item_description) and ITEM_set_rev_description(item_description), and ITEM_set_rev_name(revision_name). Finally call AOM_save for the new item and item rev.

Parameters

item_id	(I)
item_name	(I)
item_description	(I)
revision_id	(I)
revision_name	(I)
new_item	(O)
new_item_revision	(O)

TCCORE_API int IDM_exit_module

(

void

)

DEPRECATED FUNCTION

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. No replacement is required.

TCCORE_API int IDM_find_item	(	const char *	item_id,
		tag_t *	item
	)

DEPRECATED FUNCTION

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. Use ITEM_find_item instead.

Parameters

item_id	(I)
item	(O)

TCCORE_API int IDM_find_item_revision	(	const char *	item_id,
		const char *	revision_id,
		tag_t *	item_revision
	)

DEPRECATED FUNCTION

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. Use ITEM_find_rev instead.

Parameters

item_id	(I)
revision_id	(I)
item_revision	(O)

TCCORE_API int IDM_init_module

(

void

)

DEPRECATED FUNCTION

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. No replacement is required; the ITEM module is automatically initialized.

TCCORE_API int IDM_initialize_item	(	tag_t	item,
		const char *	item_id,
		const char *	item_name,
		const char *	item_description,
		const char *	revision_id,
		const char *	revision_name
	)

DEPRECATED FUNCTION

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use ITEM_set_id(item,item_id), ITEM_set_name(item,item_name) and ITEM_set_description(item,item_description). Save item using AOM_save. Then use ITEM_find_rev(item_id,revision_id) to locate the revision, and call ITEM_set_rev_name to set revision_name.

Parameters

item	(I)
item_id	(I)
item_name	(I)
item_description	(I)
revision_id	(I)
revision_name	(I)

TCCORE_API int IDM_initialize_item_revision	(	tag_t	item_revision,
		const char *	revision_id,
		const char *	revision_name,
		const char *	revision_desc,
		tag_t	item
	)

DEPRECATED FUNCTION

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use ITEM_set_rev_id, ITEM_set_rev_name and ITEM_set_rev_description.

Parameters

item_revision	(I)
revision_id	(I)
revision_name	(I)
revision_desc	(I)
item	(I)

TCCORE_API int IDM_item_extent	(	int *	n_instances,
		tag_t **	instances
	)

DEPRECATED FUNCTION Lists all Items in the database.

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use POM_instances_of_class(ITEM_item_class_name_c,true).

Parameters

n_instances	(O)
instances	(OF) n_instances

TCCORE_API int IDM_item_revision_extent	(	int *	n_instances,
		tag_t **	instances
	)

DEPRECATED FUNCTION Lists all Item Revisions in the database.

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use POM_instances_of_class(ITEM_rev_class_name_c,true).

Parameters

n_instances	(O)
instances	(OF) n_instances

TCCORE_API int IDM_remove_item_related	(	tag_t	item,
		int	relation,
		tag_t	related_object
	)

DEPRECATED FUNCTION

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_find_relation to locate the relation object (passing relation_type equivalent to relation), then delete the relation using AOM_delete.

Parameters

item	(I)
relation	(I)
related_object	(I)

TCCORE_API int IDM_remove_revision_related	(	tag_t	item_revision,
		int	relation,
		tag_t	related_object
	)

DEPRECATED FUNCTION

Deprecated:

This function is deprecated, it will be removed from Teamcenter V12.0. In its place, use GRM_find_relation to locate the relation object (passing relation_type equivalent to relation), then delete the relation using AOM_delete.

Parameters

item_revision	(I)
relation	(I)
related_object	(I)