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.

178 lines
6.4 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, TaskInboxDelegate
Filename: TaskInboxDelegate.hxx
Module: epm
@BMIDE autogenerated
==================================================================================================*/
#ifndef TEAMCENTER__TASKINBOXDELEGATE_HXX
#define TEAMCENTER__TASKINBOXDELEGATE_HXX
#include <common/tc_deprecation_macros.h>
#include <epm/TaskInbox.hxx>
#include <epm/libepm_exports.h>
namespace Teamcenter
{
class TaskInboxDelegate;
}
namespace Teamcenter
{
class TaskInboxImpl;
}
namespace Teamcenter
{
class TaskInbox;
}
namespace Teamcenter
{
class TaskInboxGenImpl;
}
namespace Teamcenter_alias = ::Teamcenter;
class EPM_API Teamcenter_alias::TaskInboxDelegate
{
public:
// Method to initialize this Class
static int initializeClass();
// Method to get the TaskInboxDelegate instance
static TaskInboxDelegate& getInstance();
// Method to create the TaskInboxImpl pointer
static TaskInboxImpl* createImpl( TaskInbox& ifObj );
// Method to delete the TaskInboxImpl pointer
static void deleteImpl( TaskInboxImpl* impl );
///
/// Getter for a Tag Property
/// @version Teamcenter 10
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0ScheduleTasksBase(const TaskInbox &ifObj, tag_t &value, bool &isNull ) const;
///
/// Getter for a Tag Property
/// @version Teamcenter 11.2
/// @param value - Parameter value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getFnd0SubscriptionMessageBase(const TaskInbox &ifObj, tag_t &value, bool &isNull ) const;
///
/// Getter for an Integer Property
/// @version Teamcenter 10.1
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getNew_tasks_countBase(const TaskInbox &ifObj, int &value, bool &isNull ) const;
///
/// Getter for a Boolean Property
/// @version Teamcenter 10.1
/// @param value - Parameter Value
/// @param isNull - Returns true if the Parameter value is null
/// @return - Status. 0 if successful
///
int getNew_tasks_flagBase(const TaskInbox &ifObj, bool &value, bool &isNull ) const;
///
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
/// @version Teamcenter 11.2.2
/// @param inputs - A vector of data that contains reference to the object to be refreshed
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @param isLockForDelete - A boolean to indicate if object(s) are to be locked for deletion
/// @param allowRelock - A boolean to indicate if object(s) can be relocked, which will discard all unsaved changes, if already locked by the same user
/// @return - This operation returns ITK_ok on success. Otherwise, it will return specific error code.
///
int fnd0LockBase( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd, const bool isLockForDelete, const bool allowRelock );
///
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
/// @version Teamcenter 11.2.2
/// @param inputs - A vector of data that contains reference to the object to be refreshed
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @return - This operation returns ITK_ok on success. Otherwise, it will return specific error code.
///
int fnd0RefreshBase( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
///
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
/// @version Teamcenter 11.2.2
/// @param inputs - A vector of data that contains reference information to the object to be saved
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @return - This operation returns ITK_ok on success. Otherwise, it will return specific error code.
///
int fnd0SaveBase( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
///
/// This operation is not supported now, there will be no support for issues stemming from uses of this operation.
/// @version Teamcenter 11.2.2
/// @param inputs - A vector of data that contains reference to the object to be refreshed
/// @param bd - A data structure to store objects and other information relevant for set-based operation
/// @return - This operation returns ITK_ok on success. Otherwise, it will return specific error code.
///
int fnd0UnlockBase( std::vector< ::Teamcenter::BulkInput* > *inputs, ::Teamcenter::BulkData *bd );
///
/// Description for the Finalize Create Input
/// @version Tc 8
/// @param creInput - desc for creInput parameter
/// @return - Return desc for Initialize for Create
///
int finalizeCreateInputBase(const TaskInbox &ifObj, ::Teamcenter::CreateInput *creInput );
///
/// desc for setPropertiesFromCreateInpu
/// @version Tc 8
/// @param creInput - Description for CreateInput
/// @return - return desc for setPropertiesFromCreateInput
///
int setPropertiesFromCreateInputBase(const TaskInbox &ifObj, ::Teamcenter::CreateInput *creInput );
protected:
// Pointer to the instance
static TaskInboxDelegate* m_pInstance;
TaskInboxDelegate();
virtual ~TaskInboxDelegate();
static void setInstance( TaskInboxDelegate* instance );
private:
friend class ::Teamcenter::TaskInboxGenImpl;
};
#include <epm/libepm_undef.h>
#endif // TEAMCENTER__TASKINBOXDELEGATE_HXX