package.lisp

(defpackage percl (:use :cl :cl-user :iter)
   (:import-from #:mongo-cl-driver.son-sugar son)
   (:export :identifable :id
			:mongo-db :mem-db :db
			:generate-methods
			  :generate-class-methods
			    :init-from-alist
			    :get-fields
			  :generate-db-methods
			    :load-inst
			    :load-all-instances
			    :store-inst
				:remove-inst))

(in-package :percl)
			  
(defgeneric load-inst (class storage &key id query)
  (:documentation "Pull an instance of class gy id from storage"))
(defgeneric load-all-instances (class storage &key query)
  (:documentation "Load whole collection of given class instances from
				  the storage"))
(defgeneric store-inst (inst storage)
  (:documentation "Save all changes of the given instance to the database, 
				  or insert it, if new "))
(defgeneric remove-inst (id class storage)
  (:documentation "Remove an instance with given id from storage"))
(defgeneric get-fields (class)
  (:documentation "Get the prop-list of all persistent fields of given class"))
(defgeneric init-from-alist (class alist)
  (:documentation "Create instance according to given association list, such
				  as the one, returned by hunchentoot:get-parameters*" ))

(defgeneric get-field-name (class field)
  (:documentation "Get the name (string) of the field, used for work with
				  it in databases"))