You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

869 lines
35 KiB

//Copyright 2020 Siemens Digital Industries Software
//==================================================
//Copyright $2020.
//Siemens Product Lifecycle Management Software Inc.
//All Rights Reserved.
//==================================================
//Copyright 2020 Siemens Digital Industries Software
/*==================================================================================================
File description:
This file contains the declaration for the Business Object, BOMLineDelegate
Filename: BOMLineDelegate.hxx
Module: bom
@BMIDE autogenerated
==================================================================================================*/
#ifndef TEAMCENTER__BOMLINEDELEGATE_HXX
#define TEAMCENTER__BOMLINEDELEGATE_HXX
#include <common/tc_deprecation_macros.h>
#include <bom/BOMLine.hxx>
#include <bom/libbom_exports.h>
namespace Teamcenter
{
class BOMLineDelegate;
}
namespace Teamcenter
{
class BOMLineImpl;
}
namespace Teamcenter
{
class BOMLine;
}
namespace Teamcenter
{
class BOMLineGenImpl;
}
namespace Teamcenter_alias = ::Teamcenter;
class BOM_API Teamcenter_alias::BOMLineDelegate
{
public:
// Method to initialize this Class
static int initializeClass();
// Method to get the BOMLineDelegate instance
static BOMLineDelegate& getInstance();
// Method to delete the BOMLineImpl pointer
static void deleteImpl( BOMLineImpl* impl );
///
/// Getter for a Boolean Property
/// @version Teamcenter 8.1
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getBl_has_attached_notesBase(const BOMLine &ifObj, bool &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Tc 8
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getBl_jt_hint_contentsBase(const BOMLine &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for an Integer Property
/// @version Teamcenter 8.1
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getBl_occ_int_order_noBase(const BOMLine &ifObj, int &value, bool &isNull ) const;
///
/// Getter for an String Array Property
/// @version Teamcenter 11.4
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getBl_physical_attach_childrenBase(const BOMLine &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const;
///
/// Getter for an String Array Property
/// @version Teamcenter 11.4
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getBl_physical_attach_mfg0BiDirectionalBase(const BOMLine &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const;
///
/// Getter for an String Array Property
/// @version Teamcenter 11.4
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getBl_physical_attach_mfg0RelationTypeNameBase(const BOMLine &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const;
///
/// Getter for an String Array Property
/// @version Teamcenter 11.4
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getBl_physical_attach_mfg0RelToOriginBase(const BOMLine &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const;
///
/// Getter for an String Array Property
/// @version Teamcenter 11.4
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getBl_physical_attach_mfg0SourceIDBase(const BOMLine &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const;
///
/// Getter for an String Array Property
/// @version Teamcenter 11.4
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getBl_physical_attach_mfg0SourceIDFormatTypeBase(const BOMLine &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const;
///
/// Getter for an String Array Property
/// @version Teamcenter 11.4
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getBl_physical_attach_mfg0TargetIDBase(const BOMLine &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const;
///
/// Getter for an String Array Property
/// @version Teamcenter 11.4
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getBl_physical_attach_mfg0TargetIDFormatTypeBase(const BOMLine &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const;
///
/// Getter for an String Array Property
/// @version Teamcenter 11.4
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getBl_physical_attach_mfg0TCPFPositionBase(const BOMLine &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const;
///
/// Getter for an Integer Array Property
/// @version Teamcenter 11.2.2
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getBl_resource_colorBase(const BOMLine &ifObj, std::vector< int > &values, std::vector< int > &isNull ) const;
///
/// Getter for a Boolean Property
/// @version Teamcenter 8.1
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getBl_window_is_BOPWinBase(const BOMLine &ifObj, bool &value, bool &isNull ) const;
///
/// Getter for an String Array Property
/// @version Teamcenter 11.5
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getFnd0AssignedToProcessBase(const BOMLine &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const;
///
/// Getter for a string Property
/// @version Teamcenter 8.3
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0bl_ac_check_resultBase(const BOMLine &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Teamcenter 8.2
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getFnd0bl_active_changesBase(const BOMLine &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for a Tag Property
/// @version Teamcenter 8.2
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0bl_active_markupBase(const BOMLine &ifObj, tag_t &value, bool &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Teamcenter 11.6
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getFnd0bl_alternate_groupsBase(const BOMLine &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for an String Array Property
/// @version Teamcenter 8.3
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getFnd0bl_assigned_asBase(const BOMLine &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const;
///
/// Getter for an Integer Property
/// @version Teamcenter 11.1
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0bl_closurerule_stateBase(const BOMLine &ifObj, int &value, bool &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Teamcenter 9
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getFnd0bl_complying_objectsBase(const BOMLine &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for an Integer Property
/// @version Teamcenter 11.1
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0bl_configured_outBase(const BOMLine &ifObj, int &value, bool &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Teamcenter 9
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getFnd0bl_defining_objectsBase(const BOMLine &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for a Boolean Property
/// @version Teamcenter 8.2
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0bl_has_active_markupBase(const BOMLine &ifObj, bool &value, bool &isNull ) const;
///
/// Getter for a Boolean Property
/// @version Teamcenter 11.6
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0bl_has_alternate_groupBase(const BOMLine &ifObj, bool &value, bool &isNull ) const;
///
/// Getter for an Integer Property
/// @version Teamcenter 9
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0bl_has_trace_linkBase(const BOMLine &ifObj, int &value, bool &isNull ) const;
///
/// Getter for an Integer Property
/// @version Teamcenter 10.1
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0bl_is_mono_overrideBase(const BOMLine &ifObj, int &value, bool &isNull ) const;
///
/// Getter for a Boolean Property
/// @version Teamcenter 10.1
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0bl_is_mono_presentBase(const BOMLine &ifObj, bool &value, bool &isNull ) const;
///
/// Getter for a Boolean Property
/// @version Teamcenter 10.1
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0bl_is_substituteBase(const BOMLine &ifObj, bool &value, bool &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Teamcenter 8.2
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getFnd0bl_markup_add_objsBase(const BOMLine &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for an String Array Property
/// @version Teamcenter 8.2
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getFnd0bl_markup_prop_namesBase(const BOMLine &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const;
///
/// Getter for an String Array Property
/// @version Teamcenter 8.2
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getFnd0bl_markup_prop_valuesBase(const BOMLine &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const;
///
/// Getter for a Tag Property
/// @version Teamcenter 8.2
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0bl_markup_replace_objBase(const BOMLine &ifObj, tag_t &value, bool &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Teamcenter 8.2
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getFnd0bl_markup_subs_objs_addBase(const BOMLine &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Teamcenter 8.2
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getFnd0bl_markup_subs_objs_delBase(const BOMLine &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for an Integer Property
/// @version Teamcenter 8.2
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0bl_markup_typeBase(const BOMLine &ifObj, int &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Teamcenter 8.3
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0bl_real_quantityBase(const BOMLine &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Teamcenter 10.1
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0bl_sub_id_compareBase(const BOMLine &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Teamcenter 10.1
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0bl_sub_name_compareBase(const BOMLine &ifObj, std::string &value, bool &isNull ) const;
///
/// Getter for a Tag Array Property
/// @version Teamcenter 11.6
/// @param values - Parameter value
/// @param isNull - Returns true for an array element if the parameter value at that location is null
/// @return - Status. 0 if successful
///
int getFnd0bl_substitute_groupsBase(const BOMLine &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for a Boolean Property
/// @version Teamcenter 11.5
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0HasReflectionBase(const BOMLine &ifObj, bool &value, bool &isNull ) const;
///
/// Getter for a Boolean Property
/// @version Teamcenter 11.2.3
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0IsConfiguredForNetEffBase(const BOMLine &ifObj, bool &value, bool &isNull ) const;
///
/// Getter for a Tag Property
/// @version Teamcenter 12.2
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0OccurrenceRevisionBase(const BOMLine &ifObj, tag_t &value, bool &isNull ) const;
///
/// Getter for a string Property
/// @version Teamcenter 11.2.3
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0UnitNetEffectivityBase(const BOMLine &ifObj, std::string &value, bool &isNull ) const;
///
/// Setter for a Tag Array Property
/// @version Teamcenter 8.1
/// @param values - Values to be set for the parameter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setBl_occ_effectivityBase(BOMLine &ifObj, const std::vector< tag_t > &values, const std::vector< int > *isNull );
///
/// Setter for an Integer Property
/// @version Teamcenter 8.1
/// @param value - Value to be set for the parameter
/// @param isNull - If true, set the parameter value to null
/// @return - Status. 0 if successful
///
int setBl_occ_int_order_noBase(BOMLine &ifObj, int value, bool isNull );
///
/// Setter for an string Array Property
/// @version Teamcenter 11.4
/// @param values - Values to be set for the parameter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setBl_physical_attach_childrenBase(BOMLine &ifObj, const std::vector< std::string > &values, const std::vector< int > *isNull );
///
/// Setter for an string Array Property
/// @version Teamcenter 11.4
/// @param values - Values to be set for the parameter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setBl_physical_attach_mfg0BiDirectionalBase(BOMLine &ifObj, const std::vector< std::string > &values, const std::vector< int > *isNull );
///
/// Setter for an string Array Property
/// @version Teamcenter 11.4
/// @param values - Values to be set for the parameter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setBl_physical_attach_mfg0RelationTypeNameBase(BOMLine &ifObj, const std::vector< std::string > &values, const std::vector< int > *isNull );
///
/// Setter for an string Array Property
/// @version Teamcenter 11.4
/// @param values - Values to be set for the parameter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setBl_physical_attach_mfg0RelToOriginBase(BOMLine &ifObj, const std::vector< std::string > &values, const std::vector< int > *isNull );
///
/// Setter for an string Array Property
/// @version Teamcenter 11.4
/// @param values - Values to be set for the parameter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setBl_physical_attach_mfg0SourceIDBase(BOMLine &ifObj, const std::vector< std::string > &values, const std::vector< int > *isNull );
///
/// Setter for an string Array Property
/// @version Teamcenter 11.4
/// @param values - Values to be set for the parameter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setBl_physical_attach_mfg0SourceIDFormatTypeBase(BOMLine &ifObj, const std::vector< std::string > &values, const std::vector< int > *isNull );
///
/// Setter for an string Array Property
/// @version Teamcenter 11.4
/// @param values - Values to be set for the parameter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setBl_physical_attach_mfg0TargetIDBase(BOMLine &ifObj, const std::vector< std::string > &values, const std::vector< int > *isNull );
///
/// Setter for an string Array Property
/// @version Teamcenter 11.4
/// @param values - Values to be set for the parameter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setBl_physical_attach_mfg0TargetIDFormatTypeBase(BOMLine &ifObj, const std::vector< std::string > &values, const std::vector< int > *isNull );
///
/// Setter for an string Array Property
/// @version Teamcenter 11.4
/// @param values - Values to be set for the parameter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setBl_physical_attach_mfg0TCPFPositionBase(BOMLine &ifObj, const std::vector< std::string > &values, const std::vector< int > *isNull );
///
/// Setter for a string Property
/// @version Teamcenter 9
/// @param value - Value to be set for the parameter
/// @param isNull - If true, set the parameter value to null
/// @return - Status. 0 if successful
///
int setBl_quantityBase(BOMLine &ifObj, const std::string &value, bool isNull );
///
/// Setter for an Integer Array Property
/// @version Teamcenter 11.2.2
/// @param values - Values to be set for the paramter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setBl_resource_colorBase(BOMLine &ifObj, const std::vector< int > &values, const std::vector< int > *isNull );
///
/// Setter for a string Property
/// @version Teamcenter 9
/// @param value - Value to be set for the parameter
/// @param isNull - If true, set the parameter value to null
/// @return - Status. 0 if successful
///
int setBl_sequence_noBase(BOMLine &ifObj, const std::string &value, bool isNull );
///
/// Setter for a string Property
/// @version Teamcenter 8.3
/// @param value - Value to be set for the parameter
/// @param isNull - If true, set the parameter value to null
/// @return - Status. 0 if successful
///
int setFnd0bl_ac_check_resultBase(BOMLine &ifObj, const std::string &value, bool isNull );
///
/// Setter for a Tag Array Property
/// @version Teamcenter 8.2
/// @param values - Values to be set for the parameter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setFnd0bl_active_changesBase(BOMLine &ifObj, const std::vector< tag_t > &values, const std::vector< int > *isNull );
///
/// Setter for a Tag Property
/// @version Teamcenter 8.2
/// @param value - Value to be set for the parameter
/// @param isNull - If true, set the parameter value to null
/// @return - Status. 0 if successful
///
int setFnd0bl_active_markupBase(BOMLine &ifObj, const tag_t &value, bool isNull );
///
/// Setter for a Tag Array Property
/// @version Teamcenter 11.6
/// @param values - Values to be set for the parameter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setFnd0bl_alternate_groupsBase(BOMLine &ifObj, const std::vector< tag_t > &values, const std::vector< int > *isNull );
///
/// Setter for a Boolean Property
/// @version Teamcenter 8.2
/// @param value - Value to be set for the parameter
/// @param isNull - If true, set the parameter value to null
/// @return - Status. 0 if successful
///
int setFnd0bl_has_active_markupBase(BOMLine &ifObj, bool value, bool isNull );
///
/// Setter for an Integer Property
/// @version Teamcenter 10.1
/// @param value - Value to be set for the parameter
/// @param isNull - If true, set the parameter value to null
/// @return - Status. 0 if successful
///
int setFnd0bl_is_mono_overrideBase(BOMLine &ifObj, int value, bool isNull );
///
/// Setter for a Tag Array Property
/// @version Teamcenter 11.6
/// @param values - Values to be set for the parameter
/// @param isNull - If array element is true, set the parameter value at that location as null
/// @return - Status. 0 if successful
///
int setFnd0bl_substitute_groupsBase(BOMLine &ifObj, const std::vector< tag_t > &values, const std::vector< int > *isNull );
///
/// This operation is defined for implementation pre and post assign actions.
/// @version Teamcenter 10.1
/// @param sourceLine - Source line
/// @param occType - Occurrence type.
/// @param newChildLine - The new created line.
/// @return - Return OK if operation is succeded.
///
int fnd0assignChildLineBase(const BOMLine &ifObj, tag_t sourceLine, char *occType, tag_t *newChildLine );
///
/// This operation is defined for implementation pre and post assign actions on Cut-Paste operation.
/// @version Teamcenter 11.1
/// @param parent_tag - This is the Parent Tag where the the lines will be pasted.
/// @param count - This is number of lines to be cut & pasted
/// @param source_bomlines - Set of source BOMLines to be cut
/// @param target_bomlines - Set of bomlines which would be available after succesfull paste
/// @return -
///
int fnd0bomline_moveBase(const BOMLine &ifObj, tag_t parent_tag, const int count, tag_t *source_bomlines, tag_t **target_bomlines );
///
/// Copy Line operation is invoked on the parent BOM Line to create a new child BOM Line based on lineToCopy. If viewType is provided it is used to create a new BOM View/BOMView Revision on the parent BOM Line if one does not exist.
/// @version Teamcenter 13.1
/// @param lineToCopy - mandatory, tag of BOMLine to copy
/// @param viewType - optional, tag of BOMView to create if there is none
/// @param newLine - tag of resulting BOMLine
/// @return - Returns an integer status, 0 if successful.
///
int fnd0CopyLineBase(const BOMLine &ifObj, tag_t lineToCopy, tag_t viewType, tag_t *newLine );
///
/// This operation will be called when a client calls the cloneStructure SOA API to duplicate a structure in Teamcenter. This operation will allow a customer or CAD integration to register pre and post actions on the duplicate functionality. This will help customers and CAD integrations to perform validation on data to be duplicated and also help resolve special needs that the base duplication logic does not cover.
/// @version Teamcenter 11.1
/// @param topLine - The parent that will be processed, traversed and cloned during the duplication process. This is BOMLine when running Synchronous mode and ItemRevision when running Asynchronous mode.
/// @param topLineResult - This contains the result of the topLine being duplicated. The results are tracked using the Teamcenter::CloneStructureTopLineData runtime business object. The new runtime business object will contain the following properties:
///
/// Teamcenter::BOMLine bomline;
/// Teamcenter::ItemRevision orignalItemRev;
/// Teamcenter::ItemRevision clonedNewItemRev;
/// int status;
/// @return - failure status
///
int fnd0DuplicateBase(const BOMLine &ifObj, const tag_t *topLine, tag_t *topLineResult );
///
/// This operation will be called when a client calls the cloneStructureExpandOrUpdate SOA API to query for CAD dependent data related to the structures to be duplicated in Teamcenter. This operation will allow a customer or CAD integration to register pre and post actions on the duplicateExpandOrUpdate functionality. This will help customers and CAD integrations to return CAD dependencies that Teamcenter would not be aware of since typically this type of dependency is not published in Teamcenter.
/// @version Teamcenter 11.1
/// @param bomlines - This is a list of BOMLines that needs to be expanded and queried for CAD dependencies based on the user selected CAD options. CAD dependency queries will be performed on the BOMLines children.
/// @param itemRevisions - This is a list of ItemRevisions that needs to be queried for CAD dependencies based on the user selected CAD options.
/// @param cadOptions - This is a list of user selected CAD options to perform a query on the bomline or the itemRevisions parameter.
/// @param selectionOption - This is a flag for project auto selection. When the value is 1, the system will check the input lines based on the top BOMLine item's project assignment. If any child belongs to the project, then the parent BOMLine will be returned otherwise the parent BOMLine will not be returned. When the value is 0, the operation will do expansion only.
/// @param updatedObjects - This is a list of ItemRevisions that needs to be updated in the client UI because it has user selected CAD option Dependencies on them.
/// @param cadDependencies - This list contains the dependency information that ties the structure itemRevision to the dependency child. The dependency information are tracked using the Teamcenter::CloneStructureCADDependencyData runtime business object. To use the new runtime business object please refer to the CloneStructureCADDependencyData runtime BMIDE documentation to see the properties defined for this object.
/// @return - failure status
///
int fnd0DuplicateExpandOrUpdateBase(const BOMLine &ifObj, const std::vector< tag_t > *bomlines, const std::vector< tag_t > *itemRevisions, const std::vector< std::string > *cadOptions, const int *selectionOption, std::vector< tag_t > *updatedObjects, std::vector< tag_t > *cadDependencies );
///
/// Expands a set of BOM Lines from the same BOM Window, each to one level. The order of the returned child BOM Lines is not guaranteed.The parameter expansionCriteria is a set of bitwise or-ed flags controlling the expansion behavior, see Expansion Criteria Flags.
/// @version Teamcenter 12.2
/// @param bulkInput - Bulk Input containing the input parent BOMLines that need to be expanded.
/// @param bd - Bulk Data required for bulk processiong of the inputs.
/// @param expansionCriteria - Contains bit flags controlling expansion behavior. Refer to the section #Expansion_Criteria.
/// @param occurenceThreads - Occurrence thread tags used in filter by occurrence threads.
/// @param occurenceThreadParents - BOMLine tags of parent BOMLine for each occurrence thread, used in filter by occurrence threads.
/// @param parentLinesToChildLinesMap - Map containing keys as the parent input lines and values as their respective children.
/// @param errorMap - Map of all the errors during the expansion of the Parent Lines.
/// @return -
///
int fnd0ExpandLinesBase( std::vector< ::Teamcenter::BulkInput* > *bulkInput, ::Teamcenter::BulkData *bd, int expansionCriteria, std::vector< tag_t > *occurenceThreads, std::vector< tag_t > *occurenceThreadParents, std::map< tag_t,std::vector< tag_t > > *parentLinesToChildLinesMap, ::Teamcenter::ErrorMap *errorMap );
///
/// This is the getter for retrieving the recipe/permanent ID if its been created (and cached on the instance). Every Business Object should implement this operation.
/// @version Teamcenter 11.1
/// @param uid - Recipe/permanent ID
/// @param isFirstTime - If Session Recovery Uid is yet to be set or does the object need to be serialized again?
/// @return - Failure code
///
int fnd0AskSRUidBase(const BOMLine &ifObj, std::string *uid, bool *isFirstTime ) const;
///
/// Generates permanent ID/recipe. Every Business Object should implement this operation.
/// @version Teamcenter 11.1
/// @param recipe - Permanent ID/recipe
/// @return - Failure code.
///
int fnd0GenerateRecipeBase(const BOMLine &ifObj, std::string *recipe );
///
/// If Business Object supports recoverable ID. Every Business Object should implement this operation.
/// @version Teamcenter 11.1
/// @param isPersistedRecipe - isPersistedRecipe param should be set to true if the recipe is limited to the user session and should be serialized to the database
/// @param isRecoverableIDSupported - Returning true indicates support for recoverability/permanent IDs
/// @return - Failure code.
///
int fnd0IsRecoverableBase(const BOMLine &ifObj, bool *isPersistedRecipe, bool *isRecoverableIDSupported ) const;
///
/// This is the setter for the recipe/permanent ID when it is created (to be cached on the instance). Every Business Object should implement this operation.
/// @version Teamcenter 11.1
/// @param uid - Rrecipe/permanent ID
/// @return - Failure code.
///
int fnd0SetSRUidBase(const BOMLine &ifObj, const std::string *uid );
///
/// desc for createPost
/// @version Tc 8
/// @param creInput - Description for the Create Input
/// @return - return desc for createPost
///
int createPostBase(const BOMLine &ifObj, ::Teamcenter::CreateInput *creInput );
///
/// desc for setPropertiesFromCreateInpu
/// @version Tc 8
/// @param creInput - Description for CreateInput
/// @return - return desc for setPropertiesFromCreateInput
///
int setPropertiesFromCreateInputBase(const BOMLine &ifObj, ::Teamcenter::CreateInput *creInput );
protected:
// Pointer to the instance
static BOMLineDelegate* m_pInstance;
BOMLineDelegate();
virtual ~BOMLineDelegate();
static void setInstance( BOMLineDelegate* instance );
private:
friend class ::Teamcenter::BOMLineGenImpl;
};
#include <bom/libbom_undef.h>
#endif // TEAMCENTER__BOMLINEDELEGATE_HXX