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