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.

832 lines
27 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, Schedule
Filename: Schedule.hxx
Module: schmgt
@BMIDE autogenerated
==================================================================================================*/
#ifndef TEAMCENTER__SCHEDULE__HXX
#define TEAMCENTER__SCHEDULE__HXX
#include <unidefs.h>
#include <string>
#include <vector>
#include <common/tc_deprecation_macros.h>
#include <tccore/WorkspaceObject.hxx>
#include <schmgt/libschmgt_exports.h>
namespace Teamcenter
{
class Schedule;
}
namespace Teamcenter
{
class ScheduleImpl;
}
namespace Teamcenter
{
class ScheduleDelegate;
}
namespace Teamcenter
{
class ScheduleDispatch;
}
namespace Teamcenter
{
class ScheduleGenImpl;
}
namespace Teamcenter
{
class RootObjectImpl;
}
class SCHMGT_API Teamcenter::Schedule
: public ::Teamcenter::WorkspaceObject
{
public:
/**
* Get the Interface Name
* @return - return desc for getInterfaceName
*/
static const std::string& getInterfaceName();
///
/// 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 getActiveschbaseline_tag( tag_t &value, bool &isNull ) const;
///
/// Getter for a string 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 getCustomer_name( std::string &value, bool &isNull ) const;
///
/// Getter for a string 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 getCustomer_number( std::string &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 getDates_linked( bool &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 getEarliest_finish_date( 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 getEnd_date_scheduling( bool &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 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 getFnd0allowExecUpdates( bool &value, bool &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 getFnd0BudgetedEffortInt( 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 getFnd0IsExternal( 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 getFnd0IsLegacy( bool &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 getFnd0master_sched( 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 getFnd0ProxyTasks( 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 getFnd0ScheduleAuditLogs( 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 getFnd0Schedulemember_taglist( 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 getFnd0ScheduleTemplate( 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 getFnd0Schmgt_Lock( 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 getFnd0ShiftDate( date_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 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 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 getFnd0SummaryTask( 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 getFnd0user_priv( int &value, bool &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 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 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_public( 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 getIs_template( 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 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 getLatest_start_date( 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 getLinks_allowed( 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 getNotifications_enabled( 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 getPercent_linked( bool &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 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 getPublished( bool &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 getRecalc_type( 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 getRights_mask( 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 getSchedule_deliverable_list( 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 getSchedule_type( 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 getStart_date( date_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 getWbsformat( 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 getWbsvalue( std::string &value, bool &isNull ) const;
///
/// 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 setActiveschbaseline_tag( 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 setDates_linked( bool 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 setEarliest_finish_date( 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 setEnd_date_scheduling( bool 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 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 setFnd0allowExecUpdates( bool 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 setFnd0BudgetedEffortInt( 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 setFnd0IsExternal( 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 setFnd0IsLegacy( bool 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 setFnd0master_sched( 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 setFnd0Schedulemember_taglist( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
///
/// 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 setFnd0ScheduleTemplate( 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 setFnd0Schmgt_Lock( 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 setFnd0ShiftDate( const date_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 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 setFnd0SummaryTask( 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 setFnd0user_priv( int 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 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 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_public( 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 setIs_template( 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 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 setLatest_start_date( 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 setLinks_allowed( 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 setNotifications_enabled( 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 setPercent_linked( bool 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 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 setPublished( bool 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 setRecalc_type( 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 setRights_mask( int 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 setSchedule_deliverable_list( 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 setSchedule_type( 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 setStart_date( const date_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 setWbsformat( 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 setWbsvalue( const std::string &value, bool isNull=false );
protected:
// Method to initialize
virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
/**
* Constructor
*/
Schedule();
/**
* Destructor
*/
virtual ~Schedule();
private:
// Getter method for the Implementation Object
ScheduleImpl* getScheduleImpl() const;
// Setter method for the Implementation Object
::Teamcenter::RootObjectImpl* setScheduleImpl( ::Teamcenter::RootObjectImpl* impl );
// Method to set the delete impl boolean
void setDeleteImpl( bool del );
// Pointer to the Implementation object
ScheduleImpl* m_scheduleImpl;
// 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 Schedule - desc for Schedule parameter
*/
Schedule( const Schedule& );
Schedule& operator=( const Schedule& );
friend class ScheduleDelegate;
friend class ScheduleDispatch;
friend class ScheduleGenImpl;
};
#include <schmgt/libschmgt_undef.h>
#endif // TEAMCENTER__SCHEDULE__HXX