Autodesk FDO Provider for SQL Server API Reference

SQLServer Provider API

API Reference Autodesk FDO Provider for SQL Server

SqlServerOvDataPropertyDefinition.h

Go to the documentation of this file.
00001 #ifndef FDO_SqlServerOVDATAPROPERTYDEFINITION_H
00002 #define FDO_SqlServerOVDATAPROPERTYDEFINITION_H
00003 
00004 //
00005 //
00006 // (C) Copyright 1990-2005 by Autodesk, Inc.
00007 //
00008 //
00009 //
00010 // By using this code, you are agreeing to the terms
00011 // and conditions of the License Agreement that appeared
00012 // and was accepted upon download or installation
00013 // (or in connection with the download or installation)
00014 // of the Autodesk software in which this code is included.
00015 // All permissions on use of this code are as set forth
00016 // in such License Agreement provided that the above copyright
00017 // notice appears in all authorized copies and that both that
00018 // copyright notice and the limited warranty and
00019 // restricted rights notice below appear in all supporting
00020 // documentation.
00021 //
00022 // AUTODESK PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS.
00023 // AUTODESK SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
00024 // MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  AUTODESK, INC.
00025 // DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
00026 // UNINTERRUPTED OR ERROR FREE.
00027 //
00028 // Use, duplication, or disclosure by the U.S. Government is subject to
00029 // restrictions set forth in FAR 52.227-19 (Commercial Computer
00030 // Software - Restricted Rights) and DFAR 252.227-7013(c)(1)(ii)
00031 // (Rights in Technical Data and Computer Software), as applicable.
00032 //
00033 #include <FdoCommon.h>
00034 #include <Rdbms/Override/RdbmsOvDataPropertyDefinition.h>
00035 #include <Rdbms/Override/SqlServer/SqlServerOv.h>
00036 #include <Rdbms/Override/SqlServer/SqlServerOvColumn.h>
00037 #include <Rdbms/Override/SqlServer/SqlServerOvPropertyDefinition.h>
00038 
00039 /// \brief
00040 /// Concrete class defining physical schema overrides for a data property definition.
00041 class FdoSqlServerOvDataPropertyDefinition : public FdoRdbmsOvDataPropertyDefinition, public FdoSqlServerOvPropertyDefinition
00042 {
00043 public:
00044     /// \brief
00045     /// Constructs a default of an FdoSqlServerOvDataPropertyDefinition
00046     /// 
00047     /// \return
00048     /// Returns FdoSqlServerOvDataPropertyDefinition
00049     /// 
00050     FDOSQLSERVER_OV_API static FdoSqlServerOvDataPropertyDefinition* Create();
00051 
00052     /// \brief
00053     /// Constructs an instance of an FdoSqlServerOvDataPropertyDefinition using the specified arguments
00054     /// 
00055     /// \param name 
00056     /// Input name
00057     /// 
00058     /// \return
00059     /// Returns FdoSqlServerOvDataPropertyDefinition
00060     /// 
00061     FDOSQLSERVER_OV_API static FdoSqlServerOvDataPropertyDefinition* Create(FdoString* name);
00062 
00063     /// \brief
00064     /// Gets the SqlServer column
00065     /// 
00066     /// \return
00067     /// Returns the SqlServer column
00068     /// 
00069     FDOSQLSERVER_OV_API FdoSqlServerOvColumn* GetColumn();
00070 
00071     /// \brief
00072     /// Sets the SqlServer column
00073     /// 
00074     /// \return
00075     /// Returns nothing
00076     /// 
00077     FDOSQLSERVER_OV_API void SetColumn(FdoSqlServerOvColumn *column);
00078 
00079 /* //TODO: enable this code when FdoSQLServerOvValidPropertyValueConstraint is ready
00080 
00081     /// \brief
00082     /// Get the single ValidPropertyValueConstraint
00083     /// 
00084     /// \return
00085     /// Returns the single ValidPropertyValueConstraint
00086     /// 
00087     FDOSQLSERVER_OV_API FdoSQLServerOvValidPropertyValueConstraint* GetValidPropertyValueConstraint();
00088 
00089     /// \brief
00090     /// Set the single ValidPropertyValueConstraint
00091     /// 
00092     /// \return
00093     /// Returns nothing
00094     /// 
00095     FDOSQLSERVER_OV_API void SetValidPropertyValueConstraint(FdoSQLServerOvValidPropertyValueConstraint* validPropertyValueConstraint);
00096 */
00097 
00098 /// \cond DOXYGEN-IGNORE
00099 
00100 /// \endcond
00101 
00102 protected:
00103     FdoSqlServerOvDataPropertyDefinition();
00104     FdoSqlServerOvDataPropertyDefinition(FdoString* name);
00105     virtual ~FdoSqlServerOvDataPropertyDefinition();
00106     virtual void Dispose();
00107 
00108 private:
00109 };
00110 
00111 
00112 /// \brief
00113 /// FdoSqlServerOvDataPropertyP is a FdoPtr on FdoSqlServerOvDataPropertyDefinition, provided for convenience.
00114 typedef FdoPtr<FdoSqlServerOvDataPropertyDefinition> FdoSqlServerOvDataPropertyP;
00115 
00116 #endif
00117 
00118 

Comments?