//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, ScheduleTask Filename: ScheduleTask.hxx Module: schmgt @BMIDE autogenerated ==================================================================================================*/ #ifndef TEAMCENTER__SCHEDULETASK__HXX #define TEAMCENTER__SCHEDULETASK__HXX #include #include #include #include #include #include namespace Teamcenter { class ScheduleTask; } namespace Teamcenter { class ScheduleTaskImpl; } namespace Teamcenter { class ScheduleTaskDelegate; } namespace Teamcenter { class ScheduleTaskDispatch; } namespace Teamcenter { class ScheduleTaskGenImpl; } namespace Teamcenter { class RootObjectImpl; } class SCHMGT_API Teamcenter::ScheduleTask : public ::Teamcenter::WorkspaceObject { public: /** * Get the Interface Name * @return - return desc for getInterfaceName */ static const std::string& getInterfaceName(); /// /// 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 getActual_finish_date( 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 getActual_start_date( date_t &value, bool &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 getApproved_work( int &value, bool &isNull ) const; /// /// Getter for a Boolean 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 getAuto_complete( 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 getBill_code( 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 getBill_sub_code( 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 getBill_type( 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 getBillrate_tag( 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 getChild_task_taglist( std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Double 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 getComplete_percent( double &value, bool &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 getConstraint( int &value, bool &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 getDuration( int &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 getFinish_date( date_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 getFixed_cost_taglist( 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 getFixed_type( int &value, bool &isNull ) const; /// /// Getter for a Date 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 getFnd0ForecastEndDate( date_t &value, bool &isNull ) const; /// /// Getter for a Date 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 getFnd0ForecastStartDate( date_t &value, bool &isNull ) const; /// /// Getter for a Boolean 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 getFnd0IsLegacy( bool &value, bool &isNull ) const; /// /// Getter for a Boolean 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 getFnd0IsSchSummaryTask( bool &value, bool &isNull ) const; /// /// Getter for an String 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 getFnd0MyTaskExecutionErrors( 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 getFnd0MyTaskExecutionStatus( int &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 getFnd0ParentTask( tag_t &value, bool &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 10.1.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 getFnd0Qualifications( 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 getFnd0sch_notification_count( int &value, bool &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 getFnd0sch_subscription_count( 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 getFnd0ScheduleAuditLogs( std::vector< tag_t > &values, std::vector< int > &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 getFnd0state( 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 getFnd0status( std::string &value, bool &isNull ) const; /// /// Getter for an String 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 getFnd0TaskExecutionStatuses( std::vector< std::string > &values, std::vector< int > &isNull ) const; /// /// Getter for an Integer Property /// @version Teamcenter 11.4 /// @param value - Parameter Value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getFnd0WhatIfMode( int &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 getFnd0workflow_owner( tag_t &value, bool &isNull ) const; /// /// Getter for a Boolean 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 getIs_baseline( 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 getItem_id( std::string &value, bool &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 getPriority( int &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 getPrivileged_user( 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 getSch_task_deliverable_list( std::vector< tag_t > &values, std::vector< int > &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 getSchedule_tag( tag_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 getStart_date( date_t &value, bool &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 getTask_type( int &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 getWbs_code( std::string &value, bool &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 getWork_complete( int &value, bool &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 getWork_estimate( int &value, bool &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 getWork_remaining( int &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 getWorkflow_process( 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 getWorkflow_template( tag_t &value, bool &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 getWorkflow_trigger_type( int &value, bool &isNull ) const; /// /// Setter for a Date Property /// @version Teamcenter 11.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 setActual_finish_date( const date_t &value, bool isNull=false ); /// /// Setter for a Date Property /// @version Teamcenter 11.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 setActual_start_date( const date_t &value, bool isNull=false ); /// /// Setter for an Integer Property /// @version Teamcenter 11.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 setApproved_work( int value, bool isNull=false ); /// /// Setter for a Boolean Property /// @version Teamcenter 11.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 setAuto_complete( bool value, bool isNull=false ); /// /// Setter for a string Property /// @version Teamcenter 11.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 setBill_code( const std::string &value, bool isNull=false ); /// /// Setter for a string Property /// @version Teamcenter 11.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 setBill_sub_code( const std::string &value, bool isNull=false ); /// /// Setter for a string Property /// @version Teamcenter 11.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 setBill_type( const std::string &value, bool isNull=false ); /// /// Setter for a Tag Property /// @version Teamcenter 11.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 setBillrate_tag( const tag_t &value, bool isNull=false ); /// /// 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 setChild_task_taglist( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 ); /// /// Setter for a Double Property /// @version Teamcenter 11.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 setComplete_percent( double value, bool isNull=false ); /// /// Setter for an Integer Property /// @version Teamcenter 11.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 setConstraint( int value, bool isNull=false ); /// /// Setter for an Integer Property /// @version Teamcenter 11.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 setDuration( int value, bool isNull=false ); /// /// Setter for a Date Property /// @version Teamcenter 11.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 setFinish_date( const date_t &value, bool isNull=false ); /// /// 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 setFixed_cost_taglist( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 ); /// /// Setter for an Integer Property /// @version Teamcenter 11.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 setFixed_type( int value, bool isNull=false ); /// /// 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 setFnd0ForecastEndDate( const date_t &value, bool isNull=false ); /// /// 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 setFnd0ForecastStartDate( const date_t &value, bool isNull=false ); /// /// Setter for a Boolean Property /// @version Teamcenter 11.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 setFnd0IsLegacy( bool value, bool isNull=false ); /// /// Setter for a Boolean Property /// @version Teamcenter 11.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 setFnd0IsSchSummaryTask( bool value, bool isNull=false ); /// /// Setter for a Tag 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 setFnd0ParentTask( const tag_t &value, bool isNull=false ); /// /// Setter for a string Property /// @version Teamcenter 11.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 setFnd0state( const std::string &value, bool isNull=false ); /// /// Setter for a string Property /// @version Teamcenter 11.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 setFnd0status( const std::string &value, bool isNull=false ); /// /// Setter for an Integer Property /// @version Teamcenter 11.4 /// @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 setFnd0WhatIfMode( int value, bool isNull=false ); /// /// Setter for a Tag Property /// @version Teamcenter 11.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 setFnd0workflow_owner( const tag_t &value, bool isNull=false ); /// /// Setter for a Boolean Property /// @version Teamcenter 11.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 setIs_baseline( bool value, bool isNull=false ); /// /// Setter for a string Property /// @version Teamcenter 11.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 setItem_id( const std::string &value, bool isNull=false ); /// /// Setter for an Integer Property /// @version Teamcenter 11.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 setPriority( int value, bool isNull=false ); /// /// Setter for a Tag Property /// @version Teamcenter 11.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 setPrivileged_user( const tag_t &value, bool isNull=false ); /// /// 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 setSch_task_deliverable_list( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 ); /// /// Setter for a Tag Property /// @version Teamcenter 11.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 setSchedule_tag( const tag_t &value, bool isNull=false ); /// /// Setter for a Date Property /// @version Teamcenter 11.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 setStart_date( const date_t &value, bool isNull=false ); /// /// Setter for an Integer Property /// @version Teamcenter 11.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 setTask_type( int value, bool isNull=false ); /// /// Setter for a string Property /// @version Teamcenter 11.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 setWbs_code( const std::string &value, bool isNull=false ); /// /// Setter for an Integer Property /// @version Teamcenter 11.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 setWork_complete( int value, bool isNull=false ); /// /// Setter for an Integer Property /// @version Teamcenter 11.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 setWork_estimate( int value, bool isNull=false ); /// /// Setter for an Integer Property /// @version Teamcenter 11.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 setWork_remaining( int value, bool isNull=false ); /// /// Setter for a Tag Property /// @version Teamcenter 11.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 setWorkflow_process( const tag_t &value, bool isNull=false ); /// /// Setter for a Tag Property /// @version Teamcenter 11.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 setWorkflow_template( const tag_t &value, bool isNull=false ); /// /// Setter for an Integer Property /// @version Teamcenter 11.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 setWorkflow_trigger_type( int value, bool isNull=false ); /// /// This operation determines if the current login user is a schedule coordinator. /// @version Teamcenter 10.1 /// @param isCoordinator - A boolean capturing the outcome of the evaluation. True if the current login user is a schedule coordinator. False if it is not. /// @return - An integer representing success or failure of the operation /// int fnd0isScheduleCoordinator( bool *isCoordinator ); /// /// This operation determines if the current login user is an assignee of the schedule task. /// @version Teamcenter 10.1 /// @param isAssignee - A boolean capturing the outcome of the evaluation. True if the current login user is an assigneed of the schedule task. False if it is not. /// @return - An integer representing success or failure of the operation /// int fnd0isTaskAssignee( bool *isAssignee ); protected: // Method to initialize virtual void initialize( ::Teamcenter::RootObjectImpl* impl ); /** * Constructor */ ScheduleTask(); /** * Destructor */ virtual ~ScheduleTask(); private: // Getter method for the Implementation Object ScheduleTaskImpl* getScheduleTaskImpl() const; // Setter method for the Implementation Object ::Teamcenter::RootObjectImpl* setScheduleTaskImpl( ::Teamcenter::RootObjectImpl* impl ); // Method to set the delete impl boolean void setDeleteImpl( bool del ); // Pointer to the Implementation object ScheduleTaskImpl* m_scheduletaskImpl; // 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 ScheduleTask - desc for ScheduleTask parameter */ ScheduleTask( const ScheduleTask& ); ScheduleTask& operator=( const ScheduleTask& ); friend class ScheduleTaskDelegate; friend class ScheduleTaskDispatch; friend class ScheduleTaskGenImpl; }; #include #endif // TEAMCENTER__SCHEDULETASK__HXX