T4S4  19.1 C8540 A23673
Teamcenter Gateway for SAP S/4HANA API Reference
COLLABCTX ITK functions

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

Functions

 COLLABCTX_add_structure_context HexCCObjectTag HexSCObjectTag
 This function calls the ITK pipe server function COLLABCTX_add_structure_context to add an additional structure context to the given CCObject instance. More...
 
 COLLABCTX_ask_structure_contexts HexTcObjectTag
 This function calls the ITK pipe server function COLLABCTX_ask_structure_contexts to return all available structure contexts for the given CCObject instance. More...
 
 COLLABCTX_ccobj_ask_config_context HexTcObjectTag
 This function calls the ITK pipe server function COLLABCTX_ccobj_ask_config_context to return the ConfigurationContext for the given CCObject instance. More...
 
 COLLABCTX_ccobj_set_config_context HexTcObjectTag
 This function calls the ITK pipe server function COLLABCTX_ccobj_set_config_context to set the ConfigurationContext for the given CCObject instance. More...
 
 COLLABCTX_configuration_set_revisionrule HexContextContObjectTag
 This function calls the ITK pipe server function COLLABCTX_configuration_set_revisionrule to set the RevisionRule to ConfigurationContext. If Rule is a run time revision rule, we will: More...
 
 COLLABCTX_configuration_set_variantrule HexContextContObjectTag HexRuleTag
 This function calls the ITK pipe server function COLLABCTX_configuration_set_variantrule to set the BOMVariantRule to ConfigurationContext. More...
 
 COLLABCTX_context_add_content HexStructContObjectTag HexContextContObjectTag args
 This function calls the ITK pipe server function COLLABCTX_context_add_content to add content to the structure context instance. More...
 
 COLLABCTX_context_ask_config_context HexStructContObjectTag
 This function calls the ITK pipe server function COLLABCTX_context_ask_config_context to returns the configuration context used by the structure context instance. More...
 
 COLLABCTX_context_ask_contents HexStructContObjectTag
 This function calls the ITK pipe server function COLLABCTX_context_ask_contents to returns all the components used by the structure context instance. More...
 
 COLLABCTX_context_set_config_context HexSCObjectTag HexConfContObjectTag
 This function calls the ITK pipe server function COLLABCTX_context_set_config_context to set ConfigurationContext of the structure context instance. More...
 
 COLLABCTX_copy_ccobject CCTypeName NewName NewDescription
 This function calls the ITK pipe server function COLLABCTX_copy_ccobject to create a new CCObject instance based on an existing CCObject instance. More...
 
 COLLABCTX_create_ccobject CCTypeName NewName NewDescription
 This function calls the ITK pipe server function COLLABCTX_create_ccobject to create a new CCObject instance. More...
 
 COLLABCTX_create_configuration_context ConfConextTypeName NewName NewDescription
 This function calls the ITK pipe server function COLLABCTX_create_configuration_context to create a new configuration context instance. More...
 
 COLLABCTX_create_structure_context SCTypeName NewName NewDescription
 This function calls the ITK pipe server function COLLABCTX_create_structure_context to create a new structure context instance. More...
 

Detailed Description

All ITK functions of group COLLABCTX supported by T4x.

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

Function Documentation

◆ COLLABCTX_add_structure_context()

ITK::COLLABCTX_add_structure_context   HexCCObjectTag HexSCObjectTag  

This function calls the ITK pipe server function COLLABCTX_add_structure_context to add an additional structure context to the given CCObject instance.

Parameters
HexCCObjectTagCCObject instance tag
HexSCObjectTagstructure context tag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ COLLABCTX_ask_structure_contexts()

ITK::COLLABCTX_ask_structure_contexts   HexTcObjectTag  

This function calls the ITK pipe server function COLLABCTX_ask_structure_contexts to return all available structure contexts for the given CCObject instance.

Parameters
HexTcObjectTagCCObject instance tag
Returns
ITK_ok (=0) and list of structure context tags or list of ITK status and error message

◆ COLLABCTX_ccobj_ask_config_context()

ITK::COLLABCTX_ccobj_ask_config_context   HexTcObjectTag  

This function calls the ITK pipe server function COLLABCTX_ccobj_ask_config_context to return the ConfigurationContext for the given CCObject instance.

Parameters
HexTcObjectTagCCObject instance tag
Returns
ITK_ok (=0) and ConfigurationContext tag or list of ITK status and error message

◆ COLLABCTX_ccobj_set_config_context()

ITK::COLLABCTX_ccobj_set_config_context   HexTcObjectTag  

This function calls the ITK pipe server function COLLABCTX_ccobj_set_config_context to set the ConfigurationContext for the given CCObject instance.

