PageRenderTime 67ms CodeModel.GetById 24ms RepoModel.GetById 0ms app.codeStats 0ms

/Bowling/Bowling.Domain/XmlDocument.xml

https://github.com/edqwerty1/Bowling
XML | 943 lines | 931 code | 12 blank | 0 comment | 0 complexity | 5cd7d0bc5406e8c64d7c4ec0b132c84a MD5 | raw file
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Bowling.Domain</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Bowling.Domain.Abstract.IRepository`1">
  8. <summary>
  9. Interface for all repository iplementations
  10. </summary>
  11. <typeparam name="T">Type of the entities in the repository</typeparam>
  12. </member>
  13. <member name="M:Bowling.Domain.Abstract.IRepository`1.GetAll">
  14. <summary>
  15. Get all items from the repository
  16. </summary>
  17. <returns>Queryable containing all items in the repository</returns>
  18. </member>
  19. <member name="M:Bowling.Domain.Abstract.IRepository`1.GetAsync(System.Func{System.Linq.IQueryable{`0},System.Linq.IQueryable{`0}},System.Threading.CancellationToken)">
  20. <summary>
  21. Retrieves all items in the repository satisfied by the specified query asynchronously.
  22. </summary>
  23. <param name="queryShaper">The <see cref="T:System.Func`2">function</see> that shapes the <see cref="T:System.Linq.IQueryable`1">query</see> to execute.</param>
  24. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken">cancellation token</see> that can be used to cancel the operation.</param>
  25. <returns>A <see cref="T:System.Threading.Tasks.Task`1">task</see> containing the retrieved <see cref="T:System.Collections.Generic.IEnumerable`1">sequence</see>
  26. of <typeparamref name="T">items</typeparamref>.</returns>
  27. <example>The following example demonstrates how to paginate the items in a repository using an example query.
  28. <code><![CDATA[
  29. using Microsoft.DesignPatterns.Examples;
  30. using System;
  31. using System.Collections.Generic;
  32. using System.Linq;
  33. using System.Threading;
  34. using System.Threading.Tasks;
  35. public async static void Main()
  36. {
  37. var index = 0;
  38. var repository = new MyRepository();
  39. var cancellationToken = new CancellationToken();
  40. foreach ( var item in await repository.GetAsync( q => q.Where( i => i.FirstName.StartsWith( "Jo" ) ).OrderBy( i => i.LastName ), cancellationToken );
  41. Console.WriteLine( i => i.ToString() );
  42. }
  43. ]]>
  44. </code></example>
  45. </member>
  46. <member name="M:Bowling.Domain.Abstract.IRepository`1.GetAsync``1(System.Func{System.Linq.IQueryable{`0},``0},System.Threading.CancellationToken)">
  47. <summary>
  48. Retrieves a query result asynchronously.
  49. </summary>
  50. <typeparam name="TResult">The <see cref="T:System.Type">type</see> of result to retrieve.</typeparam>
  51. <param name="queryShaper">The <see cref="T:System.Func`2">function</see> that shapes the <see cref="T:System.Linq.IQueryable`1">query</see> to execute.</param>
  52. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken">cancellation token</see> that can be used to cancel the operation.</param>
  53. <returns>A <see cref="T:System.Threading.Tasks.Task`1">task</see> containing the <typeparamref name="TResult">result</typeparamref> of the operation.</returns>
  54. </member>
  55. <member name="M:Bowling.Domain.Abstract.IRepository`1.Search(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
  56. <summary>
  57. Basic search method that allows filtering on the repository based on
  58. a boolean predicate.
  59. </summary>
  60. <param name="where">Where clause for the search</param>
  61. <returns>Queryable of the search results</returns>
  62. </member>
  63. <member name="M:Bowling.Domain.Abstract.IRepository`1.Single(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
  64. <summary>
  65. Search and return a single entity using a where clause
  66. </summary>
  67. <param name="where">Where clause</param>
  68. <returns>Result entity</returns>
  69. </member>
  70. <member name="M:Bowling.Domain.Abstract.IRepository`1.Single(System.Func{System.Linq.IQueryable{`0},System.Linq.IQueryable{`0}})">
  71. <summary>
  72. Search and return a single entity using a query function
  73. </summary>
  74. <param name="query">Query function</param>
  75. <returns>Result entity</returns>
  76. </member>
  77. <member name="M:Bowling.Domain.Abstract.IRepository`1.GetById(System.Int32)">
  78. <summary>
  79. Get entity by the id
  80. </summary>
  81. <param name="id">Guid of the entity</param>
  82. <returns>Result entity</returns>
  83. </member>
  84. <member name="M:Bowling.Domain.Abstract.IRepository`1.First(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
  85. <summary>
  86. Search and return the first entity that matches the given where clause
  87. </summary>
  88. <param name="where">Where clause</param>
  89. <returns>Result entity</returns>
  90. </member>
  91. <member name="M:Bowling.Domain.Abstract.IRepository`1.First(System.Func{System.Linq.IQueryable{`0},System.Linq.IQueryable{`0}})">
  92. <summary>
  93. Search and return the first entity matching the given query
  94. </summary>
  95. <param name="query">Query</param>
  96. <returns>Result entity</returns>
  97. </member>
  98. <member name="M:Bowling.Domain.Abstract.IRepository`1.Delete(`0)">
  99. <summary>
  100. Delete the given entity from the repository
  101. </summary>
  102. <param name="entity">Entity to delete</param>
  103. </member>
  104. <member name="M:Bowling.Domain.Abstract.IRepository`1.Add(`0)">
  105. <summary>
  106. Add the given entity to the repository
  107. </summary>
  108. <param name="entity">Entity to add</param>
  109. </member>
  110. <member name="M:Bowling.Domain.Abstract.IRepository`1.AddRange(System.Collections.Generic.IEnumerable{`0})">
  111. <summary>
  112. Add a collection of new entities to the repository. This can be more efficient
  113. than adding the entities one by one.
  114. </summary>
  115. <param name="entities">Range of entities to add</param>
  116. </member>
  117. <member name="M:Bowling.Domain.Abstract.IRepository`1.Attach(`0)">
  118. <summary>
  119. Attach the gievn entity
  120. </summary>
  121. <param name="entity">Entity to attach</param>
  122. </member>
  123. <member name="M:Bowling.Domain.Abstract.IRepository`1.Lock(`0)">
  124. <summary>
  125. Obtain a lock on a specific entity where possible.
  126. Also refreshes the entity after obtaining the lock
  127. </summary>
  128. <param name="entity">Entity to lock</param>
  129. </member>
  130. <member name="M:Bowling.Domain.Abstract.IRepository`1.Lock(System.Int32,System.String,System.Type)">
  131. <summary>
  132. Lock the specific entity where possible. Find the entity via the given id,
  133. table and type
  134. </summary>
  135. <param name="id">Id of the entity being locked</param>
  136. <param name="table">Table that the entity being locked belongs to</param>
  137. <param name="entType">Type of the entity being locked</param>
  138. </member>
  139. <member name="M:Bowling.Domain.Abstract.IRepository`1.Refresh(`0)">
  140. <summary>
  141. Refresh the given entity
  142. </summary>
  143. <param name="entity">Entity to refresh</param>
  144. </member>
  145. <member name="T:Bowling.Domain.Abstract.IUnitOfWork">
  146. <summary>
  147. Interface for the unit of work. A group of database changes to be committed at once.
  148. </summary>
  149. </member>
  150. <member name="M:Bowling.Domain.Abstract.IUnitOfWork.Commit">
  151. <summary>
  152. Commit the unit of work
  153. </summary>
  154. </member>
  155. <member name="M:Bowling.Domain.Abstract.IUnitOfWork.CommitAsync">
  156. <summary>
  157. Commit the unit of work
  158. </summary>
  159. </member>
  160. <member name="M:Bowling.Domain.Abstract.IUnitOfWork.ContainsLockKey(System.Type,System.Int32)">
  161. <summary>
  162. Check of the required entity is locked and has an entry in the lock table
  163. </summary>
  164. <param name="entity">Type of the entity being checked</param>
  165. <param name="i">Id of the entity being checked</param>
  166. <returns>Whether the lock table contains the lock key for the given entity</returns>
  167. </member>
  168. <member name="M:Bowling.Domain.Abstract.IUnitOfWork.AddToLockTable(System.Type,System.Int32)">
  169. <summary>
  170. Add the given entity to the lock table
  171. </summary>
  172. <param name="entity">Entity to add to the lock table</param>
  173. <param name="i">Id of entity to add to the lock table</param>
  174. </member>
  175. <member name="M:Bowling.Domain.Abstract.UnitOfWork.Dispose">
  176. <summary>
  177. This clears up everything associated with the transaction.
  178. </summary>
  179. </member>
  180. <member name="T:Bowling.Domain.Concrete.EntityFramework.BaseContext">
  181. <summary>
  182. Base database context from which all other database contexts will be extended
  183. </summary>
  184. </member>
  185. <member name="T:Bowling.Domain.Concrete.EntityFramework.IDbContext">
  186. <summary>
  187. Interface for database contexts
  188. </summary>
  189. </member>
  190. <member name="M:Bowling.Domain.Concrete.EntityFramework.IDbContext.SaveChanges">
  191. <summary>
  192. Save the changes to all entities within the current context
  193. </summary>
  194. <returns>Error code</returns>
  195. </member>
  196. <member name="M:Bowling.Domain.Concrete.EntityFramework.IDbContext.SaveChangesAsync">
  197. <summary>
  198. Save the changes to all entities within the current context
  199. </summary>
  200. <returns>Error code</returns>
  201. </member>
  202. <member name="M:Bowling.Domain.Concrete.EntityFramework.IDbContext.Set``1">
  203. <summary>
  204. Returns a DbSet for the current entity type
  205. </summary>
  206. <typeparam name="TEntity">The entity type</typeparam>
  207. <returns>DbSet</returns>
  208. </member>
  209. <member name="M:Bowling.Domain.Concrete.EntityFramework.IDbContext.Lock(System.Int32,System.String,System.Type)">
  210. <summary>
  211. This obtains an update lock on a given row by ID, or waits until it can get one (or times out).
  212. </summary>
  213. <param name="id">Id of entity to lock</param>
  214. <param name="table">Table to get the lock on</param>
  215. <param name="entType">Type of the entity being locked</param>
  216. <returns></returns>
  217. </member>
  218. <member name="M:Bowling.Domain.Concrete.EntityFramework.IDbContext.Refresh(System.Object)">
  219. <summary>
  220. This refreshes the contents of a given object from the database.
  221. </summary>
  222. <param name="entity">Object to be refreshed</param>
  223. </member>
  224. <member name="M:Bowling.Domain.Concrete.EntityFramework.IDbContext.Entry(System.Object)">
  225. <summary>
  226. Gets a System.Data.Entity.Infrastructure.DbEntityEntry object for the given entity
  227. </summary>
  228. <param name="entity">Entity to use</param>
  229. <returns>DbEntityEntry</returns>
  230. </member>
  231. <member name="M:Bowling.Domain.Concrete.EntityFramework.BaseContext.#cctor">
  232. <summary>
  233. Static constructor to create an empty context
  234. </summary>
  235. </member>
  236. <member name="M:Bowling.Domain.Concrete.EntityFramework.BaseContext.#ctor(System.String)">
  237. <summary>
  238. Constructor creating a database context from a given connection string
  239. </summary>
  240. <param name="nameOrConnectionString">Connection string</param>
  241. </member>
  242. <member name="M:Bowling.Domain.Concrete.EntityFramework.BaseContext.#ctor(System.Data.Common.DbConnection)">
  243. <summary>
  244. Constructor creating a database context from a given database connection
  245. </summary>
  246. <param name="dbConnection">Database connection</param>
  247. </member>
  248. <member name="M:Bowling.Domain.Concrete.EntityFramework.BaseContext.OnModelCreating(System.Data.Entity.DbModelBuilder)">
  249. <summary>
  250. Model creating event
  251. </summary>
  252. <param name="modelBuilder">Model builder object being used</param>
  253. </member>
  254. <member name="M:Bowling.Domain.Concrete.EntityFramework.BaseContext.Lock(System.Int32,System.String,System.Type)">
  255. <summary>
  256. This obtains an update lock on a given row by ID, or waits until it can get one (or times out).
  257. </summary>
  258. <param name="id">Row id to lock</param>
  259. <param name="table">Table to update the lock on</param>
  260. <param name="entType">Type of the entity being locked</param>
  261. </member>
  262. <member name="M:Bowling.Domain.Concrete.EntityFramework.BaseContext.Refresh(System.Object)">
  263. <summary>
  264. This refreshes the contents of a given object from the database.
  265. </summary>
  266. <param name="entity">Entity to refresh</param>
  267. </member>
  268. <member name="M:Bowling.Domain.Concrete.EntityFramework.BaseContext.SaveChanges">
  269. <summary>
  270. Calls the DbContext SaveChanges. If it fails validation, it will be handled with our own exception
  271. </summary>
  272. <returns>Error code</returns>
  273. </member>
  274. <member name="M:Bowling.Domain.Concrete.EntityFramework.BaseContext.SaveChangesAsync">
  275. <summary>
  276. Calls the DbContext SaveChanges. If it fails validation, it will be handled with our own exception
  277. </summary>
  278. <returns>Error code</returns>
  279. </member>
  280. <member name="P:Bowling.Domain.Concrete.EntityFramework.BaseContext.NamespaceDataContext">
  281. <summary>
  282. Name space for context
  283. </summary>
  284. <returns>Name space</returns>
  285. </member>
  286. <member name="P:Bowling.Domain.Concrete.EntityFramework.BaseContext.Schema">
  287. <summary>
  288. Schema for the context
  289. </summary>
  290. <returns>Schema</returns>
  291. </member>
  292. <member name="T:Bowling.Domain.Concrete.EntityFramework.BaseEntityMap`1">
  293. <summary>
  294. Base Entity Framework mapping class for Insight domain entities. This class
  295. configures the attributes on the base entity and also properties on the specified
  296. domain entity type by looking at settings provided via the SymEntity attribute
  297. and properties specified by the Field Definitions for the class.
  298. </summary>
  299. <typeparam name="T">The type of the entity being mapped</typeparam>
  300. </member>
  301. <member name="M:Bowling.Domain.Concrete.EntityFramework.BaseEntityMap`1.#ctor">
  302. <summary>
  303. Constructor creating the default mappings on all entities
  304. </summary>
  305. </member>
  306. <member name="T:Bowling.Domain.Concrete.EntityFramework.DataContext">
  307. <summary>
  308. Context for the main database
  309. </summary>
  310. </member>
  311. <member name="M:Bowling.Domain.Concrete.EntityFramework.DataContext.#cctor">
  312. <summary>
  313. Static constructor to create an empty data context. If we are building the database instruct
  314. the system to create a database if it doesn't exst. This cannot be used for normal usage as
  315. it is incompatible with caching
  316. </summary>
  317. </member>
  318. <member name="M:Bowling.Domain.Concrete.EntityFramework.DataContext.#ctor(System.String)">
  319. <summary>
  320. Constructor to create a data context from the given connection string,
  321. setting whether it is a management database
  322. </summary>
  323. <param name="connectionString">Connection string</param>
  324. <param name="managementModelOnly">Management model only</param>
  325. </member>
  326. <member name="M:Bowling.Domain.Concrete.EntityFramework.DataContext.#ctor">
  327. <summary>
  328. Constructor to create a data context from the stored connection string,
  329. setting whether it is a management database
  330. </summary>
  331. <param name="managementContext">Management model only</param>
  332. </member>
  333. <member name="T:Bowling.Domain.Concrete.EntityFramework.EFRepository`1">
  334. <summary>
  335. Base generic repository implementation
  336. </summary>
  337. <typeparam name="T">Type of the repository</typeparam>
  338. </member>
  339. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.#ctor">
  340. <summary>
  341. Costructor
  342. </summary>
  343. </member>
  344. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.GetCurrentUnitOfWork``1">
  345. <summary>
  346. Get the current Unit of Work
  347. </summary>
  348. <typeparam name="TUnitOfWork">The type of the unit of work</typeparam>
  349. <returns>Current unit of work</returns>
  350. </member>
  351. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.GetAll">
  352. <summary>
  353. Get all data from the dbSet. This takes into account the valid partitions for the user
  354. </summary>
  355. <returns>IQueriable containing all data</returns>
  356. </member>
  357. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.GetAllLocal">
  358. <summary>
  359. Get all data from the dbSet. This takes into account the valid partitions for the user
  360. </summary>
  361. <returns>IQueriable containing all data</returns>
  362. </member>
  363. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.GetAsync(System.Func{System.Linq.IQueryable{`0},System.Linq.IQueryable{`0}},System.Threading.CancellationToken)">
  364. <summary>
  365. Retrieves all items in the repository satisfied by the specified query asynchronously.
  366. </summary>
  367. <param name="queryShaper">The <see cref="T:System.Func`2">function</see> that shapes the <see cref="T:System.Linq.IQueryable`1">query</see> to execute.</param>
  368. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken">cancellation token</see> that can be used to cancel the operation.</param>
  369. <returns>A <see cref="T:System.Threading.Tasks.Task`1">task</see> containing the retrieved <see cref="T:System.Collections.Generic.IEnumerable`1">sequence</see> of <typeparamref name="T">items</typeparamref>.</returns>
  370. </member>
  371. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.GetAsync``1(System.Func{System.Linq.IQueryable{`0},``0},System.Threading.CancellationToken)">
  372. <summary>
  373. Retrieves a query result asynchronously.
  374. </summary>
  375. <typeparam name="TResult">The <see cref="T:System.Type">type</see> of result to retrieve.</typeparam>
  376. <param name="queryShaper">The <see cref="T:System.Func`2">function</see> that shapes the <see cref="T:System.Linq.IQueryable`1">query</see> to execute.</param>
  377. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken">cancellation token</see> that can be used to cancel the operation.</param>
  378. <returns>A <see cref="T:System.Threading.Tasks.Task`1">task</see> containing the <typeparamref name="TResult">result</typeparamref> of the operation.</returns>
  379. </member>
  380. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.Search(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
  381. <summary>
  382. Search the dbSet with the given expression. This takes into account valid partitions
  383. for the user
  384. </summary>
  385. <param name="where">Expression used to search the data</param>
  386. <returns>IQueryable containing result data</returns>
  387. </member>
  388. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.Single(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
  389. <summary>
  390. Get a single entity from the dbSet defined by the given where clause. This takes
  391. into account valid partitions for the user
  392. </summary>
  393. <param name="where">Expression used to search the data</param>
  394. <returns>IQueryable containing result data</returns>
  395. </member>
  396. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.Single(System.Func{System.Linq.IQueryable{`0},System.Linq.IQueryable{`0}})">
  397. <summary>
  398. Get a single entity from the dbSet defined by the given query. This takes
  399. into account valid partitions for the user
  400. </summary>
  401. <param name="query">Query used to search the data</param>
  402. <returns>IQueryable containing result data</returns>
  403. </member>
  404. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.GetById(System.Int32)">
  405. <summary>
  406. Get entity by the id
  407. </summary>
  408. <param name="id">Guid of the entity</param>
  409. <returns>Result entity</returns>
  410. </member>
  411. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.First(System.Linq.Expressions.Expression{System.Func{`0,System.Boolean}})">
  412. <summary>
  413. Get the first entity from the dbSet defined by the given where clause. This takes
  414. into account valid partitions for the user
  415. </summary>
  416. <param name="where">Expression used to search the data</param>
  417. <returns>IQueryable containing result data</returns>
  418. </member>
  419. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.First(System.Func{System.Linq.IQueryable{`0},System.Linq.IQueryable{`0}})">
  420. <summary>
  421. Get the first entity from the dbSet defined by the given query. This takes
  422. into account valid partitions for the user
  423. </summary>
  424. <param name="query">Query used to search the data</param>
  425. <returns>IQueryable containing result data</returns>
  426. </member>
  427. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.Delete(`0)">
  428. <summary>
  429. Delete the given entity from the data set
  430. </summary>
  431. <param name="entity">Entity to be deleted</param>
  432. </member>
  433. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.Add(`0)">
  434. <summary>
  435. Add the given entity to the data set
  436. </summary>
  437. <param name="entity">Entity to be added</param>
  438. </member>
  439. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.AddRange(System.Collections.Generic.IEnumerable{`0})">
  440. <summary>
  441. Add a range of entities to the data set
  442. </summary>
  443. <param name="entities">Range of entities to be added</param>
  444. </member>
  445. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.Attach(`0)">
  446. <summary>
  447. Attaches the given entity to the context underlying the set. That is, the entity
  448. is placed into the context in the Unchanged state, just as if it had been read from the database.
  449. </summary>
  450. <param name="entity">The entity to be attached</param>
  451. </member>
  452. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.Lock(`0)">
  453. <summary>
  454. Lock the given entity in the data set
  455. </summary>
  456. <param name="entity">The entity to be locked</param>
  457. </member>
  458. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.Lock(System.Int32,System.String,System.Type)">
  459. <summary>
  460. This obtains an update lock on a given row by ID, or waits until it can get one (or times out).
  461. </summary>
  462. <param name="id">Id of the entity to be locked</param>
  463. <param name="table">Table in which the entity is stored</param>
  464. <param name="entType">Type of the entity</param>
  465. </member>
  466. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.Refresh(`0)">
  467. <summary>
  468. This refreshes the contents of a given object from the database.
  469. </summary>
  470. <param name="entity">The entity to be refreshed</param>
  471. </member>
  472. <member name="P:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.Context">
  473. <summary>
  474. The context on wich the repository is based.
  475. </summary>
  476. <returns>Context</returns>
  477. </member>
  478. <member name="P:Bowling.Domain.Concrete.EntityFramework.EFRepository`1.DbSet">
  479. <summary>
  480. The dbSet object retrieved from the context
  481. </summary>
  482. <returns>DbSet</returns>
  483. </member>
  484. <member name="T:Bowling.Domain.Concrete.EntityFramework.EFUnitOfWork">
  485. <summary>
  486. Entity framework unit of work. A set of changes to be committed at one time
  487. </summary>
  488. </member>
  489. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFUnitOfWork.#ctor(System.Func{Bowling.Domain.Concrete.EntityFramework.IDbContext})">
  490. <summary>
  491. Constructor creating the unit of work from functions defining the
  492. various contexts
  493. </summary>
  494. <param name="dataContextFunc">Function returning the data context</param>
  495. </member>
  496. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFUnitOfWork.ContextFor``1">
  497. <summary>
  498. Return the correct context for the given type parameter
  499. </summary>
  500. <typeparam name="T">Type</typeparam>
  501. <returns>Context</returns>
  502. </member>
  503. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFUnitOfWork.Commit">
  504. <summary>
  505. Commit the unit of work to the database
  506. </summary>
  507. </member>
  508. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFUnitOfWork.CommitAsync">
  509. <summary>
  510. Commit the unit of work to the database
  511. </summary>
  512. </member>
  513. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFUnitOfWork.Dispose">
  514. <summary>
  515. Dispose the unit of work and associated contexts
  516. </summary>
  517. </member>
  518. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFUnitOfWork.ContainsLockKey(System.Type,System.Int32)">
  519. <summary>
  520. Check if there is a lock inthe lock table for the Type, id pair
  521. </summary>
  522. <param name="entity">Type</param>
  523. <param name="i">Id</param>
  524. <returns>Lock found?</returns>
  525. </member>
  526. <member name="M:Bowling.Domain.Concrete.EntityFramework.EFUnitOfWork.AddToLockTable(System.Type,System.Int32)">
  527. <summary>
  528. Add the given type id pair to the lock table
  529. </summary>
  530. <param name="entity">Type</param>
  531. <param name="i">Id</param>
  532. </member>
  533. <member name="P:Bowling.Domain.Concrete.EntityFramework.EFUnitOfWork.Context">
  534. <summary>
  535. The context being used
  536. </summary>
  537. <returns>context</returns>
  538. </member>
  539. <member name="P:Bowling.Domain.Concrete.EntityFramework.EFUnitOfWork.DataContext">
  540. <summary>
  541. The database context being used
  542. </summary>
  543. <returns>Data context</returns>
  544. </member>
  545. <member name="T:Bowling.Domain.Abstract.IRepositoryExtensions">
  546. <summary>
  547. Provides extension methods for the <see cref="T:Bowling.Domain.Abstract.IRepository`1"/> and <see cref="T:Bowling.Domain.Abstract.IRepository`1"/> interfaces.
  548. </summary>
  549. </member>
  550. <member name="M:Bowling.Domain.Abstract.IRepositoryExtensions.GetAsync``1(Bowling.Domain.Abstract.IRepository{``0},System.Func{System.Linq.IQueryable{``0},System.Linq.IQueryable{``0}})">
  551. <summary>
  552. Retrieves all items in the repository satisfied by the specified query asynchronously.
  553. </summary>
  554. <typeparam name="T">The <see cref="T:System.Type">type</see> of item in the repository.</typeparam>
  555. <param name="repository">The extended <see cref="T:Bowling.Domain.Abstract.IRepository`1">repository</see>.</param>
  556. <param name="queryShaper">The <see cref="T:System.Func`2">function</see> that shapes the <see cref="T:System.Linq.IQueryable`1">query</see> to execute.</param>
  557. <returns>A <see cref="T:System.Threading.Tasks.Task`1">task</see> containing the retrieved <see cref="T:System.Collections.Generic.IEnumerable`1">sequence</see>
  558. of <typeparamref name="T">items</typeparamref>.</returns>
  559. <example>The following example demonstrates how to paginate the items in a repository using an example query.
  560. <code><![CDATA[
  561. using Microsoft.DesignPatterns.Examples;
  562. using System;
  563. using System.Collections.Generic;
  564. using System.Linq;
  565. using System.Threading;
  566. using System.Threading.Tasks;
  567. public async static void Main()
  568. {
  569. var index = 0;
  570. var repository = new MyRepository();
  571. foreach ( var item in await repository.GetAsync( q => q.Where( i => i.FirstName.StartsWith( "Jo" ) ).OrderBy( i => i.LastName ) );
  572. Console.WriteLine( i => i.ToString() );
  573. }
  574. ]]>
  575. </code></example>
  576. </member>
  577. <member name="M:Bowling.Domain.Abstract.IRepositoryExtensions.GetAsync``2(Bowling.Domain.Abstract.IRepository{``0},System.Func{System.Linq.IQueryable{``0},``1})">
  578. <summary>
  579. Retrieves a query result asynchronously.
  580. </summary>
  581. <typeparam name="T">The <see cref="T:System.Type">type</see> of item in the repository.</typeparam>
  582. <typeparam name="TResult">The <see cref="T:System.Type">type</see> of result to retrieve.</typeparam>
  583. <param name="repository">The extended <see cref="T:Bowling.Domain.Abstract.IRepository`1">repository</see>.</param>
  584. <param name="queryShaper">The <see cref="T:System.Func`2">function</see> that shapes the <see cref="T:System.Linq.IQueryable`1">query</see> to execute.</param>
  585. <returns>A <see cref="T:System.Threading.Tasks.Task`1">task</see> containing the <typeparamref name="TResult">result</typeparamref> of the operation.</returns>
  586. </member>
  587. <member name="M:Bowling.Domain.Abstract.IRepositoryExtensions.GetAllAsync``1(Bowling.Domain.Abstract.IRepository{``0})">
  588. <summary>
  589. Retrieves all items in the repository asynchronously.
  590. </summary>
  591. <typeparam name="T">The <see cref="T:System.Type">type</see> of item in the repository.</typeparam>
  592. <param name="repository">The extended <see cref="T:Bowling.Domain.Abstract.IRepository`1">repository</see>.</param>
  593. <returns>A <see cref="T:System.Threading.Tasks.Task`1">task</see> containing the <see cref="T:System.Collections.Generic.IEnumerable`1">sequence</see>
  594. of all <typeparamref name="T">items</typeparamref> in the repository.</returns>
  595. <example>The following example demonstrates how to retrieve all items in a repository.
  596. <code><![CDATA[
  597. using Microsoft.DesignPatterns.Examples;
  598. using System;
  599. using System.Collections.Generic;
  600. using System.Linq;
  601. using System.Threading;
  602. using System.Threading.Tasks;
  603. public async static void Main()
  604. {
  605. var repository = new MyRepository();
  606. foreach ( var item in await repository.GetAllAsync( i => i.LastName == "Doe" ) )
  607. Console.WriteLine( item.ToString() );
  608. }
  609. ]]>
  610. </code></example>
  611. </member>
  612. <member name="M:Bowling.Domain.Abstract.IRepositoryExtensions.GetAllAsync``1(Bowling.Domain.Abstract.IRepository{``0},System.Threading.CancellationToken)">
  613. <summary>
  614. Retrieves all items in the repository asynchronously.
  615. </summary>
  616. <typeparam name="T">The <see cref="T:System.Type">type</see> of item in the repository.</typeparam>
  617. <param name="repository">The extended <see cref="T:Bowling.Domain.Abstract.IRepository`1">repository</see>.</param>
  618. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken">cancellation token</see> that can be used to cancel the operation.</param>
  619. <returns>A <see cref="T:System.Threading.Tasks.Task`1">task</see> containing the <see cref="T:System.Collections.Generic.IEnumerable`1">sequence</see>
  620. of all <typeparamref name="T">items</typeparamref> in the repository.</returns>
  621. <example>The following example demonstrates how to retrieve all items in a repository.
  622. <code><![CDATA[
  623. using Microsoft.DesignPatterns.Examples;
  624. using System;
  625. using System.Collections.Generic;
  626. using System.Linq;
  627. using System.Threading;
  628. using System.Threading.Tasks;
  629. public async static void Main()
  630. {
  631. var repository = new MyRepository();
  632. var cancellationToken = new CancellationToken();
  633. foreach ( var item in await repository.GetAllAsync( i => i.LastName == "Doe", cancellationToken ) )
  634. Console.WriteLine( item.ToString() );
  635. }
  636. ]]>
  637. </code></example>
  638. </member>
  639. <member name="M:Bowling.Domain.Abstract.IRepositoryExtensions.FindByAsync``1(Bowling.Domain.Abstract.IRepository{``0},System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}})">
  640. <summary>
  641. Searches for items in the repository that match the specified predicate asynchronously.
  642. </summary>
  643. <typeparam name="T">The <see cref="T:System.Type">type</see> of item in the repository.</typeparam>
  644. <param name="repository">The extended <see cref="T:Bowling.Domain.Abstract.IRepository`1">repository</see>.</param>
  645. <param name="predicate">The <see cref="T:System.Linq.Expressions.Expression`1">expression</see> representing the predicate used to
  646. match the requested <typeparamref name="T">items</typeparamref>.</param>
  647. <returns>A <see cref="T:System.Threading.Tasks.Task`1">task</see> containing the matched <see cref="T:System.Collections.Generic.IEnumerable`1">sequence</see>
  648. of <typeparamref name="T">items</typeparamref>.</returns>
  649. <example>The following example demonstrates how to find items in a repository.
  650. <code><![CDATA[
  651. using Microsoft.DesignPatterns.Examples;
  652. using System;
  653. using System.Collections.Generic;
  654. using System.Linq;
  655. using System.Threading;
  656. using System.Threading.Tasks;
  657. public async static void Main()
  658. {
  659. var repository = new MyRepository();
  660. var items = await repository.FindByAsync( i => i.LastName == "Doe" );
  661. items.ForEach( i => Console.WriteLine( i.ToString() ) );
  662. }
  663. ]]>
  664. </code></example>
  665. </member>
  666. <member name="M:Bowling.Domain.Abstract.IRepositoryExtensions.FindByAsync``1(Bowling.Domain.Abstract.IRepository{``0},System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.Threading.CancellationToken)">
  667. <summary>
  668. Searches for items in the repository that match the specified predicate asynchronously.
  669. </summary>
  670. <typeparam name="T">The <see cref="T:System.Type">type</see> of item in the repository.</typeparam>
  671. <param name="repository">The extended <see cref="T:Bowling.Domain.Abstract.IRepository`1">repository</see>.</param>
  672. <param name="predicate">The <see cref="T:System.Linq.Expressions.Expression`1">expression</see> representing the predicate used to
  673. match the requested <typeparamref name="T">items</typeparamref>.</param>
  674. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken">cancellation token</see> that can be used to cancel the operation.</param>
  675. <returns>A <see cref="T:System.Threading.Tasks.Task`1">task</see> containing the matched <see cref="T:System.Collections.Generic.IEnumerable`1">sequence</see>
  676. of <typeparamref name="T">items</typeparamref>.</returns>
  677. <example>The following example demonstrates how to find items in a repository.
  678. <code><![CDATA[
  679. using Microsoft.DesignPatterns.Examples;
  680. using System;
  681. using System.Collections.Generic;
  682. using System.Linq;
  683. using System.Threading;
  684. using System.Threading.Tasks;
  685. public async static void Main()
  686. {
  687. var repository = new MyRepository();
  688. var cancellationToken = new CancellationToken();
  689. var items = await repository.FindByAsync( i => i.LastName == "Doe", cancellationToken );
  690. items.ForEach( i => Console.WriteLine( i.ToString() ) );
  691. }
  692. ]]>
  693. </code></example>
  694. </member>
  695. <member name="M:Bowling.Domain.Abstract.IRepositoryExtensions.GetSingleAsync``1(Bowling.Domain.Abstract.IRepository{``0},System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}})">
  696. <summary>
  697. Retrieves a single item in the repository matching the specified predicate asynchronously.
  698. </summary>
  699. <typeparam name="T">The <see cref="T:System.Type">type</see> of item in the repository.</typeparam>
  700. <param name="repository">The extended <see cref="T:Bowling.Domain.Abstract.IRepository`1">repository</see>.</param>
  701. <param name="predicate">The <see cref="T:System.Linq.Expressions.Expression`1">expression</see> representing the predicate used to
  702. match the requested <typeparamref name="T">item</typeparamref>.</param>
  703. <returns>A <see cref="T:System.Threading.Tasks.Task`1">task</see> containing the matched <typeparamref name="T">item</typeparamref>
  704. or null if no match was found.</returns>
  705. <example>The following example demonstrates how to retrieve a single item from a repository.
  706. <code><![CDATA[
  707. using Microsoft.DesignPatterns.Examples;
  708. using System;
  709. using System.Collections.Generic;
  710. using System.Linq;
  711. using System.Threading;
  712. using System.Threading.Tasks;
  713. public async static void Main()
  714. {
  715. var repository = new MyRepository();
  716. var item = await repository.GetSingleAsync( i => i.Id == 1 );
  717. Console.WriteLine( item.ToString() );
  718. }
  719. ]]>
  720. </code></example>
  721. </member>
  722. <member name="M:Bowling.Domain.Abstract.IRepositoryExtensions.GetSingleAsync``1(Bowling.Domain.Abstract.IRepository{``0},System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}},System.Threading.CancellationToken)">
  723. <summary>
  724. Retrieves a single item in the repository matching the specified predicate asynchronously.
  725. </summary>
  726. <typeparam name="T">The <see cref="T:System.Type">type</see> of item in the repository.</typeparam>
  727. <param name="repository">The extended <see cref="T:Bowling.Domain.Abstract.IRepository`1">repository</see>.</param>
  728. <param name="predicate">The <see cref="T:System.Linq.Expressions.Expression`1">expression</see> representing the predicate used to
  729. match the requested <typeparamref name="T">item</typeparamref>.</param>
  730. <param name="cancellationToken">The <see cref="T:System.Threading.CancellationToken">cancellation token</see> that can be used to cancel the operation.</param>
  731. <returns>A <see cref="T:System.Threading.Tasks.Task`1">task</see> containing the matched <typeparamref name="T">item</typeparamref>
  732. or null if no match was found.</returns>
  733. <example>The following example demonstrates how to retrieve a single item from a repository.
  734. <code><![CDATA[
  735. using Microsoft.DesignPatterns.Examples;
  736. using System;
  737. using System.Collections.Generic;
  738. using System.Linq;
  739. using System.Threading;
  740. using System.Threading.Tasks;
  741. public async static void Main()
  742. {
  743. var repository = new MyRepository();
  744. var item = await repository.GetSingleAsync( i => i.Id == 1 );
  745. Console.WriteLine( item.ToString() );
  746. }
  747. ]]>
  748. </code></example>
  749. </member>
  750. <member name="T:Bowling.Domain.Concrete.EntityFramework.Mapping.AttendeeMap">
  751. <summary>
  752. Contact database field definition
  753. </summary>
  754. </member>
  755. <member name="M:Bowling.Domain.Concrete.EntityFramework.Mapping.AttendeeMap.#ctor">
  756. <summary>
  757. Define the table fields
  758. </summary>
  759. </member>
  760. <member name="T:Bowling.Domain.Concrete.EntityFramework.Mapping.BowlerMap">
  761. <summary>
  762. Contact database field definition
  763. </summary>
  764. </member>
  765. <member name="M:Bowling.Domain.Concrete.EntityFramework.Mapping.BowlerMap.#ctor">
  766. <summary>
  767. Define the table fields
  768. </summary>
  769. </member>
  770. <member name="T:Bowling.Domain.Concrete.EntityFramework.Mapping.EventMap">
  771. <summary>
  772. Contact database field definition
  773. </summary>
  774. </member>
  775. <member name="M:Bowling.Domain.Concrete.EntityFramework.Mapping.EventMap.#ctor">
  776. <summary>
  777. Define the table fields
  778. </summary>
  779. </member>
  780. <member name="T:Bowling.Domain.Concrete.EntityFramework.Mapping.FoodOptionMap">
  781. <summary>
  782. Contact database field definition
  783. </summary>
  784. </member>
  785. <member name="M:Bowling.Domain.Concrete.EntityFramework.Mapping.FoodOptionMap.#ctor">
  786. <summary>
  787. Define the table fields
  788. </summary>
  789. </member>
  790. <member name="T:Bowling.Domain.Concrete.EntityFramework.Mapping.ResultMap">
  791. <summary>
  792. Contact database field definition
  793. </summary>
  794. </member>
  795. <member name="M:Bowling.Domain.Concrete.EntityFramework.Mapping.ResultMap.#ctor">
  796. <summary>
  797. Define the table fields
  798. </summary>
  799. </member>
  800. <member name="T:Bowling.Domain.Concrete.EntityFramework.Mapping.RoundMap">
  801. <summary>
  802. Contact database field definition
  803. </summary>
  804. </member>
  805. <member name="M:Bowling.Domain.Concrete.EntityFramework.Mapping.RoundMap.#ctor">
  806. <summary>
  807. Define the table fields
  808. </summary>
  809. </member>
  810. <member name="T:Bowling.Domain.Entities.Attendee">
  811. <summary>
  812. Record of which bowlers attended each event, along with their food option and score
  813. </summary>
  814. </member>
  815. <member name="T:Bowling.Domain.Entities.BaseEntity">
  816. <summary>
  817. Base entity used by all entities
  818. </summary>
  819. </member>
  820. <member name="M:Bowling.Domain.Entities.BaseEntity.OnPropertyChanged(System.String)">
  821. <summary>
  822. On property changed event
  823. </summary>
  824. <param name="propertyName">Property being changed</param>
  825. </member>
  826. <member name="M:Bowling.Domain.Entities.BaseEntity.OnPropertyChanging(System.String)">
  827. <summary>
  828. Property changing event
  829. </summary>
  830. <param name="propertyName">Property being changed</param>
  831. </member>
  832. <member name="P:Bowling.Domain.Entities.BaseEntity.Id">
  833. <summary>
  834. Key
  835. </summary>
  836. </member>
  837. <member name="E:Bowling.Domain.Entities.BaseEntity.PropertyChanged">
  838. <summary>
  839. Property changed event handler
  840. </summary>
  841. </member>
  842. <member name="E:Bowling.Domain.Entities.BaseEntity.PropertyChanging">
  843. <summary>
  844. Property changing event handler
  845. </summary>
  846. </member>
  847. <member name="M:Bowling.Domain.Entities.Attendee.#ctor(Bowling.Domain.Entities.Bowler,Bowling.Domain.Entities.Event,Bowling.Domain.Entities.FoodOption)">
  848. <summary>
  849. only constructor
  850. </summary>
  851. <param name="bowler"></param>
  852. <param name="bowlingEvent"></param>
  853. <param name="foodOption"></param>
  854. </member>
  855. <member name="P:Bowling.Domain.Entities.Attendee.Bowler">
  856. <summary>
  857. Bowler who attended event
  858. </summary>
  859. </member>
  860. <member name="P:Bowling.Domain.Entities.Attendee.Event">
  861. <summary>
  862. Event Attended
  863. </summary>
  864. </member>
  865. <member name="P:Bowling.Domain.Entities.Attendee.FoodOption">
  866. <summary>
  867. Choice of food
  868. </summary>
  869. </member>
  870. <member name="P:Bowling.Domain.Entities.Attendee.Paid">
  871. <summary>
  872. Has the bowler paid for the event
  873. </summary>
  874. </member>
  875. <member name="P:Bowling.Domain.Entities.Attendee.PaidDateTime">
  876. <summary>
  877. Date and Time bowler paid for the event
  878. </summary>
  879. </member>
  880. <member name="P:Bowling.Domain.Entities.Attendee.SignUpDateTime">
  881. <summary>
  882. Date and Time Bowler signed up for the event
  883. </summary>
  884. </member>
  885. <member name="P:Bowling.Domain.Entities.Attendee.Results">
  886. <summary>
  887. Bowling scores
  888. </summary>
  889. </member>
  890. <member name="T:Bowling.Domain.Entities.Bowler">
  891. <summary>
  892. A Bowler
  893. </summary>
  894. </member>
  895. <member name="P:Bowling.Domain.Entities.Bowler.Name">
  896. <summary>
  897. Display name of bowler
  898. </summary>
  899. </member>
  900. <member name="P:Bowling.Domain.Entities.Bowler.Attendees">
  901. <summary>
  902. List of all the times the bowler was an attendee of an event
  903. </summary>
  904. </member>
  905. <member name="T:Bowling.Domain.Entities.Event">
  906. <summary>
  907. Bowling event night
  908. </summary>
  909. </member>
  910. <member name="P:Bowling.Domain.Entities.Event.Name">
  911. <summary>
  912. Name of event
  913. </summary>
  914. </member>
  915. <member name="P:Bowling.Domain.Entities.Event.Description">
  916. <summary>
  917. Event description
  918. </summary>
  919. </member>
  920. <member name="P:Bowling.Domain.Entities.Event.Price">
  921. <summary>
  922. Price
  923. </summary>
  924. </member>
  925. <member name="P:Bowling.Domain.Entities.Event.Attendees">
  926. <summary>
  927. List of Bowlers attending event
  928. </summary>
  929. </member>
  930. </members>
  931. </doc>