Merge pull request apex-enterprise-patterns#166 from Morgan-and-Morga…

…n/master new UOW feature -- manage relationship between email and record
manhntbkit · Aug 12, 2017 · aef58a7 · aef58a7
2 parents 7366576 + 2aae6a7
commit aef58a7
Show file tree

Hide file tree

Showing 3 changed files with 917 additions and 824 deletions.
diff --git a/fflib/src/classes/fflib_ISObjectUnitOfWork.cls b/fflib/src/classes/fflib_ISObjectUnitOfWork.cls
@@ -14,42 +14,51 @@
  **/
 public interface fflib_ISObjectUnitOfWork
 {
-	/**
-	 * Register a newly created SObject instance to be inserted when commitWork is called
-	 *
-	 * @param record A newly created SObject instance to be inserted during commitWork
-	 **/
-	void registerNew(SObject record);
-	/**
-	 * Register a list of newly created SObject instances to be inserted when commitWork is called
-	 *
-	 * @param records A list of newly created SObject instances to be inserted during commitWork
-	 **/
-	void registerNew(List<SObject> records);
-	/**
-	 * Register a newly created SObject instance to be inserted when commitWork is called,
-	 *   you may also provide a reference to the parent record instance (should also be registered as new separatly)
-	 *
-	 * @param record A newly created SObject instance to be inserted during commitWork
-	 * @param relatedToParentField A SObjectField reference to the child field that associates the child record with its parent
-	 * @param relatedToParentRecord A SObject instance of the parent record (should also be registered as new separatly)
-	 **/
-	void registerNew(SObject record, Schema.sObjectField relatedToParentField, SObject relatedToParentRecord);
-	/**
-	 * Register a relationship between two records that have yet to be inserted to the database. This information will be
-	 *  used during the commitWork phase to make the references only when related records have been inserted to the database.
-	 *
-	 * @param record An existing or newly created record
-	 * @param relatedToField A SObjectField referene to the lookup field that relates the two records together
-	 * @param relatedTo A SOBject instance (yet to be commited to the database)
-	 */
-	void registerRelationship(SObject record, Schema.sObjectField relatedToField, SObject relatedTo);
-	/**
-	 * Register an existing record to be updated during the commitWork method
-	 *
-	 * @param record An existing record
-	 **/
-	void registerDirty(SObject record);
+    /**
+     * Register a newly created SObject instance to be inserted when commitWork is called
+     *
+     * @param record A newly created SObject instance to be inserted during commitWork
+     **/
+    void registerNew(SObject record);
+    /**
+     * Register a list of newly created SObject instances to be inserted when commitWork is called
+     *
+     * @param records A list of newly created SObject instances to be inserted during commitWork
+     **/
+    void registerNew(List<SObject> records);
+    /**
+     * Register a newly created SObject instance to be inserted when commitWork is called,
+     *   you may also provide a reference to the parent record instance (should also be registered as new separatly)
+     *
+     * @param record A newly created SObject instance to be inserted during commitWork
+     * @param relatedToParentField A SObjectField reference to the child field that associates the child record with its parent
+     * @param relatedToParentRecord A SObject instance of the parent record (should also be registered as new separatly)
+     **/
+    void registerNew(SObject record, Schema.sObjectField relatedToParentField, SObject relatedToParentRecord);
+    /**
+     * Register a relationship between two records that have yet to be inserted to the database. This information will be
+     *  used during the commitWork phase to make the references only when related records have been inserted to the database.
+     *
+     * @param record An existing or newly created record
+     * @param relatedToField A SObjectField referene to the lookup field that relates the two records together
+     * @param relatedTo A SOBject instance (yet to be commited to the database)
+     */
+    void registerRelationship(SObject record, Schema.sObjectField relatedToField, SObject relatedTo);
+    /**
+     * Registers a relationship between a record and a Messaging.Email where the record has yet to be inserted
+     *  to the database.  This information will be
+     *  used during the commitWork phase to make the references only when related records have been inserted to the database.
+     *
+     * @param a single email message instance
+     * @param relatedTo A SOBject instance (yet to be commited to the database)
+     */
+    void registerRelationship( Messaging.SingleEmailMessage email, SObject relatedTo );
+    /**
+     * Register an existing record to be updated during the commitWork method
+     *
+     * @param record An existing record
+     **/
+    void registerDirty(SObject record);
     /**
      * Register an existing record to be updated when commitWork is called,
      *   you may also provide a reference to the parent record instance (should also be registered as new separatly)
@@ -59,38 +68,38 @@ public interface fflib_ISObjectUnitOfWork
      * @param relatedToParentRecord A SObject instance of the parent record (should also be registered as new separatly)
      **/
     void registerDirty(SObject record, Schema.sObjectField relatedToParentField, SObject relatedToParentRecord);
-	/**
-	 * Register a list of existing records to be updated during the commitWork method
-	 *
-	 * @param records A list of existing records
-	 **/
-	void registerDirty(List<SObject> records);
-	/**
-	 * Register an existing record to be deleted during the commitWork method
-	 *
-	 * @param record An existing record
-	 **/
-	void registerDeleted(SObject record);
-	/**
-	 * Register a list of existing records to be deleted during the commitWork method
-	 *
-	 * @param records A list of existing records
-	 **/
-	void registerDeleted(List<SObject> records);
-	/**
-	 * Takes all the work that has been registered with the UnitOfWork and commits it to the database
-	 **/
-	void commitWork();
-	/**
-	 * Register a generic peace of work to be invoked during the commitWork phase
-	 *
-	 * @param work Work to be registered
-	 **/
-	void registerWork(fflib_SObjectUnitOfWork.IDoWork work);
-	/**
-	 * Registers the given email to be sent during the commitWork
-	 *
-	 * @param email Email to be sent
-	 **/	 
-	void registerEmail(Messaging.Email email);
+    /**
+     * Register a list of existing records to be updated during the commitWork method
+     *
+     * @param records A list of existing records
+     **/
+    void registerDirty(List<SObject> records);
+    /**
+     * Register an existing record to be deleted during the commitWork method
+     *
+     * @param record An existing record
+     **/
+    void registerDeleted(SObject record);
+    /**
+     * Register a list of existing records to be deleted during the commitWork method
+     *
+     * @param records A list of existing records
+     **/
+    void registerDeleted(List<SObject> records);
+    /**
+     * Takes all the work that has been registered with the UnitOfWork and commits it to the database
+     **/
+    void commitWork();
+    /**
+     * Register a generic peace of work to be invoked during the commitWork phase
+     *
+     * @param work Work to be registered
+     **/
+    void registerWork(fflib_SObjectUnitOfWork.IDoWork work);
+    /**
+     * Registers the given email to be sent during the commitWork
+     *
+     * @param email Email to be sent
+     **/
+    void registerEmail(Messaging.Email email);
 }