Parameters
HexTcObjectTagCCObject instance tag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ COLLABCTX_configuration_set_revisionrule()

ITK::COLLABCTX_configuration_set_revisionrule   HexContextContObjectTag  

This function calls the ITK pipe server function COLLABCTX_configuration_set_revisionrule to set the RevisionRule to ConfigurationContext. If Rule is a run time revision rule, we will:

if context already has private rule, replace the entries of the private rule otherwise, clone the input rule and save it as private rule to the context.

Parameters
HexContextContObjectTag,configurationcontext tag
HexRuleTag,revisionrule tag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ COLLABCTX_configuration_set_variantrule()

ITK::COLLABCTX_configuration_set_variantrule   HexContextContObjectTag HexRuleTag  

This function calls the ITK pipe server function COLLABCTX_configuration_set_variantrule to set the BOMVariantRule to ConfigurationContext.

If BOMVariantRule has set_variant_rule and not modified, just set set_variant_rule to context If BOMVariantRule has set_variant_rule and modified, save set_variant_rule and set set_variant_rule If BOMVariantRule does not have set_variant_rule, create set_variant_rule and set to context

Note: We take BOMVariantRule, not VariantRule itself !!

Parameters
HexContextContObjectTagconfiguration context tag
HexRuleTagrevision rule tag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ COLLABCTX_context_add_content()

ITK::COLLABCTX_context_add_content   HexStructContObjectTag HexContextContObjectTag args  

This function calls the ITK pipe server function COLLABCTX_context_add_content to add content to the structure context instance.

Parameters
HexStructContObjectTagconfiguration context tag
HexContextContObjectTagcontent tag Note: Content can be an Item, an ItemRevision or an AppearanceGroup.
args(optional), subType default = 0, for more information consult the the ITK functions documentation.
Returns
ITK_ok (=0) or list of ITK status and error message

◆ COLLABCTX_context_ask_config_context()

ITK::COLLABCTX_context_ask_config_context   HexStructContObjectTag  

This function calls the ITK pipe server function COLLABCTX_context_ask_config_context to returns the configuration context used by the structure context instance.

Parameters
HexStructContObjectTagconfiguration context tag
Returns
List of ITK_ok (=0) and configuration context tag or list of ITK status and error message

◆ COLLABCTX_context_ask_contents()

ITK::COLLABCTX_context_ask_contents   HexStructContObjectTag  

This function calls the ITK pipe server function COLLABCTX_context_ask_contents to returns all the components used by the structure context instance.

Parameters
HexStructContObjectTagcontent tag Note: Content can be an Item, an ItemRevision or an AppearanceGroup.
Returns
List of ITK_ok (=0) and list of found all the component tags or list of ITK status and error message

◆ COLLABCTX_context_set_config_context()

ITK::COLLABCTX_context_set_config_context   HexSCObjectTag HexConfContObjectTag  

This function calls the ITK pipe server function COLLABCTX_context_set_config_context to set ConfigurationContext of the structure context instance.

Parameters
HexSCObjectTagstructure context tag
HexConfContObjectTagconfiguration context tag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ COLLABCTX_copy_ccobject()

ITK::COLLABCTX_copy_ccobject   CCTypeName NewName NewDescription  

This function calls the ITK pipe server function COLLABCTX_copy_ccobject to create a new CCObject instance based on an existing CCObject instance.

Parameters
SourceCCObjectTag
NewName
NewDescription
Returns
ITK_ok (=0) and new CCObject instance tag or list of ITK status and error message

◆ COLLABCTX_create_ccobject()

ITK::COLLABCTX_create_ccobject   CCTypeName NewName NewDescription  

This function calls the ITK pipe server function COLLABCTX_create_ccobject to create a new CCObject instance.

Parameters
CCTypeName
NewName
NewDescription
Returns
ITK_ok (=0) and new CCObject instance tag or list of ITK status and error message

◆ COLLABCTX_create_configuration_context()

ITK::COLLABCTX_create_configuration_context   ConfConextTypeName NewName NewDescription  

This function calls the ITK pipe server function COLLABCTX_create_configuration_context to create a new configuration context instance.

Parameters
ConfConextTypeNameconfiguration context type name
NewNamenew configuration context name
NewDescriptionnew configuration context description
Returns
List of ITK_ok (=0) and new configuration context tag or list of ITK status and error message

◆ COLLABCTX_create_structure_context()

ITK::COLLABCTX_create_structure_context   SCTypeName NewName NewDescription  

This function calls the ITK pipe server function COLLABCTX_create_structure_context to create a new structure context instance.

Parameters
SCTypeNamestructure context type name
NewNamenew structure context name
NewDescriptionnew structure context description
Returns
ITK_ok (=0) and new structure context tag or list of ITK status and error message