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.

190 lines
7.0 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, EPMActionDelegate
Filename: EPMActionDelegate.hxx
Module: epm
@BMIDE autogenerated
==================================================================================================*/
#ifndef TEAMCENTER__EPMACTIONDELEGATE_HXX
#define TEAMCENTER__EPMACTIONDELEGATE_HXX
#include <common/tc_deprecation_macros.h>
#include <epm/EPMAction.hxx>
#include <epm/libepm_exports.h>
namespace Teamcenter
{
class EPMActionDelegate;
}
namespace Teamcenter
{
class EPMActionImpl;
}
namespace Teamcenter
{
class EPMAction;
}
namespace Teamcenter
{
class EPMActionGenImpl;
}
namespace Teamcenter_alias = ::Teamcenter;
class EPM_API Teamcenter_alias::EPMActionDelegate
{
public:
// Method to initialize this Class
static int initializeClass();
// Method to get the EPMActionDelegate instance
static EPMActionDelegate& getInstance();
// Method to create the EPMActionImpl pointer
static EPMActionImpl* createImpl( EPMAction& ifObj );
// Method to delete the EPMActionImpl pointer
static void deleteImpl( EPMActionImpl* impl );
///
/// 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 getAction_handlersBase(const EPMAction &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for an Integer Property
/// @version Teamcenter 10.1
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getAction_typeBase(const EPMAction &ifObj, 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 getRulesBase(const EPMAction &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const;
///
/// Getter for a Tag Property
/// @version Teamcenter 10.1
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getTasktemplateBase(const EPMAction &ifObj, tag_t &value, bool &isNull ) const;
///
/// 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 setAction_handlersBase(EPMAction &ifObj, const std::vector< tag_t > &values, const std::vector< int > *isNull );
///
/// Setter for an Integer Property
/// @version Teamcenter 10.1
/// @param value - Value to be set for the parameter
/// @param isNull - If true, set the parameter value to null
/// @return - Status. 0 if successful
///
int setAction_typeBase(EPMAction &ifObj, int value, bool isNull );
///
/// 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 setRulesBase(EPMAction &ifObj, const std::vector< tag_t > &values, const std::vector< int > *isNull );
///
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
/// @version Teamcenter 11.2.2
/// @param inputs - A vector of data that contains reference to the object to be refreshed
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @param isLockForDelete - A boolean to indicate if object(s) are to be locked for deletion
/// @param allowRelock - A boolean to indicate if object(s) can be relocked, which will discard all unsaved changes, if already locked by the same user
/// @return - This operation returns ITK_ok on success. Otherwise, it will return specific error code.
///
int fnd0LockBase( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd, const bool isLockForDelete, const bool allowRelock );
///
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
/// @version Teamcenter 11.2.2
/// @param inputs - A vector of data that contains reference to the object to be refreshed
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @return - This operation returns ITK_ok on success. Otherwise, it will return specific error code.
///
int fnd0RefreshBase( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
///
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
/// @version Teamcenter 11.2.2
/// @param inputs - A vector of data that contains reference information to the object to be saved
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @return - This operation returns ITK_ok on success. Otherwise, it will return specific error code.
///
int fnd0SaveBase( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
///
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
/// @version Teamcenter 11.2.2
/// @param inputs - A vector of data that contains reference to the object to be refreshed
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @return - This operation returns ITK_ok on success. Otherwise, it will return specific error code.
///
int fnd0UnlockBase( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
protected:
// Pointer to the instance
static EPMActionDelegate* m_pInstance;
EPMActionDelegate();
virtual ~EPMActionDelegate();
static void setInstance( EPMActionDelegate* instance );
private:
friend class ::Teamcenter::EPMActionGenImpl;
};
#include <epm/libepm_undef.h>
#endif // TEAMCENTER__EPMACTIONDELEGATE_HXX