/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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.
*/
package org.apache.isis.applib.services.background;
import java.lang.reflect.Method;
import org.apache.isis.applib.annotation.Programmatic;
/**
* Submit actions to be invoked in the background.
*
* <p>
* Example usage:
* <pre>
* public void submitInvoices() {
* for(Customer customer: customerRepository.findCustomersToInvoice()) {
* backgroundService.execute(customer).submitInvoice();
* }
* }
*
* @javax.inject.Inject
* private BackgroundService backgroundService;
* </pre>
*/
public interface BackgroundService {
/**
* Returns a proxy around the object (entity or view model) which is then used to obtain the
* signature of the action to be invoked in the background.
*
* <p>
* To obtain a proxy for a mixin, use {@link BackgroundService2#executeMixin(Class, Object)}.
* </p>
*/
@Programmatic
<T> T execute(final T object);
/**
* Not API: for framework use only.
*
* @deprecated - no longer called by the framework (moved to <tt>InteractionDtoServiceInternal</tt>, an internal SPI service).
*/
@Deprecated
@Programmatic
ActionInvocationMemento asActionInvocationMemento(Method m, Object domainObject, Object[] args);
}