//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, SignoffDelegate Filename: SignoffDelegate.hxx Module: epm @BMIDE autogenerated ==================================================================================================*/ #ifndef TEAMCENTER__SIGNOFFDELEGATE_HXX #define TEAMCENTER__SIGNOFFDELEGATE_HXX #include #include #include namespace Teamcenter { class SignoffDelegate; } namespace Teamcenter { class SignoffImpl; } namespace Teamcenter { class Signoff; } namespace Teamcenter { class SignoffGenImpl; } namespace Teamcenter_alias = ::Teamcenter; class EPM_API Teamcenter_alias::SignoffDelegate { public: // Method to initialize this Class static int initializeClass(); // Method to get the SignoffDelegate instance static SignoffDelegate& getInstance(); // Method to create the SignoffImpl pointer static SignoffImpl* createImpl( Signoff& ifObj ); // Method to delete the SignoffImpl pointer static void deleteImpl( SignoffImpl* impl ); /// /// Getter for a Tag 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 getActive_surrogateBase(const Signoff &ifObj, tag_t &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 getCommentsBase(const Signoff &ifObj, std::string &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 getDecisionBase(const Signoff &ifObj, int &value, bool &isNull ) const; /// /// Getter for a Date 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 getDecision_dateBase(const Signoff &ifObj, date_t &value, bool &isNull ) const; /// /// Getter for a Date 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 getDue_dateBase(const Signoff &ifObj, date_t &value, bool &isNull ) const; /// /// Getter for a Tag 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 getFnd0AssigneeBase(const Signoff &ifObj, tag_t &value, bool &isNull ) const; /// /// Getter for a string Property /// @version Teamcenter 11.2 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getFnd0AssigneeGroupRoleBase(const Signoff &ifObj, std::string &value, bool &isNull ) const; /// /// Getter for a Tag 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 getFnd0AssigneeOriginBase(const Signoff &ifObj, tag_t &value, bool &isNull ) const; /// /// Getter for a Tag 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 getFnd0AssignerBase(const Signoff &ifObj, tag_t &value, bool &isNull ) const; /// /// Getter for a string Property /// @version Teamcenter 11.2 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getFnd0DecisionRequiredBase(const Signoff &ifObj, std::string &value, bool &isNull ) const; /// /// Getter for a Tag 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 getFnd0ParentTaskBase(const Signoff &ifObj, tag_t &value, bool &isNull ) const; /// /// Getter for a Tag 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 getFnd0PerformerBase(const Signoff &ifObj, tag_t &value, bool &isNull ) const; /// /// Getter for a string 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 getFnd0PriorityBase(const Signoff &ifObj, std::string &value, bool &isNull ) const; /// /// Getter for a Date 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 getFnd0StartDateBase(const Signoff &ifObj, date_t &value, bool &isNull ) const; /// /// Getter for a Tag Property /// @version Teamcenter 11.2 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getFnd0WorkflowInitiatorBase(const Signoff &ifObj, tag_t &value, bool &isNull ) const; /// /// Getter for a Tag 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 getGroup_memberBase(const Signoff &ifObj, tag_t &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 getIs_mine_to_performBase(const Signoff &ifObj, bool &value, bool &isNull ) const; /// /// Getter for a Boolean Property /// @version Teamcenter 11.2 /// @param value - Parameter Value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getIs_modifiableBase(const Signoff &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 getIs_valid_surrogateBase(const Signoff &ifObj, bool &value, bool &isNull ) const; /// /// Getter for a string 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 getJob_nameBase(const Signoff &ifObj, std::string &value, bool &isNull ) const; /// /// Getter for a string 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 getObject_descBase(const Signoff &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 getObject_nameBase(const Signoff &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 getObject_typeBase(const Signoff &ifObj, std::string &value, bool &isNull ) const; /// /// Getter for a Tag 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 getOriginBase(const Signoff &ifObj, tag_t &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 getOriginated_fromBase(const Signoff &ifObj, int &value, bool &isNull ) const; /// /// Getter for a Tag 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 getProfileBase(const Signoff &ifObj, tag_t &value, bool &isNull ) const; /// /// Getter for a Tag 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 getResource_poolBase(const Signoff &ifObj, tag_t &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 getRoot_reference_attachmentsBase(const Signoff &ifObj, std::vector< tag_t > &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 getRoot_target_attachmentsBase(const Signoff &ifObj, std::vector< tag_t > &values, std::vector< int > &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 getSignoff_actionBase(const Signoff &ifObj, int &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 getSignoff_attachmentsBase(const Signoff &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag 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 getSignoff_memberBase(const Signoff &ifObj, tag_t &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 getSignoff_typeBase(const Signoff &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 getUser_accessBase(const Signoff &ifObj, bool &value, bool &isNull ) const; /// /// Setter for a Tag 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 setActive_surrogateBase(Signoff &ifObj, const tag_t &value, bool isNull ); /// /// Setter for a string 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 setCommentsBase(Signoff &ifObj, const std::string &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 setDecisionBase(Signoff &ifObj, int value, bool isNull ); /// /// Setter for a Date 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 setDecision_dateBase(Signoff &ifObj, const date_t &value, bool isNull ); /// /// Setter for a Date Property /// @version Teamcenter 11.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 setDue_dateBase(Signoff &ifObj, const date_t &value, bool isNull ); /// /// Setter for a string Property /// @version Teamcenter 11.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 setFnd0DecisionRequiredBase(Signoff &ifObj, const std::string &value, bool isNull ); /// /// Setter for a Tag 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 setGroup_memberBase(Signoff &ifObj, const tag_t &value, bool isNull ); /// /// Setter for a Tag 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 setOriginBase(Signoff &ifObj, const tag_t &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 setOriginated_fromBase(Signoff &ifObj, int value, bool isNull ); /// /// Setter for a Tag 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 setResource_poolBase(Signoff &ifObj, const tag_t &value, bool isNull ); /// /// Setter for a Tag Array Property /// @version Teamcenter 11.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 setRoot_reference_attachmentsBase(Signoff &ifObj, const std::vector< tag_t > &values, const std::vector< int > *isNull ); /// /// Setter for a Tag Array Property /// @version Teamcenter 11.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 setRoot_target_attachmentsBase(Signoff &ifObj, const std::vector< tag_t > &values, const std::vector< int > *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 setSignoff_actionBase(Signoff &ifObj, int value, bool isNull ); /// /// Setter for a Tag 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 setSignoff_memberBase(Signoff &ifObj, const tag_t &value, bool isNull ); /// /// This operation is not supported now, there will be no support for issues stemming from uses of this operation. /// @version Teamcenter 11.2.2 /// @param inputs - A vector of data that contains reference to the object to be refreshed /// @param bd - A data structure to store objects and other information relevant for set-based operation /// @param isLockForDelete - A boolean to indicate if object(s) are to be locked for deletion /// @param allowRelock - A boolean to indicate if object(s) can be relocked, which will discard all unsaved changes, if already locked by the same user /// @return - This operation returns ITK_ok on success. Otherwise, it will return specific error code. /// int fnd0LockBase( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd, const bool isLockForDelete, const bool allowRelock ); /// /// This operation is not supported now, there will be no support for issues stemming from uses of this operation. /// @version Teamcenter 11.2.2 /// @param inputs - A vector of data that contains reference to the object to be refreshed /// @param bd - A data structure to store objects and other information relevant for set-based operation /// @return - This operation returns ITK_ok on success. Otherwise, it will return specific error code. /// int fnd0RefreshBase( 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.2 /// @param inputs - A vector of data that contains reference information to the object to be saved /// @param bd - A data structure to store objects and other information relevant for set-based operation /// @return - This operation returns ITK_ok on success. Otherwise, it will return specific error code. /// int fnd0SaveBase( 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.2 /// @param inputs - A vector of data that contains reference to the object to be refreshed /// @param bd - A data structure to store objects and other information relevant for set-based operation /// @return - This operation returns ITK_ok on success. Otherwise, it will return specific error code. /// int fnd0UnlockBase( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd ); /// /// Description for the Finalize Create Input /// @version Tc 8 /// @param creInput - desc for creInput parameter /// @return - Return desc for Initialize for Create /// int finalizeCreateInputBase(const Signoff &ifObj, ::Teamcenter::CreateInput *creInput ); /// /// desc for setPropertiesFromCreateInpu /// @version Tc 8 /// @param creInput - Description for CreateInput /// @return - return desc for setPropertiesFromCreateInput /// int setPropertiesFromCreateInputBase(const Signoff &ifObj, ::Teamcenter::CreateInput *creInput ); /// /// Getter for a string Property /// @version Teamcenter 10 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getObject_stringBase(const Signoff &ifObj, std::string &value, bool &isNull ) const; protected: // Pointer to the instance static SignoffDelegate* m_pInstance; SignoffDelegate(); virtual ~SignoffDelegate(); static void setInstance( SignoffDelegate* instance ); private: friend class ::Teamcenter::SignoffGenImpl; }; #include #endif // TEAMCENTER__SIGNOFFDELEGATE_HXX