IIdGenerator.cs 1.3 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. /* Copyright 2010-present MongoDB Inc.
  2. *
  3. * Licensed under the Apache License, Version 2.0 (the "License");
  4. * you may not use this file except in compliance with the License.
  5. * You may obtain a copy of the License at
  6. *
  7. * http://www.apache.org/licenses/LICENSE-2.0
  8. *
  9. * Unless required by applicable law or agreed to in writing, software
  10. * distributed under the License is distributed on an "AS IS" BASIS,
  11. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12. * See the License for the specific language governing permissions and
  13. * limitations under the License.
  14. */
  15. namespace MongoDB.Bson.Serialization
  16. {
  17. /// <summary>
  18. /// An interface implemented by Id generators.
  19. /// </summary>
  20. public interface IIdGenerator
  21. {
  22. /// <summary>
  23. /// Generates an Id for a document.
  24. /// </summary>
  25. /// <param name="container">The container of the document (will be a MongoCollection when called from the C# driver). </param>
  26. /// <param name="document">The document.</param>
  27. /// <returns>An Id.</returns>
  28. object GenerateId(object container, object document);
  29. /// <summary>
  30. /// Tests whether an Id is empty.
  31. /// </summary>
  32. /// <param name="id">The Id.</param>
  33. /// <returns>True if the Id is empty.</returns>
  34. bool IsEmpty(object id);
  35. }
  36. }