org.broadleafcommerce.common.site.service.SiteServiceExtensionHandler Maven / Gradle / Ivy
/*
* #%L
* BroadleafCommerce Common Libraries
* %%
* Copyright (C) 2009 - 2014 Broadleaf Commerce
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* #L%
*/
package org.broadleafcommerce.common.site.service;
import org.broadleafcommerce.common.extension.ExtensionHandler;
import org.broadleafcommerce.common.extension.ExtensionResultStatusType;
import org.broadleafcommerce.common.site.domain.Site;
import org.broadleafcommerce.common.site.domain.SiteImpl;
/**
*
* ExtensionHandler for methods within {@link SiteServiceImpl}
*
*
* Rather than implementing this interface directly you should extend your implementation from
* {@link AbstractSiteServiceExtensionHandler}.
*
* @author Phillip Verheyden (phillipuniverse)
* @see {@link AbstractSiteServiceExtensionHandler}
*/
public interface SiteServiceExtensionHandler extends ExtensionHandler {
/**
* Invoked via {@link SiteServiceImpl#getNonPersistentSite(Site)} after the initial framework clone. If more properties
* are dynamically weaved into {@link SiteImpl} then they should be cloned here.
*
* @param from the {@link Site} being copied from, usually just looked up from the database
* @param to the
* @see {@link SiteServiceImpl#getNonPersistentSite(Site)}
*/
public ExtensionResultStatusType contributeNonPersitentSiteProperties(Site from, Site to);
}