001package ca.uhn.fhir.interceptor.api;
002
003/*-
004 * #%L
005 * HAPI FHIR - Core Library
006 * %%
007 * Copyright (C) 2014 - 2021 Smile CDR, Inc.
008 * %%
009 * Licensed under the Apache License, Version 2.0 (the "License");
010 * you may not use this file except in compliance with the License.
011 * You may obtain a copy of the License at
012 *
013 *      http://www.apache.org/licenses/LICENSE-2.0
014 *
015 * Unless required by applicable law or agreed to in writing, software
016 * distributed under the License is distributed on an "AS IS" BASIS,
017 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
018 * See the License for the specific language governing permissions and
019 * limitations under the License.
020 * #L%
021 */
022
023public interface IBaseInterceptorBroadcaster<POINTCUT extends IPointcut> {
024
025        /**
026         * Invoke registered interceptor hook methods for the given Pointcut.
027         *
028         * @return Returns <code>false</code> if any of the invoked hook methods returned
029         * <code>false</code>, and returns <code>true</code> otherwise.
030         */
031        boolean callHooks(POINTCUT thePointcut, HookParams theParams);
032
033        /**
034         * Invoke registered interceptor hook methods for the given Pointcut. This method
035         * should only be called for pointcuts that return a type other than
036         * <code>void</code> or <code>boolean</code>
037         *
038         * @return Returns the object returned by the first hook method that did not return <code>null</code>
039         */
040        Object callHooksAndReturnObject(POINTCUT thePointcut, HookParams theParams);
041
042        /**
043         * Does this broadcaster have any hooks for the given pointcut?
044         *
045         * @param thePointcut The poointcut
046         * @return Does this broadcaster have any hooks for the given pointcut?
047         * @since 4.0.0
048         */
049        boolean hasHooks(POINTCUT thePointcut);
050}