//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, Cfg0ConfiguratorPerspectiveDelegate Filename: Cfg0ConfiguratorPerspectiveDelegate.hxx Module: Cfg0configurator @BMIDE autogenerated ==================================================================================================*/ #ifndef TEAMCENTER__CFG0CONFIGURATOR__CFG0CONFIGURATORPERSPECTIVEDELEGATE_HXX #define TEAMCENTER__CFG0CONFIGURATOR__CFG0CONFIGURATORPERSPECTIVEDELEGATE_HXX #include #include #include namespace Teamcenter { namespace Cfg0configurator { class Cfg0ConfiguratorPerspectiveDelegate; } } namespace Teamcenter { namespace Cfg0configurator { class Cfg0ConfiguratorPerspectiveImpl; } } namespace Teamcenter { namespace Cfg0configurator { class Cfg0ConfiguratorPerspective; } } namespace Teamcenter { namespace Cfg0configurator { class Cfg0ConfiguratorPerspectiveGenImpl; } } namespace Teamcenter_alias = ::Teamcenter; class CFG0CONFIGURATOR_API Teamcenter_alias::Cfg0configurator::Cfg0ConfiguratorPerspectiveDelegate { public: // Method to initialize this Class static int initializeClass(); // Method to get the Cfg0ConfiguratorPerspectiveDelegate instance static Cfg0ConfiguratorPerspectiveDelegate& getInstance(); // Method to create the Cfg0ConfiguratorPerspectiveImpl pointer static Cfg0ConfiguratorPerspectiveImpl* createImpl( Cfg0ConfiguratorPerspective& ifObj ); // Method to delete the Cfg0ConfiguratorPerspectiveImpl pointer static void deleteImpl( Cfg0ConfiguratorPerspectiveImpl* impl ); /// /// Getter for a Tag Array Property /// @version Teamcenter 11.4 /// @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 getCfg0AvailabilityRulesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 12.3 /// @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 getCfg0ConfigurationModulesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 10.1.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 getCfg0DefaultRulesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Property /// @version Teamcenter 11.2.2 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getCfg0EditContextBase(const Cfg0ConfiguratorPerspective &ifObj, tag_t &value, bool &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 11.5 /// @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 getCfg0EffectivityFamiliesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 11.5 /// @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 getCfg0EffectivityIntentsBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 11.5 /// @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 getCfg0ExceptionRulesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 10.1.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 getCfg0ExcludeRulesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 10.1.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 getCfg0FamilyGroupsBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 11.5 /// @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 getCfg0FeatureFamiliesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 11.5 /// @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 getCfg0FeaturesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 11.5 /// @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 getCfg0FeatureSetsBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 10.1.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 getCfg0IncludeRulesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 10.1.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 getCfg0ModelFamiliesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 10.1.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 getCfg0ModelsBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 10.1.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 getCfg0OptionFamiliesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 10.1.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 getCfg0OptionValuesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 11.5 /// @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 getCfg0PackageRulesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 12.3 /// @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 getCfg0PrivateFamiliesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 12.3 /// @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 getCfg0PrivateValuesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 10.1.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 getCfg0ProductItemsBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 12.3 /// @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 getCfg0PublicFamiliesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Array Property /// @version Teamcenter 12.3 /// @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 getCfg0PublicValuesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Property /// @version Teamcenter 10.1.2 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getCfg0RevisionRuleBase(const Cfg0ConfiguratorPerspective &ifObj, tag_t &value, bool &isNull ) const; /// /// Getter for pre compiled rule set property which searches for datasets that match specified criteria and returns the appropriate timestamp. /// @version Teamcenter 10.1.5 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getCfg0RuleSetCompileDateBase(const Cfg0ConfiguratorPerspective &ifObj, date_t &value, bool &isNull ) const; /// /// Getter for a string Property /// @version Teamcenter 11.2.3 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getCfg0RuleSetEffectivityBase(const Cfg0ConfiguratorPerspective &ifObj, std::string &value, bool &isNull ) const; /// /// Getter for Property Display Value /// @version Teamcenter 11.2.3 /// @param values - Parameter value /// @return - Status. 0 if successful /// int getCfg0RuleSetEffectivityDisplayableValuesBase(Cfg0ConfiguratorPerspective &ifObj, std::vector< std::string > &values ); /// /// Getter for a Tag Array Property /// @version Teamcenter 10.1.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 getCfg0SavedVariantRulesBase(const Cfg0ConfiguratorPerspective &ifObj, std::vector< tag_t > &values, std::vector< int > &isNull ) const; /// /// Getter for a Tag Property /// @version Teamcenter 10.1.2 /// @param value - Parameter value /// @param isNull - Returns true if the Parameter value is null /// @return - Status. 0 if successful /// int getCfg0VariantCriteriaBase(const Cfg0ConfiguratorPerspective &ifObj, tag_t &value, bool &isNull ) const; /// /// Setter for a Tag Property /// @version Teamcenter 11.2.2 /// @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 setCfg0EditContextBase(Cfg0ConfiguratorPerspective &ifObj, const tag_t &value, bool isNull ); /// /// Setter for a Tag Array Property /// @version Teamcenter 10.1.2 /// @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 setCfg0ProductItemsBase(Cfg0ConfiguratorPerspective &ifObj, const std::vector< tag_t > &values, const std::vector< int > *isNull ); /// /// Setter for a Tag Property /// @version Teamcenter 10.1.2 /// @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 setCfg0RevisionRuleBase(Cfg0ConfiguratorPerspective &ifObj, const tag_t &value, bool isNull ); /// /// Setter for pre compiled rule set property which searches for datasets that match input timestamp and compiles a new datset if such a match is not found. /// @version Teamcenter 10.1.5 /// @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 setCfg0RuleSetCompileDateBase(Cfg0ConfiguratorPerspective &ifObj, const date_t &value, bool isNull ); /// /// Setter for a string Property /// @version Teamcenter 11.2.3 /// @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 setCfg0RuleSetEffectivityBase(Cfg0ConfiguratorPerspective &ifObj, const std::string &value, bool isNull ); /// /// Setter for a Tag Property /// @version Teamcenter 10.1.2 /// @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 setCfg0VariantCriteriaBase(Cfg0ConfiguratorPerspective &ifObj, const tag_t &value, bool isNull ); /// /// This is the getter for retrieving the recipe/permanent ID if its been created (and cached on the instance). Every Business Object should implement this operation. /// @version Teamcenter 11.1 /// @param uid - Recipe/permanent ID /// @param isFirstTime - If Session Recovery Uid is yet to be set or does the object need to be serialized again? /// @return - Failure code /// int fnd0AskSRUidBase(const Cfg0ConfiguratorPerspective &ifObj, std::string *uid, bool *isFirstTime ) const; /// /// Generates permanent ID/recipe. Every Business Object should implement this operation. /// @version Teamcenter 11.1 /// @param recipe - Permanent ID/recipe /// @return - Failure code. /// int fnd0GenerateRecipeBase(const Cfg0ConfiguratorPerspective &ifObj, std::string *recipe ); /// /// Gets the current POM serialization state. Runtime Business Object does not need to implement this operation. /// @version Teamcenter 11.1 /// @param currentState - Gets the current POM serialization state. /// @return - Failure code /// int fnd0GetSerializationStateBase(const Cfg0ConfiguratorPerspective &ifObj, bool *currentState ) const; /// /// If Business Object supports recoverable ID. Every Business Object should implement this operation. /// @version Teamcenter 11.1 /// @param isPersistedRecipe - isPersistedRecipe param should be set to true if the recipe is limited to the user session and should be serialized to the database /// @param isRecoverableIDSupported - Returning true indicates support for recoverability/permanent IDs /// @return - Failure code. /// int fnd0IsRecoverableBase(const Cfg0ConfiguratorPerspective &ifObj, bool *isPersistedRecipe, bool *isRecoverableIDSupported ) const; /// /// Sets the current POM serialization state. Runtime Business Object does not need to implement this operation. /// @version Teamcenter 11.1 /// @param newState - true marks the POM serialization recipe as out-of-date, false marks it as up-to-date. /// @param stateChanged - true if the state has changed. /// @return - Failure code /// int fnd0SetSerializationStateBase(const Cfg0ConfiguratorPerspective &ifObj, bool newState, bool *stateChanged ); /// /// This is the setter for the recipe/permanent ID when it is created (to be cached on the instance). Every Business Object should implement this operation. /// @version Teamcenter 11.1 /// @param uid - Rrecipe/permanent ID /// @return - Failure code. /// int fnd0SetSRUidBase(const Cfg0ConfiguratorPerspective &ifObj, const std::string *uid ); protected: // Pointer to the instance static Cfg0ConfiguratorPerspectiveDelegate* m_pInstance; Cfg0ConfiguratorPerspectiveDelegate(); virtual ~Cfg0ConfiguratorPerspectiveDelegate(); static void setInstance( Cfg0ConfiguratorPerspectiveDelegate* instance ); private: friend class ::Teamcenter::Cfg0configurator::Cfg0ConfiguratorPerspectiveGenImpl; }; #include #endif // TEAMCENTER__CFG0CONFIGURATOR__CFG0CONFIGURATORPERSPECTIVEDELEGATE_HXX