T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
GRM ITK functions

All ITK functions of group GRM supported by T4x. More...

Functions

 GRM_create_relation_only_by_name HexPrimaryObjectTag HexSecondaryObjectTag RelationTypeName
 This function calls the ITK pipe server function GRM_create_relation_only_by_name to create a GRM relation between a primary and a secondary object for a given relation type name. More...
 
 GRM_delete_relation HexRelationTag
 This function calls the ITK pipe server function GRM_delete_relation to delete a GRM relation. More...
 
 GRM_delete_relation_only_by_name HexPrimaryObjectTag HexSecondaryObjectTag RelationTypeName
 This function calls the ITK pipe server function GRM_delete_relation_only_by_name to delete a GRM relation between a primary and a secondary object for a given relation type name. More...
 
 GRM_find_relation_type RelationTypeName
 This function calls the ITK pipe server function GRM_find_relation_type to retrieve the type tag of a given GRM relation type name. More...
 
 GRM_list_primary_objects_by_name HexTcObjectTag RelationTypeName
 This function calls the ITK pipe server function GRM_list_primary_objects to get a list of all primary objects and relations For each object: relationTag primaryObjTag secondaryObjTag relationTypeTag userDataTag for a given secondary object and GRM relation type name. More...
 
 GRM_list_primary_objects_only HexSecondaryObjectTag RelationTypeTag
 This function calls the ITK pipe server function GRM_list_primary_objects_only to get a list of all primary objects for a given secondary object and GRM relation type tag. If an empty string is provided as relation type tag, then primary objects for any relation type are retrieved. More...
 
 GRM_list_primary_objects_only_by_name HexTcObjectTag RelationTypeName
 This function calls the ITK pipe server function GRM_list_primary_objects_only to get a list of all primary objects for a given secondary object and GRM relation type name. More...
 
 GRM_list_relation_types_names
 This function calls the ITK pipe server function GRM_list_relation_types_names to get a list of all GRM relation type names. More...
 
 GRM_list_relations HexPrimaryObjectTag HexSecondaryObjectTag HexRelationTypeTag HexUserDataTag
 This function calls the ITK pipe server function GRM_list_relations to get a list of all relations objects for a given primary object and/or secondary object and/or GRM relation type tag and/or user data tag. More...
 
 GRM_list_relations_by_name HexPrimaryObjectTag HexSecondaryObjectTag RelationTypeName
 This function calls the ITK pipe server function GRM_list_relations_only_by_name to get a list of all relations objects for a given primary and/or secondary object and GRM relation type name. More...
 
 GRM_list_secondary_objects_only HexPrimaryObjectTag RelationTypeTag
 This function calls the ITK pipe server function GRM_list_secondary_objects_only to get a list of all secondary objects for a given primary object and GRM relation type tag. If an empty string is provided as relation type tag, then secodary objects for any relation type are retrieved. More...
 
 GRM_list_secondary_objects_only_by_name HexTcObjectTag RelationTypeName
 This function calls the ITK pipe server function GRM_list_secondary_objects_only_by_name to get a list of all secondary objects for a given primary object and GRM relation type name. More...
 

Detailed Description

All ITK functions of group GRM supported by T4x.

This group specifies all ITK functions of group GRM for which wrappers have been defined in T4x

Function Documentation

◆ GRM_create_relation_only_by_name()

ITK::GRM_create_relation_only_by_name   HexPrimaryObjectTag HexSecondaryObjectTag RelationTypeName  

This function calls the ITK pipe server function GRM_create_relation_only_by_name to create a GRM relation between a primary and a secondary object for a given relation type name.

Parameters
HexPrimaryObjectTagobject tag in the Tcl string format
HexSecondaryObjectTagObject tag in the Tcl string format
RelationTypeNamestring
Returns
List of ITK_ok (=0) and relation tag or list of ITK status and error message

Referenced by T4X::CUSTOM::MAPPING::TOOLBOX::importNamedReference().

◆ GRM_delete_relation()

ITK::GRM_delete_relation   HexRelationTag  

This function calls the ITK pipe server function GRM_delete_relation to delete a GRM relation.

Parameters
HexRelationTagrelation tag in the Tcl string format
Returns
ITK_ok (=0) or list of ITK status and error message

◆ GRM_delete_relation_only_by_name()

ITK::GRM_delete_relation_only_by_name   HexPrimaryObjectTag HexSecondaryObjectTag RelationTypeName  

This function calls the ITK pipe server function GRM_delete_relation_only_by_name to delete a GRM relation between a primary and a secondary object for a given relation type name.

Parameters
HexPrimaryObjectTag,objecttag in the Tcl string format
HexSecondaryObjectTag,objecttag in the Tcl string format
RelationTypeName,string
Returns
ITK_ok (=0) or list of ITK status and error message

◆ GRM_find_relation_type()

ITK::GRM_find_relation_type   RelationTypeName  

This function calls the ITK pipe server function GRM_find_relation_type to retrieve the type tag of a given GRM relation type name.

