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.
239 lines
8.9 KiB
239 lines
8.9 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, SavedSearchDelegate
|
|
Filename: SavedSearchDelegate.hxx
|
|
Module: qry
|
|
@BMIDE autogenerated
|
|
==================================================================================================*/
|
|
|
|
#ifndef TEAMCENTER__SAVEDSEARCHDELEGATE_HXX
|
|
#define TEAMCENTER__SAVEDSEARCHDELEGATE_HXX
|
|
|
|
#include <common/tc_deprecation_macros.h>
|
|
#include <qry/SavedSearch.hxx>
|
|
|
|
#include <qry/libqry_exports.h>
|
|
|
|
namespace Teamcenter
|
|
{
|
|
class SavedSearchDelegate;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class SavedSearchImpl;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class SavedSearch;
|
|
}
|
|
namespace Teamcenter
|
|
{
|
|
class SavedSearchGenImpl;
|
|
}
|
|
|
|
namespace Teamcenter_alias = ::Teamcenter;
|
|
|
|
|
|
class QRY_API Teamcenter_alias::SavedSearchDelegate
|
|
{
|
|
public:
|
|
// Method to initialize this Class
|
|
static int initializeClass();
|
|
|
|
// Method to get the SavedSearchDelegate instance
|
|
static SavedSearchDelegate& getInstance();
|
|
|
|
// Method to create the SavedSearchImpl pointer
|
|
static SavedSearchImpl* createImpl( SavedSearch& ifObj );
|
|
|
|
// Method to delete the SavedSearchImpl pointer
|
|
static void deleteImpl( SavedSearchImpl* impl );
|
|
|
|
|
|
///
|
|
/// Getter for a string Property
|
|
/// @version Teamcenter 8.1
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getSavedsearch_adhoc_classBase(const SavedSearch &ifObj, std::string &value, bool &isNull ) const;
|
|
|
|
|
|
///
|
|
/// Getter for an String Array Property
|
|
/// @version Teamcenter 8.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 getSavedsearch_attr_namesBase(const SavedSearch &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const;
|
|
|
|
|
|
///
|
|
/// Getter for an String Array Property
|
|
/// @version Teamcenter 8.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 getSavedsearch_attr_valuesBase(const SavedSearch &ifObj, std::vector< std::string > &values, std::vector< int > &isNull ) const;
|
|
|
|
|
|
///
|
|
/// Getter for a Tag Property
|
|
/// @version Teamcenter 8.1
|
|
/// @param value - Parameter value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getSavedsearch_queryBase(const SavedSearch &ifObj, tag_t &value, bool &isNull ) const;
|
|
|
|
|
|
///
|
|
/// Getter for a Boolean Property
|
|
/// @version Teamcenter 8.1
|
|
/// @param value - Parameter Value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getSavedsearch_result_typeBase(const SavedSearch &ifObj, bool &value, bool &isNull ) const;
|
|
|
|
|
|
///
|
|
/// Getter for a Boolean Property
|
|
/// @version Teamcenter 8.1
|
|
/// @param value - Parameter Value
|
|
/// @param isNull - Returns true if the Parameter value is null
|
|
/// @return - Status. 0 if successful
|
|
///
|
|
int getSharedBase(const SavedSearch &ifObj, bool &value, bool &isNull ) const;
|
|
|
|
|
|
///
|
|
/// Setter for a string Property
|
|
/// @version Teamcenter 8.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 setSavedsearch_adhoc_classBase(SavedSearch &ifObj, const std::string &value, bool isNull );
|
|
|
|
|
|
///
|
|
/// Setter for a Boolean Property
|
|
/// @version Teamcenter 8.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 setSavedsearch_result_typeBase(SavedSearch &ifObj, bool value, bool isNull );
|
|
|
|
|
|
///
|
|
/// Setter for a Boolean Property
|
|
/// @version Teamcenter 8.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 setSharedBase(SavedSearch &ifObj, bool value, bool isNull );
|
|
|
|
|
|
///
|
|
/// This operation returns the children to be displayed when expanding this object.
|
|
/// @version Teamcenter 10
|
|
/// @param propertyNames - The list of propertyNames to expand. If empty, then the properties defined in <TYPE>_DefaultChildProperties and <TYPE>_DefaultPseudoFolder are returned.
|
|
/// @param childTags - Tags of children.
|
|
/// @param childContextPropertyNames - The propertyName in which this child exists in the parent.
|
|
/// @return - status
|
|
///
|
|
int fnd0GetChildrenBase(const SavedSearch &ifObj, const std::vector< std::string > *propertyNames, std::vector< tag_t > *childTags, std::vector< std::string > *childContextPropertyNames );
|
|
|
|
|
|
///
|
|
/// 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 );
|
|
|
|
|
|
///
|
|
/// desc for createPost
|
|
/// @version Tc 8
|
|
/// @param creInput - Description for the Create Input
|
|
/// @return - return desc for createPost
|
|
///
|
|
int createPostBase(const SavedSearch &ifObj, ::Teamcenter::CreateInput *creInput );
|
|
|
|
|
|
///
|
|
/// desc for validate for create
|
|
/// @version Tc 8
|
|
/// @param creInput - desc for creInput parameter
|
|
/// @return - ret desc for validate for create
|
|
///
|
|
int validateCreateInputBase(const SavedSearch &ifObj, ::Teamcenter::CreateInput *creInput );
|
|
|
|
|
|
|
|
protected:
|
|
// Pointer to the instance
|
|
static SavedSearchDelegate* m_pInstance;
|
|
|
|
SavedSearchDelegate();
|
|
virtual ~SavedSearchDelegate();
|
|
static void setInstance( SavedSearchDelegate* instance );
|
|
|
|
|
|
private:
|
|
friend class ::Teamcenter::SavedSearchGenImpl;
|
|
|
|
};
|
|
|
|
#include <qry/libqry_undef.h>
|
|
#endif // TEAMCENTER__SAVEDSEARCHDELEGATE_HXX
|