Reference Source

js/datas/providers/record_provider.js

  1.  
  2. // NPM IMPORTS
  3. import assert from 'assert'
  4.  
  5. // COMMON IMPORTS
  6. import T from '../../utils/types'
  7.  
  8.  
  9. /**
  10.  * Contextual constant for this file logs.
  11.  * @private
  12.  */
  13. const context = 'common/datas/providers/record_provider'
  14.  
  15.  
  16.  
  17. /**
  18.  * Record provider base class.
  19.  * @abstract
  20.  * @author Luc BORIES
  21.  * @license Apache-2.0
  22.  */
  23. export default class RecordProvider
  24. {
  25.     /**
  26.      * Create a record provider instance
  27.      */
  28. 	constructor(arg_settings)
  29. 	{
  30. 		assert( T.isObject(arg_settings), context + ':bad settings object')
  31. 		/**
  32. 		 * Record provider settings.
  33. 		 * @type {object}
  34. 		 */
  35. 		this.$settings = T.isFunction(arg_settings.toJS) ? arg_settings.toJS() : arg_settings
  36. 	}
  37.     
  38.     
  39.     /**
  40.      * Build a query to fetch datas.
  41.      * @param {object|undefined} arg_query - optional query context
  42.      * @returns {Promise} datas record promise
  43.      */
  44. 	build_query(arg_query)
  45. 	{
  46. 		// logs.debug(context, 'build_query:not implemented')
  47.  
  48. 		return arg_query
  49. 	}
  50.     
  51.     
  52.     /**
  53.      * Provide all datas records
  54.      * @abstract
  55.      * @param {object|undefined} arg_query - optional query context
  56.      * @returns {Promise} datas record promise
  57.      */
  58. 	find_all_records(/*arg_query*/)
  59. 	{
  60. 		// logs.debug(context, 'find_all_records:not implemented')
  61. 		return Promise.resolve(null)
  62. 	}
  63.     
  64.     
  65.     /**
  66.      * Find a record by its id.
  67.      * @abstract
  68.      * @param {string|number} arg_id - record id
  69.      * @param {object|undefined} arg_query - optional query context
  70.      * @returns {Promise} - promise of found record or null
  71.      */
  72. 	find_records_by_id(arg_id, arg_query)
  73. 	{
  74. 		// logs.debug(context, 'find_records_by_id:not implemented')
  75. 		assert( T.isString(arg_id) || T.isNumber(arg_id), context + ':find_records_by_id:bad id string or number')
  76.  
  77. 		// TO IMPLEMENT IN SUBCLASSES
  78.  
  79. 		return Promise.resolve(null)
  80. 	}
  81.     
  82.     
  83.     /**
  84.      * Find a record with a set of values.
  85.      * @abstract
  86.      * @param {object} arg_values_map - values map
  87.      * @param {object|undefined} arg_query - optional query context
  88.      * @returns {Promise} - promise of found record or null
  89.      */
  90. 	find_records_by_values(arg_values_map/*, arg_query*/)
  91. 	{
  92. 		// logs.debug(context, 'find_records_by_values:not implemented')
  93. 		assert( T.isObject(arg_values_map), context + ':find_records_by_id:bad values object')
  94.  
  95. 		// TO IMPLEMENT IN SUBCLASSES
  96.  
  97. 		return Promise.resolve(null)
  98. 	}
  99. }