Classic implementations for Application Factories
Adds additional functionality while maintaining backwards compatibility
This commit is contained in:
Wim Velzeboer
+157
@@ -0,0 +1,157 @@
|
||||
/**
|
||||
* File Name: fflib_ClassicDomainFactory
|
||||
* Description:
|
||||
*
|
||||
* @author : architect ir. Wilhelmus G.J. Velzeboer
|
||||
*
|
||||
* Copyright (c), W.G.J. Velzeboer,
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* - Redistributions of source code must retain the above author notice,
|
||||
* this list of conditions and the following disclaimer.
|
||||
* - Redistributions in binary form must reproduce the above copyright notice,
|
||||
* this list of conditions and the following disclaimer in the documentation
|
||||
* and/or other materials provided with the distribution.
|
||||
* - Neither the name of the author nor the names of its contributors
|
||||
* may be used to endorse or promote products derived from this software without
|
||||
* specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
||||
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
||||
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
|
||||
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
public virtual class fflib_ClassicDomainFactory
|
||||
extends fflib_Application.DomainFactory
|
||||
implements fflib_IDomainFactory
|
||||
{
|
||||
protected fflib_ISelectorFactory selectorFactory;
|
||||
|
||||
/**
|
||||
* Constructs a Domain factory
|
||||
**/
|
||||
public fflib_ClassicDomainFactory() {}
|
||||
|
||||
/**
|
||||
* Constructs a Domain factory, using an instance of the Selector Factory
|
||||
* and a map of Apex classes implementing fflib_ISObjectDomain by SObjectType
|
||||
* Note this will not check the Apex classes provided actually implement the interfaces
|
||||
* since this is not possible in the Apex runtime at present
|
||||
*
|
||||
* @param selectorFactory , e.g. Application.Selector
|
||||
* @param constructorTypeByObject Map of Domain classes by ObjectType
|
||||
**/
|
||||
public fflib_ClassicDomainFactory(
|
||||
fflib_ISelectorFactory selectorFactory,
|
||||
Map<Object, Type> constructorTypeByObject)
|
||||
{
|
||||
selectorFactory = selectorFactory;
|
||||
this.constructorTypeByObject = constructorTypeByObject;
|
||||
this.mockDomainByObject = new Map<Object, fflib_IDomain>();
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a Domain factory, using an instance of the Selector Factory
|
||||
* and a map of Apex classes implementing fflib_ISObjectDomain by SObjectType
|
||||
* Note this will not check the Apex classes provided actually implement the interfaces
|
||||
* since this is not possible in the Apex runtime at present
|
||||
*
|
||||
* @param selectorFactory , e.g. Application.Selector
|
||||
* @param sObjectByDomainConstructorType Map of Apex classes by SObjectType
|
||||
**/
|
||||
public fflib_ClassicDomainFactory(fflib_ISelectorFactory selectorFactory,
|
||||
Map<SObjectType, Type> sObjectByDomainConstructorType)
|
||||
{
|
||||
selectorFactory = selectorFactory;
|
||||
this.constructorTypeByObject = getConstructorTypeByObject(sObjectByDomainConstructorType);
|
||||
this.mockDomainByObject = new Map<Object, fflib_IDomain>();
|
||||
}
|
||||
|
||||
/**
|
||||
* Dynamically constructs an instance of a Domain class for the given record Ids
|
||||
* Internally uses the Selector Factory to query the records before passing to a
|
||||
* dynamically constructed instance of the application Apex Domain class
|
||||
*
|
||||
* @param recordIds A list of Id's of the same type
|
||||
*
|
||||
* @return Instance of a Domain containing the queried records
|
||||
* @exception Throws an exception via the Selector Factory if the Ids are not all of the same SObjectType
|
||||
**/
|
||||
public virtual override fflib_IDomain newInstance(Set<Id> recordIds)
|
||||
{
|
||||
return newInstance(selectorFactory.selectById(recordIds));
|
||||
}
|
||||
|
||||
/**
|
||||
* Dynamically constructs an instance of a Domain class for the given record Ids
|
||||
* Internally uses the Selector Factory to query the records before passing to a
|
||||
* dynamically constructed instance of the application Apex Domain class
|
||||
*
|
||||
* @param recordIds A list of Id's of the same type
|
||||
* @param sObjectType The SObjectType of the given record Ids
|
||||
*
|
||||
* @return Instance of a Domain containing the queried records
|
||||
* @exception Throws an exception via the Selector Factory if the Ids are not all of the same SObjectType
|
||||
**/
|
||||
public virtual fflib_IDomain newInstance(Set<Id> recordIds, Schema.SObjectType sObjectType)
|
||||
{
|
||||
return newInstance(selectorFactory.selectById(recordIds, sObjectType));
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates or replaces an existing binding for another
|
||||
*
|
||||
* @param sObjectType The SObjectType of the selector to replace
|
||||
* @param replacementImplType The implementation type of the replacement
|
||||
*/
|
||||
public virtual void replaceWith(Schema.SObjectType sObjectType, Type replacementImplType)
|
||||
{
|
||||
this.constructorTypeByObject.put(
|
||||
(Object) sObjectType,
|
||||
replacementImplType
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param mockDomain The instance of the Domain mock
|
||||
*/
|
||||
public virtual override void setMock(fflib_ISObjectDomain mockDomain)
|
||||
{
|
||||
super.setMock(mockDomain);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param sObjectType The SObjectType of the Domain mock,
|
||||
* avoids the need to stub the mock to return its SObjectType
|
||||
* @param mockDomain The instance of the Domain mock
|
||||
*/
|
||||
public virtual void setMock(Schema.SObjectType sObjectType, fflib_ISObjectDomain mockDomain)
|
||||
{
|
||||
mockDomainByObject.put((Object) sObjectType, mockDomain);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param mockDomain The instance of the Domain mock
|
||||
*/
|
||||
public virtual override void setMock(fflib_IDomain mockDomain)
|
||||
{
|
||||
super.setMock(mockDomain);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param domainType The ObjectType of the Domain mock,
|
||||
* avoids the need to stub the mock to return its ObjectType
|
||||
* @param mockDomain The instance of the Domain mock
|
||||
*/
|
||||
public virtual void setMock(Type domainType, fflib_IDomain mockDomain)
|
||||
{
|
||||
mockDomainByObject.put(domainType, mockDomain);
|
||||
}
|
||||
}
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
|
||||
<apiVersion>51.0</apiVersion>
|
||||
<status>Active</status>
|
||||
</ApexClass>
|
||||
+101
@@ -0,0 +1,101 @@
|
||||
/**
|
||||
* File Name: fflib_ClassicSelectorFactory
|
||||
* Description:
|
||||
*
|
||||
* @author : architect ir. Wilhelmus G.J. Velzeboer
|
||||
*
|
||||
* Copyright (c), W.G.J. Velzeboer,
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* - Redistributions of source code must retain the above author notice,
|
||||
* this list of conditions and the following disclaimer.
|
||||
* - Redistributions in binary form must reproduce the above copyright notice,
|
||||
* this list of conditions and the following disclaimer in the documentation
|
||||
* and/or other materials provided with the distribution.
|
||||
* - Neither the name of the author nor the names of its contributors
|
||||
* may be used to endorse or promote products derived from this software without
|
||||
* specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
||||
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
||||
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
|
||||
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
public virtual class fflib_ClassicSelectorFactory
|
||||
extends fflib_Application.SelectorFactory
|
||||
implements fflib_ISelectorFactory
|
||||
{
|
||||
/**
|
||||
* Constructs a simple Selector Factory
|
||||
**/
|
||||
public fflib_ClassicSelectorFactory() {}
|
||||
|
||||
/**
|
||||
* Constructs a Selector Factory linking SObjectType's with Apex Classes implement the fflib_ISObjectSelector interface
|
||||
* Note that the factory does not check the given Apex Classes implement the interface
|
||||
* currently this is not possible in Apex.
|
||||
*
|
||||
* @param sObjectBySelectorType Map of SObjectType's to Selector Apex Classes
|
||||
**/
|
||||
public fflib_ClassicSelectorFactory(Map<SObjectType, Type> sObjectBySelectorType)
|
||||
{
|
||||
super(sObjectBySelectorType);
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper method to query the given SObject records
|
||||
* Internally creates an instance of the registered Selector and calls its
|
||||
* selectSObjectById method.
|
||||
* It assumes that all Ids are of the given SObjectType, no additional validation is done.
|
||||
*
|
||||
* @param recordIds The recordIds to query
|
||||
* @param sObjectType The SObjectType of the Ids
|
||||
*
|
||||
* @return The queried records
|
||||
* @exception fflib_Application.DeveloperException is thrown if the Ids set is empty
|
||||
*/
|
||||
public virtual List<SObject> selectById(Set<Id> recordIds, SObjectType sObjectType)
|
||||
{
|
||||
if (recordIds == null || recordIds.size() == 0)
|
||||
throw new fflib_Application.DeveloperException('Invalid record Id\'s set');
|
||||
|
||||
return newInstance(sObjectType)
|
||||
.selectSObjectsById(recordIds);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates or replaces an existing binding for another
|
||||
*
|
||||
* @param sObjectType The SObjectType of the selector to replace
|
||||
* @param replacementImplType The implementation type of the replacement
|
||||
*/
|
||||
public virtual void replaceWith(SObjectType sObjectType, Type replacementImplType)
|
||||
{
|
||||
this.m_sObjectBySelectorType.put(sObjectType, replacementImplType);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param selectorInstance The instance of the mocked selector
|
||||
*/
|
||||
public virtual override void setMock(fflib_ISObjectSelector selectorInstance)
|
||||
{
|
||||
super.setMock(selectorInstance);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param sObjectType The SObjectType of the selector mock,
|
||||
* avoids the need to stub the mock to return its SObjectType
|
||||
* @param selectorInstance The instance of the mocked selector
|
||||
*/
|
||||
public virtual void setMock(SObjectType sObjectType, fflib_ISObjectSelector selectorInstance)
|
||||
{
|
||||
this.m_sObjectByMockSelector.put(sObjectType, selectorInstance);
|
||||
}
|
||||
}
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
|
||||
<apiVersion>51.0</apiVersion>
|
||||
<status>Active</status>
|
||||
</ApexClass>
|
||||
+75
@@ -0,0 +1,75 @@
|
||||
/**
|
||||
* File Name: fflib_ClassicServiceFactory
|
||||
* Description:
|
||||
*
|
||||
* @author : architect ir. Wilhelmus G.J. Velzeboer
|
||||
*
|
||||
* Copyright (c), W.G.J. Velzeboer,
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* - Redistributions of source code must retain the above author notice,
|
||||
* this list of conditions and the following disclaimer.
|
||||
* - Redistributions in binary form must reproduce the above copyright notice,
|
||||
* this list of conditions and the following disclaimer in the documentation
|
||||
* and/or other materials provided with the distribution.
|
||||
* - Neither the name of the author nor the names of its contributors
|
||||
* may be used to endorse or promote products derived from this software without
|
||||
* specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
||||
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
||||
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
|
||||
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
public virtual class fflib_ClassicServiceFactory
|
||||
extends fflib_Application.ServiceFactory
|
||||
implements fflib_IServiceFactory
|
||||
{
|
||||
/**
|
||||
* Constructs a simple Service Factory
|
||||
**/
|
||||
public fflib_ClassicServiceFactory() {}
|
||||
|
||||
/**
|
||||
* Constructs a simple Service Factory,
|
||||
* using a Map of Apex Interfaces to Apex Classes implementing the interface
|
||||
* Note that this will not check the Apex Classes given actually implement the interfaces
|
||||
* as this information is not presently available via the Apex runtime
|
||||
*
|
||||
* @param serviceInterfaceTypeByServiceImplType Map ofi interfaces to classes
|
||||
**/
|
||||
public fflib_ClassicServiceFactory(Map<Type, Type> serviceInterfaceTypeByServiceImplType)
|
||||
{
|
||||
super(serviceInterfaceTypeByServiceImplType);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates or replaces an existing binding for another
|
||||
*
|
||||
* @param serviceInterfaceType The Interface type to replace its implementation
|
||||
* @param replacementImplType The implementation type of the replacement
|
||||
*/
|
||||
public virtual void replaceWith(Type serviceInterfaceType, Type replacementImplType)
|
||||
{
|
||||
this.m_serviceInterfaceTypeByServiceImplType.put(
|
||||
serviceInterfaceType,
|
||||
replacementImplType
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param serviceInterfaceType The interface type to mock
|
||||
* @param serviceImpl The mock implementation
|
||||
*/
|
||||
public virtual override void setMock(Type serviceInterfaceType, Object serviceImpl)
|
||||
{
|
||||
super.setMock(serviceInterfaceType, serviceImpl);
|
||||
}
|
||||
}
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
|
||||
<apiVersion>51.0</apiVersion>
|
||||
<status>Active</status>
|
||||
</ApexClass>
|
||||
+57
@@ -0,0 +1,57 @@
|
||||
/**
|
||||
* File Name: fflib_ClassicUnitOfWorkFactory
|
||||
* Description:
|
||||
*
|
||||
* @author : architect ir. Wilhelmus G.J. Velzeboer
|
||||
*
|
||||
* Copyright (c), W.G.J. Velzeboer,
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without modification,
|
||||
* are permitted provided that the following conditions are met:
|
||||
*
|
||||
* - Redistributions of source code must retain the above author notice,
|
||||
* this list of conditions and the following disclaimer.
|
||||
* - Redistributions in binary form must reproduce the above copyright notice,
|
||||
* this list of conditions and the following disclaimer in the documentation
|
||||
* and/or other materials provided with the distribution.
|
||||
* - Neither the name of the author nor the names of its contributors
|
||||
* may be used to endorse or promote products derived from this software without
|
||||
* specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
||||
* THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
||||
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
||||
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
|
||||
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
public virtual class fflib_ClassicUnitOfWorkFactory
|
||||
extends fflib_Application.UnitOfWorkFactory
|
||||
implements fflib_IUnitOfWorkFactory
|
||||
{
|
||||
/**
|
||||
* Constructs a Unit Of Work factory
|
||||
**/
|
||||
public fflib_ClassicUnitOfWorkFactory()
|
||||
{
|
||||
super();
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a Unit Of Work factory
|
||||
*
|
||||
* @param objectTypes List of SObjectTypes in dependency order
|
||||
**/
|
||||
public fflib_ClassicUnitOfWorkFactory(List<SObjectType> objectTypes)
|
||||
{
|
||||
super(objectTypes);
|
||||
}
|
||||
|
||||
public virtual override void setMock(fflib_ISObjectUnitOfWork mockUow)
|
||||
{
|
||||
super.setMock(mockUow);
|
||||
}
|
||||
}
|
||||
+5
@@ -0,0 +1,5 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<ApexClass xmlns="http://soap.sforce.com/2006/04/metadata">
|
||||
<apiVersion>51.0</apiVersion>
|
||||
<status>Active</status>
|
||||
</ApexClass>
|
||||
+2
@@ -42,6 +42,8 @@ public interface fflib_IDomainFactory
|
||||
**/
|
||||
fflib_IDomain newInstance(Set<Id> recordIds);
|
||||
|
||||
fflib_IDomain newInstance(Set<Id> recordIds, Schema.SObjectType objectType);
|
||||
|
||||
/**
|
||||
* Dynamically constructs an instance of the Domain class for the given records
|
||||
* Will return a Mock implementation if one has been provided via setMock
|
||||
|
||||
+8
@@ -81,6 +81,14 @@ public interface fflib_ISelectorFactory
|
||||
**/
|
||||
List<SObject> selectByRelationship(List<SObject> relatedRecords, SObjectField relationshipField);
|
||||
|
||||
/**
|
||||
* Creates or replaces an existing binding for another
|
||||
*
|
||||
* @param sObjectType The SObjectType of the selector to replace
|
||||
* @param replacementImplType The implementation type of the replacement
|
||||
*/
|
||||
void replaceWith(Schema.SObjectType sObjectType, Type replacementImplType);
|
||||
|
||||
/**
|
||||
* @param selectorInstance The instance of the mocked selector
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user