Interface structure for Application Factories
This commit is contained in:
Wim Velzeboer
+97
@@ -0,0 +1,97 @@
|
||||
/**
|
||||
* File Name: fflib_IDomainFactory
|
||||
* Description: Interface for creating instances of Service classes
|
||||
*
|
||||
* @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 interface fflib_IDomainFactory
|
||||
{
|
||||
/**
|
||||
* 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
|
||||
* @exception Throws an exception via the Selector Factory if the Ids are not all of the same SObjectType
|
||||
*
|
||||
* @return Instance of the Domain
|
||||
**/
|
||||
fflib_IDomain newInstance(Set<Id> recordIds);
|
||||
|
||||
/**
|
||||
* Dynamically constructs an instance of the Domain class for the given records
|
||||
* Will return a Mock implementation if one has been provided via setMock
|
||||
*
|
||||
* @param records A concrete list (e.g. List<Account> vs List<SObject>) of records
|
||||
* @exception Throws an exception if the SObjectType cannot be determined from the list
|
||||
* or the constructor for Domain class was not registered for the SObjectType
|
||||
*
|
||||
* @return Instance of the Domain
|
||||
**/
|
||||
fflib_IDomain newInstance(List<SObject> records);
|
||||
|
||||
fflib_IDomain newInstance(List<Object> objects, Object objectType);
|
||||
|
||||
/**
|
||||
* Dynamically constructs an instance of the Domain class for the given records and SObjectType
|
||||
* Will return a Mock implementation if one has been provided via setMock
|
||||
*
|
||||
* @param records A list records
|
||||
* @param domainSObjectType SObjectType for list of records
|
||||
* @exception Throws an exception if the SObjectType is not specified or if constructor for Domain class was not registered for the SObjectType
|
||||
*
|
||||
* @remark Will support List<SObject> but all records in the list will be assumed to be of
|
||||
* the type specified in sObjectType
|
||||
*
|
||||
* @return Instance of the Domain
|
||||
**/
|
||||
fflib_IDomain newInstance(List<SObject> records, SObjectType domainSObjectType);
|
||||
|
||||
/**
|
||||
* @param mockDomain The instance of the Domain mock
|
||||
*/
|
||||
void setMock(fflib_ISObjectDomain 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
|
||||
*/
|
||||
void setMock(Schema.SObjectType sObjectType, fflib_ISObjectDomain mockDomain);
|
||||
|
||||
/**
|
||||
* @param mockDomain The instance of the Domain mock
|
||||
*/
|
||||
void setMock(fflib_IDomain 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
|
||||
*/
|
||||
void setMock(Type domainType, fflib_IDomain 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>
|
||||
+96
@@ -0,0 +1,96 @@
|
||||
/**
|
||||
* File Name: fflib_ISelectorFactory
|
||||
* Description: Interface for creating instances of Selector classes
|
||||
*
|
||||
* @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 interface fflib_ISelectorFactory
|
||||
{
|
||||
/**
|
||||
* Creates a new instance of the associated Apex Class implementing fflib_ISObjectSelector
|
||||
* for the given SObjectType, or if provided via setMock returns the Mock implementation
|
||||
*
|
||||
* @param sObjectType An SObjectType token, e.g. Account.SObjectType
|
||||
*
|
||||
* @return Instance of fflib_ISObjectSelector
|
||||
**/
|
||||
fflib_ISObjectSelector newInstance(Schema.SObjectType sObjectType);
|
||||
|
||||
/**
|
||||
* Helper method to query the given SObject records
|
||||
* Internally creates an instance of the registered Selector and calls its
|
||||
* selectSObjectById method
|
||||
*
|
||||
* @param recordIds The SObject record Ids, must be all the same SObjectType
|
||||
* @exception Is thrown if the record Ids are not all the same or the SObjectType is not registered
|
||||
*
|
||||
* @return List of queried records
|
||||
**/
|
||||
List<SObject> selectById(Set<Id> recordIds);
|
||||
|
||||
/**
|
||||
* Helper method to query the given SObject records
|
||||
* Internally creates an instance of the registered Selector and calls its
|
||||
* selectSObjectById method
|
||||
*
|
||||
* @param recordIds The SObject record Ids, must be all the same SObjectType
|
||||
* @exception Is thrown if the record Ids are not all the same or the SObjectType is not registered
|
||||
* @param sObjectType The SObjectType of the provided Ids
|
||||
*
|
||||
* @return List of queried records
|
||||
**/
|
||||
List<SObject> selectById(Set<Id> recordIds, Schema.SObjectType sObjectType);
|
||||
|
||||
/**
|
||||
* Helper method to query related records to those provided, for example
|
||||
* if passed a list of Opportunity records and the Account Id field will
|
||||
* construct internally a list of Account Ids and call the registered
|
||||
* Account selector to query the related Account records, e.g.
|
||||
*
|
||||
* List<Account> accounts =
|
||||
* (List<Account>) Application.Selector.selectByRelationship(myOpps, Opportunity.AccountId);
|
||||
*
|
||||
* @param relatedRecords used to extract the related record Ids, e.g. Opportunity records
|
||||
* @param relationshipField field in the passed records that contains the relationship records to query, e.g. Opportunity.AccountId
|
||||
*
|
||||
* @return List of queried records
|
||||
**/
|
||||
List<SObject> selectByRelationship(List<SObject> relatedRecords, SObjectField relationshipField);
|
||||
|
||||
/**
|
||||
* @param selectorInstance The instance of the mocked selector
|
||||
*/
|
||||
void setMock(fflib_ISObjectSelector 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
|
||||
*/
|
||||
void setMock(Schema.SObjectType sObjectType, fflib_ISObjectSelector 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>
|
||||
+58
@@ -0,0 +1,58 @@
|
||||
/**
|
||||
* File Name: fflib_IServiceFactory
|
||||
* Description: Interface for creating instances of Service classes
|
||||
*
|
||||
* @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 interface fflib_IServiceFactory
|
||||
{
|
||||
/**
|
||||
* Returns a new instance of the Apex class associated with the given Apex interface
|
||||
* Will return any mock implementation of the interface provided via setMock
|
||||
* Note that this method will not check the configured Apex class actually implements the interface
|
||||
*
|
||||
* @param serviceInterfaceType Apex interface type
|
||||
* @exception Is thrown if there is no registered Apex class for the interface type
|
||||
*
|
||||
* @return Instance of the requested service class interface type
|
||||
**/
|
||||
Object newInstance(Type serviceInterfaceType);
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
void replaceWith(Type serviceInterfaceType, Type replacementImplType);
|
||||
|
||||
/**
|
||||
* @param serviceInterfaceType The interface type to mock
|
||||
* @param serviceImpl The mock implementation
|
||||
*/
|
||||
void setMock(Type serviceInterfaceType, Object 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>
|
||||
+80
@@ -0,0 +1,80 @@
|
||||
/**
|
||||
* File Name: fflib_IUnitOfWorkFactory
|
||||
* Description: Interface for creating instances of fflib_ISObjectUnitOfWork
|
||||
*
|
||||
* @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 interface fflib_IUnitOfWorkFactory
|
||||
{
|
||||
/**
|
||||
* Returns a new fflib_SObjectUnitOfWork configured with the
|
||||
* SObjectType list provided in the constructor, returns a Mock implementation
|
||||
* if set via the setMock method
|
||||
*
|
||||
* @return Instance of fflib_ISObjectUnitOfWork
|
||||
**/
|
||||
fflib_ISObjectUnitOfWork newInstance();
|
||||
|
||||
/**
|
||||
* Returns a new fflib_SObjectUnitOfWork configured with the
|
||||
* SObjectType list provided in the constructor, returns a Mock implementation
|
||||
* if set via the setMock method
|
||||
*
|
||||
* @param dml A custom implementation of the IDML to perform the database operations
|
||||
*
|
||||
* @return Instance of fflib_ISObjectUnitOfWork
|
||||
**/
|
||||
fflib_ISObjectUnitOfWork newInstance(fflib_SObjectUnitOfWork.IDML dml);
|
||||
|
||||
/**
|
||||
* Returns a new fflib_SObjectUnitOfWork configured with the
|
||||
* SObjectType list specified, returns a Mock implementation
|
||||
* if set via the setMock method
|
||||
*
|
||||
* @param objectTypes The hierarchical structure of the SObjectTypes
|
||||
*
|
||||
* @return Instance of fflib_ISObjectUnitOfWork
|
||||
**/
|
||||
fflib_ISObjectUnitOfWork newInstance(List<Schema.SObjectType> objectTypes);
|
||||
|
||||
/**
|
||||
* Returns a new fflib_SObjectUnitOfWork configured with the
|
||||
* SObjectType list specified, returns a Mock implementation
|
||||
* if set via the setMock method
|
||||
*
|
||||
* @param objectTypes The hierarchical structure of the SObjectTypes
|
||||
* @param dml A custom implementation of the IDML to perform the database operations
|
||||
*
|
||||
* @return Instance of fflib_ISObjectUnitOfWork
|
||||
**/
|
||||
fflib_ISObjectUnitOfWork newInstance(List<Schema.SObjectType> objectTypes, fflib_SObjectUnitOfWork.IDML dml);
|
||||
|
||||
/**
|
||||
* @param mockUow A mock implementation for the unitOfWork factory
|
||||
*/
|
||||
void setMock(fflib_ISObjectUnitOfWork 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>
|
||||
Reference in New Issue
Block a user