opf.xml

o-r mapping 实现以面向对象的方式建立对关系型数据库的映射。

            <param name="ObjectList">Array holding OPF.BaseObjects or derivatives.</param>
        </member>
        <member name="M:OPF.Collections.Collection.#ctor(OPF.Collections.CollectionFlags,OPF.Collections.Collection)">
            <summary>
            Constructor. Sets the ID to a new GUID and the CollectionFlags, which change the behaviour of 
            the class. See (enumeration)CollectionFlags for additional information.
            It is also possible to give a collection (or derivatives) that will be added immediately 
            to the collection.
            </summary>
            <param name="CollectionFlags">Set the CollectionFlags to change the  behaviour of the collection.</param>
            <param name="Collection">Collection, that is added to the collection.</param>
        </member>
        <member name="M:OPF.Collections.Collection.#ctor(System.Int32)">
            <summary>
            Constructor. Sets the ID to a new GUID. Setting MaxResults will trigger an exception
            during a load if more than MaxResults objects are loaded. 
            </summary>
            <param name="MaxResults">Holds the maximum of objects the collection can contain.</param>
        </member>
        <member name="M:OPF.Collections.Collection.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
            <summary>
            Constructor required for deserialization.
            </summary>
            <param name="SerialInfo">Contains the data to serialize and deserialize the object.</param>
            <param name="StreamContext">Contains the information about the source or target of the 
            serialization process.</param>
        </member>
        <member name="M:OPF.Collections.Collection.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
            <summary>
            Serializes the current object.
            </summary>
            <param name="SerialInfo">Contains the data to serialize and deserialize the object.</param>
            <param name="StreamContext">Contains the information about the source or target of the 
            serialization process.</param>
        </member>
        <member name="M:OPF.Collections.Collection.CheckSupportedAction(OPF.Collections.CollectionFlags)">
            <summary>
            Throws an exception if the functionality that is checked has been disabled 
            by a flag set in the constructor.
            </summary>
            <param name="CollectionFlags">The PersistentFlags enumeration to check.</param>
        </member>
        <member name="M:OPF.Collections.Collection.Add(System.Object)">
            <summary>
            Adds a new object to the collection.
            </summary>
            <param name="Object">The object that is added to the collection.</param>
        </member>
        <member name="M:OPF.Collections.Collection.Add(OPF.Collections.Collection)">
            <summary>
            Add all objects of the given collection to the collection
            </summary>
            <param name="Collection">The objects of the given collection will be added</param>
        </member>
        <member name="M:OPF.Collections.Collection.Equals(System.Object)">
            <summary>
            Compares the current collection with an other collection. 
            Returns true, if the two collections are completely identically, i.e. they contain
            the same objects in the same order.
            </summary>
            <param name="OtherCollection">Other collection to compare with.</param>
        </member>
        <member name="M:OPF.Collections.Collection.GetHashCode">
            <summary>
            Gives back the hashcode. Has to be overridden for Assign.
            </summary>
        </member>
        <member name="M:OPF.Collections.Collection.Assign(OPF.BaseObject)">
            <summary>
            Assigns OtherCollection to the actual collection. After Assign the two collections are
            completely identical.
            </summary>
            <param name="OtherObject">Other object to be assigned to this object.</param>
        </member>
        <member name="M:OPF.Collections.Collection.Clear">
            <summary>
            Clears the whole Collection, without deleting the object from the storage.
            You can use this function for a full reload, ALL internally managed collections will be cleared as well.
            </summary>
        </member>
        <member name="M:OPF.Collections.Collection.Save">
            <summary>
            Saves all objects in the collection and deletes all objects in the deleted list.
            Use this method for normal (standard) save of the collection. Only objects
            that have been changed will be saved. Each object will save itself, i.e. Save
            results in as many queries to the storages as there are changed objects in the collection.
            </summary>
        </member>
        <member name="M:OPF.Collections.Collection.Save(System.Boolean)">
            <summary>
            Saves all objects in the collection. You can save without deleting the objects in the
            deleted list by setting DeleteDeletedList false.
            </summary>
            <param name="DeleteDeletedList">Deletes all objects in the deleted list, if true.</param>
        </member>
        <member name="M:OPF.Collections.Collection.DeleteAllFromStorage">
            <summary>
            Deletes all objects in the collection from storage. 
            The objects in the collection are not removed, so it would be possible to resave all objects in the
            collection.
            </summary>
        </member>
        <member name="M:OPF.Collections.Collection.DeleteAll">
            <summary>
            Deletes all objects in the collection - Not from the storage... Objects will be deleted from 
            storage when saving the collection.
            </summary>
        </member>
        <member name="M:OPF.Collections.Collection.Delete(System.Int32)">
            <summary>
            Deletes an object by index. The object is deleted from the collection and not from storage.
            </summary>
            <param name="Index">Index of the object in the collection.</param>
        </member>
        <member name="M:OPF.Collections.Collection.Delete(OPF.BaseObject)">
            <summary>
            Deletes an object. The object is deleted from the collection and not from storage.
            </summary>
            <param name="Object">The object to delete. The object must have the same hashvalue as the
            object in the collection. Only the hashvalue of the object is used in finding the object to delete
            from the collection.</param>
        </member>
        <member name="M:OPF.Collections.Collection.Remove(System.Object)">
            <summary>
            Deletes an object (same as Delete). The object is removed from the collection and removed from stoarge.
            </summary>
            <param name="Object">The object to delete. The object must be the same as the
            	object in the collection. Only the hashvalue of the object is taken to delete the object 
            	from the collection.</param>
        </member>
        <member name="M:OPF.Collections.Collection.RemoveAt(System.Int32)">
            <summary>
            Deletes an object by index (same as Delete with index). The object is deleted from the collection 
            and from storage.
            </summary>
            <param name="Index">Index of the object in the collection.</param>
        </member>
        <member name="M:OPF.Collections.Collection.RemoveFromCollection(OPF.BaseObject)">
            <summary>
            Removes an object from the collection. The object is not deleted and not moved to the 
            deleted list, it is only removed from the collection.
            </summary>
            <param name="Object">The object to remove. The object must have the same hashvalue as the
            object in the collection. Only the hashvalue of the object is taken to remove the object 
            from the collection.</param>
        </member>
        <member name="M:OPF.Collections.Collection.RemoveFromCollection(System.Int32)">
            <summary>
            Removes an object from the collection. The object is not deleted and not moved to the
            deleted list, it is only removed from the collection.
            </summary>
            <param name="Index">Index of the object to remove.</param>
        </member>
        <member name="M:OPF.Collections.Collection.Load(System.String,OPF.ParameterCollection)">
            <summary>
            Loads or reloads the collection.
            </summary>
            <param name="CollectionName">Name of the collection to load or reload.</param>
            <param name="ParamCollection">Parameter Collection that contains all parameter 
            required by that collection. If one or more parameters are missing then an 
            exception is thrown.</param>
        </member>
        <member name="M:OPF.Collections.Collection.Load(OPF.ParameterCollection)">
            <summary>
            Loads or reloads the Collection. If no collection is loaded, the default collection 
            (named 'default') is tried to be loaded (If found in the DataManager). If a collection has 
            been loaded before, that collection is reloaded with the parameter collection given.
            </summary>
            <param name="ParamCollection">Parameter Collection that contains all parameter 
            required by that collection. If one or more parameters are missing then an 
            exception is thrown.</param>
        </member>
        <member name="M:OPF.Collections.Collection.Reload">
            <summary>
            Reloads the collection. To use reload the collection must be loaded once before or a 
            collection name and parameter collection must be specified earlier.
            </summary>
        </member>
        <member name="M:OPF.Collections.Collection.IsEmpty">
            <summary>
            Returns true if the collection is empty.
            </summary>
        </member>
        <member name="M:OPF.Collections.Collection.IndexOf(System.Object)">
            <summary>
            Returns the position of the specified object in the collection.
            </summary>
            <param name="Object">The object required, that is compared by the hashvalue.</param>
        </member>
        <member name="M:OPF.Collections.Collection.IndexOf(OPF.ID)">
            <summary>
            Returns the position of a certain object in the collection.
            </summary>
            <param name="ObjectID">ID of the object required.</param>
        </member>
        <member name="M:OPF.Collections.Collection.GetObject(System.Int32)">
            <summary>
            Returns the Object at a certain position.
            </summary>
            <param name="Index">Index of the object.</param>
        </member>
        <member name="M:OPF.Collections.Collection.GetDeletedObject(System.Int32)">
            <summary>
            Returns the Object at a certain position in the deleted list.
            </summary>
            <param name="Index">Index of the object.</param>
        </member>
        <member name="M:OPF.Collections.Collection.GetObjectByHashCode(System.Int32)">
            <summary>
            Returns the Object with a the given hashcode.
            </summary>
            <param name="HashCode">Hashcode of the object you need (converted to a string). Use
            GetHashCode of the object to get the hashcode.</param>
        </member>
        <member name="M:OPF.Collections.Collection.Rollback">
            <summary>
            Rollback used while rolling back transactions. Used internally by the DataManager. Don't use this
            function.
            </summary>
        </member>
        <member name="M:OPF.Collections.Collection.Sort(System.Boolean)">
            <summary>
            Sorts the objects in the collection. You have to override the Compare function of the persistent classes
            managed by this collection. If not overwritten nothing will happen, when you try to sort 
            the collection. Not exception is thrown.
            </summary>
            <param name="Reverse">If reverse is true the collection is sorted in the reversed way.</param>
        </member>
        <member name="M:OPF.Collections.Collection.SortByProperty(System.String,System.Boolean)">
            <summary>
            Sorts by a certain property. This function uses reflection to find the property given in the objects
            and to use that property to sort the objects in the collection.
            </summary>
            <param name="PropertyName">The name of the property used by sort.</param>
            <param name="Reverse">If reverse is true the collection is sorted in the reversed way.</param>
        </member>
        <member name="M:OPF.Collections.Collection.SortByProperty(System.String)">
            <summary>
            Sorts by a certain property. This function uses reflection to find the property given in the objects
            and to use that property to sort the objects in the collection.
            </summary>
            <param name="PropertyName">The name of the property used by sort.</param>
        </member>
        <member name="M:OPF.Collections.Collection.GetObject(OPF.ID)">
            <summary>
            Returns a object with a certain ID. The object must be in the collection and not in the
            deleted list to be returned.
            </summary>
            <param name="ObjectID">ID of the object you need.</param>
        </member>
        <member name="M:OPF.Collections.Collection.GetDeletedObject(OPF.ID)">
            <summary>
            Returns a deleted object with a certain ID. The object must be in the deleted list and not in 
            the collection to be returned.
            </summary>
            <param name="ObjectID">ID of the object you need.</param>
        </member>
        <member name="M:OPF.Collections.Collection.IsLoaded">
            <summary>
            Returns if the collection is loaded or not.
            </summary>