Create an Approval Entity

In order for an entity to be available to Approvals Mechanism, it has to meet the following conditions:

1. Data Object Class

The entity's DO class must implement ICRMDOApprovalEntity interface and its twelve methods: 

1. getNumberOfPendingAprovals()
2. setNumberOfPendingAprovals(Integer numberOfPendingAprovals)
3. getIsPendingAproval()
4. setIsPendingAproval(Integer IsPendingAproval)
5. isPendingAproval()
6. getCanBeApproved()
7. setCanBeApproved(Integer canBeApproved)
8. canBeApproved()
9. getUsersAuthorisedToRespond()
10. setUsersAuthorisedToRespond(Set<CRMDOUser> users)
11. getApprovalRequests()
12. setApprovalRequests(Set<CRMDOApprovalRequest> approvalRequests)

In order for the obove methods to be implemented the following java properties must be defined:

1. Integer numberOfPendingAprovals
2. Integer isPendingAproval
3. Integer canBeApproved
4. Set<CRMDOUser> usersAuthorisedToRespond
5. Set<CRMDOApprovalRequest>  approvalRequests

Note that these fields are transient, and therefore do not have a corresponding database field.

2. Entities Metadata File

In entities metadata file, <approvalincluded> tag's value must be set to true. Keep in mind that <approvalincluded> default value is false.

Note that approvals are triggered only through Workflow Rules, and therefore there is no point for an entity to be an Approval Entity without being a Workflow Rule Entity.