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.
236 lines
7.5 KiB
236 lines
7.5 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, User_InboxDelegate
|
|
Filename: User_InboxDelegate.hxx
|
|
Module: epm
|
|
@BMIDE autogenerated
|
|
==================================================================================================*/
|
|
|
|
#ifndef TEAMCENTER__USER_INBOXDELEGATE_HXX
|
|
#define TEAMCENTER__USER_INBOXDELEGATE_HXX
|
|
|
|
#include <common/tc_deprecation_macros.h>
|
|
#include <epm/User_Inbox.hxx>
|
|
|
|
#include <epm/libepm_exports.h>
|
|
|
|
namespace Teamcenter
|
|
{
|
|
class User_InboxDelegate;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class User_InboxImpl;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class User_Inbox;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class User_InboxGenImpl;
|
|
}
|
|
|
|
namespace Teamcenter_alias = ::Teamcenter;
|
|
|
|
|
|
class EPM_API Teamcenter_alias::User_InboxDelegate
|
|
{
|
|
public:
|
|
// Method to initialize this Class
|
|
static int initializeClass();
|
|
|
|
// Method to get the User_InboxDelegate instance
|
|
static User_InboxDelegate& getInstance();
|
|
|
|
// Method to create the User_InboxImpl pointer
|
|
static User_InboxImpl* createImpl( User_Inbox& ifObj );
|
|
|
|
// Method to delete the User_InboxImpl pointer
|
|
static void deleteImpl( User_InboxImpl* impl );
|
|
|
|
|
|
///
|
|
/// 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 getEnd_dateBase(const User_Inbox &ifObj, date_t &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 getInbox_delegateBase(const User_Inbox &ifObj, 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 getIs_out_of_officeBase(const User_Inbox &ifObj, 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 getIs_valid_surrogateBase(const User_Inbox &ifObj, bool &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_tasksBase(const User_Inbox &ifObj, int &value, bool &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 getStart_dateBase(const User_Inbox &ifObj, date_t &value, bool &isNull ) const;
|
|
|
|
|
|
///
|
|
/// Getter for a Date 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 getSurrogate_end_datesBase(const User_Inbox &ifObj, std::vector< date_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 getSurrogate_listBase(const User_Inbox &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const;
|
|
|
|
|
|
///
|
|
/// Getter for a Date 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 getSurrogate_st_datesBase(const User_Inbox &ifObj, std::vector< date_t > &values, std::vector< int > &isNull ) const;
|
|
|
|
|
|
///
|
|
/// 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 setEnd_dateBase(User_Inbox &ifObj, const date_t &value, bool isNull );
|
|
|
|
|
|
///
|
|
/// 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 setInbox_delegateBase(User_Inbox &ifObj, const tag_t &value, bool 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 setNew_tasksBase(User_Inbox &ifObj, int value, bool isNull );
|
|
|
|
|
|
///
|
|
/// 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 setStart_dateBase(User_Inbox &ifObj, const date_t &value, bool 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 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 );
|
|
|
|
|
|
///
|
|
/// 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 User_Inbox &ifObj, ::Teamcenter::CreateInput *creInput );
|
|
|
|
|
|
///
|
|
/// desc for setPropertiesFromCreateInpu
|
|
/// @version Tc 8
|
|
/// @param creInput - Description for CreateInput
|
|
/// @return - return desc for setPropertiesFromCreateInput
|
|
///
|
|
int setPropertiesFromCreateInputBase(const User_Inbox &ifObj, ::Teamcenter::CreateInput *creInput );
|
|
|
|
|
|
|
|
protected:
|
|
// Pointer to the instance
|
|
static User_InboxDelegate* m_pInstance;
|
|
|
|
User_InboxDelegate();
|
|
virtual ~User_InboxDelegate();
|
|
static void setInstance( User_InboxDelegate* instance );
|
|
|
|
|
|
private:
|
|
friend class ::Teamcenter::User_InboxGenImpl;
|
|
|
|
};
|
|
|
|
#include <epm/libepm_undef.h>
|
|
#endif // TEAMCENTER__USER_INBOXDELEGATE_HXX
|