org.broadleafcommerce.common.sandbox.ProductionOnlyRequest 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.sandbox;
import org.broadleafcommerce.common.presentation.AdminPresentationAdornedTargetCollection;
import org.broadleafcommerce.common.presentation.AdminPresentationCollection;
import org.broadleafcommerce.common.presentation.AdminPresentationToOneLookup;
/**
* Holder for the {@link #CRITERIA} constant
*
* @author Phillip Verheyden (phillipuniverse)
*/
public interface ProductionOnlyRequest {
/**
*
* Determines that all admin persistence request should be in production and skip any workflow/sandbox processing
* This can be added as customCriteria to any
* {@link PersistencePackage#getCustomCriteria()} or any of the {@link AdminPresentationCollection#customCriteria()},
* {@link AdminPresentationAdornedTargetCollection#customCriteria()}, {@link AdminPresentationToOneLookup#customCriteria()}
* annotations.
*
*
* One use case for this is for all inventory requests in the advanced inventory module. When executing Sku lookups
* or actually displaying the list of inventory in the admin, all of those requests should be made against production
* records
*
*
* This criteria is only utilized within the enterprise module.
*/
public static final String CRITERIA = "PRODUCTION_ONLY_REQUEST";
}