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.
1102 lines
40 KiB
1102 lines
40 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, EPMTask
|
|
Filename: EPMTask.hxx
|
|
Module: epm
|
|
@BMIDE autogenerated
|
|
==================================================================================================*/
|
|
|
|
#ifndef TEAMCENTER__EPMTASK__HXX
|
|
#define TEAMCENTER__EPMTASK__HXX
|
|
|
|
#include <vector>
|
|
#include <unidefs.h>
|
|
#include <string>
|
|
#include <common/tc_deprecation_macros.h>
|
|
#include <tccore/WorkspaceObject.hxx>
|
|
|
|
#include <epm/libepm_exports.h>
|
|
|
|
namespace Teamcenter
|
|
{
|
|
class EPMTask;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class EPMTaskImpl;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class EPMTaskDelegate;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class EPMTaskDispatch;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class EPMTaskGenImpl;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class RootObjectImpl;
|
|
}
|
|
|
|
class EPM_API Teamcenter::EPMTask
|
|
: 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 10.1
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getActive_surrogate( tag_t &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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_tasks( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 getComment_attachments( 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 getComplete_node_location( 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 getCondition_result( int &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 getConflict_tasks( std::vector< tag_t > &values, std::vector< int > &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 getDue_date( date_t &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 getEpm_subprocesses( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for an Integer Property
|
|
/// @version Teamcenter 10
|
|
/// @param value - Parameter Value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getFnd0ActualDuration( 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 getFnd0Assignee( tag_t &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Date Property
|
|
/// @version Teamcenter 10
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getFnd0EndDate( 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 getFnd0IsPKIAuthRequired( 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 getFnd0IsValidPerformer( bool &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for an String 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 getFnd0MyTaskExecutionErrors( std::vector< std::string > &values, std::vector< int > &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 getFnd0MyTaskExecutionStatus( 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 getFnd0ObjectsToDigitallySign( 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 getFnd0rootCMImpactedItems( 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 getFnd0rootCMProblemItems( 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 getFnd0rootCMSolutionItems( 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 getFnd0RootReplicaTargets( 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 getFnd0RootScheduleTask( 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 getFnd0ScheduleCategory( int &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Date Property
|
|
/// @version Teamcenter 10
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getFnd0StartDate( date_t &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for an String 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 getFnd0TaskExecutionStatuses( std::vector< std::string > &values, std::vector< int > &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 getFnd0WorkflowTaskLogs( 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_failure_paths( 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 getHas_surrogate( bool &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 getIconKey( std::string &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 getInstruction_attachments( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 getInterprocess_task_dependencies( std::vector< tag_t > &values, std::vector< int > &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_surrogate( bool &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 getJob_name( std::string &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 getLate_flag( bool &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 getLocation( std::string &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 getMy_signoff_completed( bool &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 getNext_task( 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 getNum_targets( int &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 getParent_name( 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 getParent_process( 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 getParent_processes( 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 getParent_processes_states( std::vector< std::string > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for an String Array Property
|
|
/// @version Teamcenter 10.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 getPath_type( std::vector< std::string > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 getPredecessors( 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 getPrevious_task( tag_t &value, bool &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 getProcess_paths( std::vector< std::string > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 getProject_task_attachments( 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 getReal_state( std::string &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 getRecipients( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 getReference_attachments( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 getRelease_status_attachments( 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 getResp_party( 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 getResponsible_party( tag_t &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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_attachments( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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_attachments( 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 getRoot_task( 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 getSecure_task( bool &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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_attachments( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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_profiles( 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_quorum( int &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 getStart_node_location( 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 getState( int &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 getSub_processes( 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 getSub_processes_states( std::vector< std::string > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 getSuccessors( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 getTarget_attachments( 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 getTask_duration( int &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 getTask_state( 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 getTask_type( std::string &value, bool &isNull ) const;
|
|
|
|
///
|
|
/// Getter for an String Array Property
|
|
/// @version Teamcenter 10.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 getThe_task_duration( std::vector< std::string > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 getUser_all_signoffs( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
|
|
|
|
///
|
|
/// Getter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 getValid_signoffs( std::vector< tag_t > &values, std::vector< int > &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 getViewed_by_me( bool &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 getWork_context( tag_t &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_surrogate( const tag_t &value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 setComment_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// 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 setComplete_node_location( const std::string &value, bool isNull=false );
|
|
|
|
///
|
|
/// 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 setCondition_result( int value, bool isNull=false );
|
|
|
|
///
|
|
/// 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 setDue_date( const date_t &value, bool isNull=false );
|
|
|
|
///
|
|
/// 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 setDue_date_project( const date_t &value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 setEpm_subprocesses( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// Setter for an Integer Property
|
|
/// @version Teamcenter 10
|
|
/// @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 setFnd0ActualDuration( int value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for a Date Property
|
|
/// @version Teamcenter 10
|
|
/// @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 setFnd0EndDate( 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 setFnd0rootCMImpactedItems( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// 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 setFnd0rootCMProblemItems( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// 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 setFnd0rootCMSolutionItems( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// 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 setFnd0RootReplicaTargets( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// 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 setFnd0RootScheduleTask( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// Setter for a Date Property
|
|
/// @version Teamcenter 10
|
|
/// @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 setFnd0StartDate( const date_t &value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 setInstruction_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// Setter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 setInterprocess_task_dependencies( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// Setter for a Boolean 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 setLate_flag( bool value, bool isNull=false );
|
|
|
|
///
|
|
/// 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 setLocation( const std::string &value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 setProject_task_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// Setter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 setRecipients( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// Setter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 setReference_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// Setter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 setRelease_status_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// 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 setResponsible_party( const tag_t &value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for a Tag Array Property
|
|
/// @version Teamcenter 10.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_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// Setter for a Tag Array Property
|
|
/// @version Teamcenter 10.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_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// Setter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 setSignoff_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// Setter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 setSignoff_profiles( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// 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_quorum( int value, bool isNull=false );
|
|
|
|
///
|
|
/// 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 setStart_node_location( const std::string &value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for a Tag Array Property
|
|
/// @version Teamcenter 10.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 setTarget_attachments( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// 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 setTask_duration( int value, bool isNull=false );
|
|
|
|
///
|
|
/// 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 setTask_type( const std::string &value, bool isNull=false );
|
|
|
|
///
|
|
/// Setter for an string Array Property
|
|
/// @version Teamcenter 10.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 setThe_task_duration( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
|
|
|
|
///
|
|
/// Setter for a Boolean 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 setViewed_by_me( bool value, bool isNull=false );
|
|
|
|
///
|
|
/// 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 setWork_context( const tag_t &value, bool isNull=false );
|
|
|
|
///
|
|
/// This operation modifies the target attachment list. If the addOrRemoveTargets parameter is set to EPM_add_attachment_action then the target objects on parameter targetAttachmentList are added to the target list. Otherwise if the addOrRemoveTargets parameter is set to EPM_remove_attachment_action then the target objects on parameter targetAttachmentList are removed from the target list.
|
|
/// @version Teamcenter 12
|
|
/// @param addOrRemoveTargets - An integer indicating what action (add or remove) should be performed on the provided target attachment list. Valid values are EPM_add_attachment_action or EPM_remove_attachment_action.
|
|
/// @param targetAttachmentList - A vector of target object tags to be used to update the target list.
|
|
/// @return - Returns ITK_ok on success. Otherwise a specific error code will be returned.
|
|
///
|
|
int fnd0ModifyTargetList( const int addOrRemoveTargets, const std::vector< tag_t > &targetAttachmentList );
|
|
protected:
|
|
// Method to initialize
|
|
virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
|
|
|
|
/**
|
|
* Constructor
|
|
*/
|
|
EPMTask();
|
|
|
|
/**
|
|
* Destructor
|
|
*/
|
|
virtual ~EPMTask();
|
|
|
|
private:
|
|
// Getter method for the Implementation Object
|
|
EPMTaskImpl* getEPMTaskImpl() const;
|
|
// Setter method for the Implementation Object
|
|
::Teamcenter::RootObjectImpl* setEPMTaskImpl( ::Teamcenter::RootObjectImpl* impl );
|
|
|
|
// Method to set the delete impl boolean
|
|
void setDeleteImpl( bool del );
|
|
|
|
// Pointer to the Implementation object
|
|
EPMTaskImpl* m_epmtaskImpl;
|
|
|
|
// 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 EPMTask - desc for EPMTask parameter
|
|
*/
|
|
EPMTask( const EPMTask& );
|
|
EPMTask& operator=( const EPMTask& );
|
|
|
|
friend class EPMTaskDelegate;
|
|
friend class EPMTaskDispatch;
|
|
friend class EPMTaskGenImpl;
|
|
};
|
|
|
|
#include <epm/libepm_undef.h>
|
|
#endif // TEAMCENTER__EPMTASK__HXX
|