//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, ItemRevision Filename: ItemRevision.hxx Module: tccore @BMIDE autogenerated ==================================================================================================*/ #ifndef TEAMCENTER__ITEMREVISION__HXX #define TEAMCENTER__ITEMREVISION__HXX #include #include #include #include #include #include #include #include #include #include namespace Teamcenter { class ItemRevision; } namespace Teamcenter { class ItemRevisionImpl; } namespace Teamcenter { class ItemRevisionDelegate; } namespace Teamcenter { class ItemRevisionDispatch; } namespace Teamcenter { class ItemRevisionGenImpl; } namespace Teamcenter { class RootObjectImpl; } class TCCORE_API Teamcenter::ItemRevision : public ::Teamcenter::WorkspaceObject { public: /** * Get the Interface Name * @return - return desc for getInterfaceName */ static const std::string& getInterfaceName(); /// /// Getter for a Tag Array Property /// @version Tc 8 /// @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 getDeclared_options( std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for an String Array Property /// @version Tc 8 /// @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 getFms_tickets( std::vector< std::string > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 11.1 /// @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 getFnd0ConfiguredDrawings( std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a string Property /// @version Teamcenter 9 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getFnd0CurrentLocationCode( std::string &value, bool &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 11.1 /// @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 getFnd0Drawings( std::vector< tag_t > &values, std::vector< int > &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 getFnd0IRDCUsed( std::string &value, bool &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 10 /// @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 getFnd0StructureAuditLogs( std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Tc 8 /// @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 getGde_bvr_list( std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Boolean Property /// @version Tc 8 /// @param value - Parameter Value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getHas_variant_module( bool &value, bool &isNull ) const; /// /// Getter for a Boolean Property /// @version Tc 8 /// @param value - Parameter Value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getIs_IRDC( 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 getItem_revision_id( std::string &value, bool &isNull ) const; /// /// Getter for a Tag Property /// @version Tc 8 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getItems_tag( tag_t &value, bool &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 8.1 /// @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 getPs_children( std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 8.1 /// @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 getPs_parents( std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 8.1 /// @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 getRevision_list( std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Property /// @version Tc 8 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getSequence_anchor( tag_t &value, bool &isNull ) const; /// /// Getter for an Integer Property /// @version Tc 8 /// @param value - Parameter Value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getSequence_id( int &value, bool &isNull ) const; /// /// Getter for an Integer Property /// @version Tc 8 /// @param value - Parameter Value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getSequence_limit( int &value, bool &isNull ) const; /// /// Getter for a Tag Array Property /// @version Tc 8 /// @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 getStructure_revisions( std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Tc 8 /// @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 getUsed_options( std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Property /// @version Tc 8 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getVariant_expression_block( tag_t &value, bool &isNull ) const; /// /// Setter for a Tag Array Property /// @version Tc 8 /// @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 setDeclared_options( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 ); /// /// 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 setFnd0CurrentLocationCode( const std::string &value, bool isNull=false ); /// /// Setter for a Tag Array Property /// @version Tc 8 /// @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 setGde_bvr_list( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 ); /// /// Setter for a Boolean Property /// @version Tc 8 /// @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 setHas_variant_module( bool value, bool isNull=false ); /// /// Setter for a string Property /// @version Tc 8 /// @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 setItem_revision_id( const std::string &value, bool isNull=false ); /// /// Setter for a Tag Property /// @version Tc 8 /// @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 setItems_tag( const tag_t &value, bool isNull=false ); /// /// Setter for a Tag Property /// @version Tc 8 /// @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 setSequence_anchor( const tag_t &value, bool isNull=false ); /// /// Setter for an Integer Property /// @version Tc 8 /// @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 setSequence_id( int value, bool isNull=false ); /// /// Setter for an Integer Property /// @version Tc 8 /// @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 setSequence_limit( int value, bool isNull=false ); /// /// Setter for a Tag Array Property /// @version Tc 8 /// @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 setStructure_revisions( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 ); /// /// Setter for a Tag Array Property /// @version Tc 8 /// @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 setUsed_options( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 ); /// /// Setter for a Tag Property /// @version Tc 8 /// @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 setVariant_expression_block( const tag_t &value, bool isNull=false ); /// /// This operation tests if the target has a targetCount:otherSideCount relation with otherSide object for the given relation type. /// @version Tc 8 /// @param otherSide - Tag of the otherSide object /// @param relation - Tag of the relation /// @param isPrimary - Flag to indiacte if the target is a primary object in the relation /// @param targetCount - Cardinality of target /// @param otherSideCount - Cardinality of the otherside object /// @param result - Return result as true if the target has a targetCount:otherSideCount relation with otherSide object for the given relation type, otherwise return result as false. /// @return - Return error code. /// int checkUniqueItems( tag_t otherSide, tag_t relation, bool isPrimary, int targetCount, int otherSideCount, bool *result ); /// /// Finalize operation input /// @version Teamcenter 10.1 /// @param pReviseInput - desc /// @param vecDeepCopyData - desc /// @return - Returns an int. /// int finalizeReviseInput( ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData ); /// /// This operation is not supported now, there will be no support for issues stemming from uses of this operation. /// @version Teamcenter 11.2.3 /// @param inputs - A vector of data that contains reference information to the objects to be revised /// @param bd - A data structure to store objects and other information relevant for set-based operation /// @return - /// static int fnd0FinalizeReviseInput( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd ); /// /// /// @version Teamcenter 11.4 /// @param participantTypeName - Participant Type Name /// @param output - Returns true if current user is of requested participant type on ItemRevision business object. /// @return - /// int fnd0IsParticipant( const std::string &participantTypeName, bool *output ); /// /// This operation is not supported now, there will be no support for issues stemming from uses of this operation. /// @version Teamcenter 11.2.3 /// @param inputs - A vector of data that contains reference information to the objects to be revised /// @param bd - A data structure to store objects and other information relevant for set-based operation /// @return - /// static int fnd0Revise( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd ); /// /// This operation is not supported now, there will be no support for issues stemming from uses of this operation. /// @version Teamcenter 11.2.3 /// @param inputs - A vector of data that contains reference information to the objects to be revised /// @param bd - A data structure to store objects and other information relevant for set-based operation /// @return - /// static int fnd0RevisePost( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd ); /// /// operation for creating/setting values to shadow object during revise /// @version Teamcenter 11.1 /// @param pReviseInput - Revise Input /// @param newShObjTag - new shadow object created during revise /// @return - shadow object /// int fnd0ReviseShadowObject( ::Teamcenter::ReviseInput *pReviseInput, tag_t *newShObjTag ); /// /// This operation is not supported now, there will be no support for issues stemming from uses of this operation. /// @version Teamcenter 11.2.3 /// @param inputs - A vector of data that contains reference information to the objects to be revised /// @param bd - A data structure to store objects and other information relevant for set-based operation /// @return - /// static int fnd0SetPropertiesFromReviseInput( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd ); /// /// This operation is not supported now, there will be no support for issues stemming from uses of this operation. /// @version Teamcenter 11.2.3 /// @param inputs - A vector of data that contains reference information to the objects to be revised /// @param bd - A data structure to store objects and other information relevant for set-based operation /// @return - /// static int fnd0ValidateReviseInput( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd ); /// /// Revise operation. /// @version Teamcenter 10.1 /// @param pReviseInput - revise input /// @param vecDeepCopyData - vector deep copy data /// @param newObjTag - Tag of revised object. /// @return - Returns an int. /// int revise( ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData, tag_t *newObjTag ); /// /// Generic revisePost operation /// @version Teamcenter 10.1 /// @param pReviseInput - Input reviseInput object. /// @param vecDeepCopyData - Vector of deep copy data. /// @return - Return integer value. /// int revisePost( ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData ); /// /// Set properties from revise input. /// @version Teamcenter 10.1 /// @param pReviseInput - desc /// @return - Returns an int. /// int setPropertiesFromReviseInput( ::Teamcenter::ReviseInput *pReviseInput ); /// /// Validate revise input. /// @version Teamcenter 10.1 /// @param pReviseInput - desc /// @param vecDeepCopyData - desc /// @return - Returns an int. /// int validateReviseInput( ::Teamcenter::ReviseInput *pReviseInput, std::vector< ::Teamcenter::DeepCopyData* > *vecDeepCopyData ); protected: // Method to initialize virtual void initialize( ::Teamcenter::RootObjectImpl* impl ); /** * Constructor */ ItemRevision(); /** * Destructor */ virtual ~ItemRevision(); private: // Getter method for the Implementation Object ItemRevisionImpl* getItemRevisionImpl() const; // Setter method for the Implementation Object ::Teamcenter::RootObjectImpl* setItemRevisionImpl( ::Teamcenter::RootObjectImpl* impl ); // Method to set the delete impl boolean void setDeleteImpl( bool del ); // Pointer to the Implementation object ItemRevisionImpl* m_itemrevisionImpl; // Flag to indicate if Implementation object needs to be deleted bool m_deleteImpl; /** * Name of the Business Object */ static std::string name; /** * Private default constructor. We do not want this class instantiated without the business object passed in. * @param ItemRevision - desc for ItemRevision parameter */ ItemRevision( const ItemRevision& ); ItemRevision& operator=( const ItemRevision& ); friend class ItemRevisionDelegate; friend class ItemRevisionDispatch; friend class ItemRevisionGenImpl; friend class ItemRevisionImpl; }; #include #endif // TEAMCENTER__ITEMREVISION__HXX