Parameters
RelationTypeNamerelation type name in the Tcl string format
Returns
ITK_ok (=0) and HexRelationTypeTag or list of ITK status and error message

◆ GRM_list_primary_objects_by_name()

ITK::GRM_list_primary_objects_by_name   HexTcObjectTag RelationTypeName  

This function calls the ITK pipe server function GRM_list_primary_objects to get a list of all primary objects and relations For each object: relationTag primaryObjTag secondaryObjTag relationTypeTag userDataTag for a given secondary object and GRM relation type name.

Parameters
HexTcObjectTagobject tag in the tcl string format
RelationTypeNamestring
Returns
List of ITK_ok (=0) and list of primary object data for each object a list of relationTag, PrimaryObjTag, secondaryObjtag, relationTypeTag and userDataTag or list of ITK status and error message

◆ GRM_list_primary_objects_only()

ITK::GRM_list_primary_objects_only   HexSecondaryObjectTag RelationTypeTag  

This function calls the ITK pipe server function GRM_list_primary_objects_only to get a list of all primary objects for a given secondary object and GRM relation type tag. If an empty string is provided as relation type tag, then primary objects for any relation type are retrieved.

Parameters
HexSecondaryObjectTagobject tag in the Tcl string format
RelationTypeTagrelation type tag in the Tcl string format
Returns
List of ITK_ok (=0) and HexPrimaryObjectTagList or list of ITK status and error message

◆ GRM_list_primary_objects_only_by_name()

ITK::GRM_list_primary_objects_only_by_name   HexTcObjectTag RelationTypeName  

This function calls the ITK pipe server function GRM_list_primary_objects_only to get a list of all primary objects for a given secondary object and GRM relation type name.

Parameters
HexTcObjectTagobject tag in the tcl string format
RelationTypeNamestring
Returns
List of ITK_ok (=0) and list of primary object tags or list of ITK status and error message

◆ GRM_list_relation_types_names()

ITK::GRM_list_relation_types_names

This function calls the ITK pipe server function GRM_list_relation_types_names to get a list of all GRM relation type names.

Returns
List of ITK_ok (=0) and list of found GRM relation type names or list of ITK status and error message

◆ GRM_list_relations()

ITK::GRM_list_relations   HexPrimaryObjectTag HexSecondaryObjectTag HexRelationTypeTag HexUserDataTag  

This function calls the ITK pipe server function GRM_list_relations to get a list of all relations objects for a given primary object and/or secondary object and/or GRM relation type tag and/or user data tag.

Parameters
HexPrimaryObjectTagobject tag in the Tcl string format, If "" is specified, NULLTAG is used
HexSecondaryObjectTagobject tag in the Tcl string format, If "" is specified, NULLTAG is used
HexRelationTypeTagobject tag in the Tcl string format, If "" is specified, NULLTAG is used
HexUserDataTagobject tag in the Tcl string format, If "" is specified, NULLTAG is used
Returns
List of ITK_ok (=0) and HexRelationTagList or list of ITK status and error message

◆ GRM_list_relations_by_name()

ITK::GRM_list_relations_by_name   HexPrimaryObjectTag HexSecondaryObjectTag RelationTypeName  

This function calls the ITK pipe server function GRM_list_relations_only_by_name to get a list of all relations objects for a given primary and/or secondary object and GRM relation type name.

Parameters
HexPrimaryObjectTagobject tag in the Tcl string format, If "" is specified, NULLTAG is used
HexSecondaryObjectTagobject tag in the Tcl string format, If "" is specified, NULLTAG is used
RelationTypeNamestring
Returns
List of ITK_ok (=0) and list of secondary object tags or list of ITK status and error message

◆ GRM_list_secondary_objects_only()

ITK::GRM_list_secondary_objects_only   HexPrimaryObjectTag RelationTypeTag  

This function calls the ITK pipe server function GRM_list_secondary_objects_only to get a list of all secondary objects for a given primary object and GRM relation type tag. If an empty string is provided as relation type tag, then secodary objects for any relation type are retrieved.

Parameters
HexPrimaryObjectTagobject tag in the Tcl string format
RelationTypeTagrelation type tag in the Tcl string format
Returns
List of ITK_ok (=0) and HexSecondaryObjectTagList or list of ITK status and error message

◆ GRM_list_secondary_objects_only_by_name()

ITK::GRM_list_secondary_objects_only_by_name   HexTcObjectTag RelationTypeName  

This function calls the ITK pipe server function GRM_list_secondary_objects_only_by_name to get a list of all secondary objects for a given primary object and GRM relation type name.

Parameters
HexTcObjectTagobject tag in the Tcl string format
RelationTypeNamestring
Returns
List of ITK_ok (=0) and list of secondary object tags or list of ITK status and error message

Referenced by ITK::getReleatedObjectTag2(), and T4X::CUSTOM::MAPPING::TOOLBOX::importNamedReference().