001/*
002 * (C) Copyright 2014 Nuxeo SA (http://nuxeo.com/) and others.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * Contributors:
017 *     Nicolas Chapurlat <nchapurlat@nuxeo.com>
018 */
019
020package org.nuxeo.ecm.core.api.model.resolver;
021
022import java.util.List;
023
024import org.nuxeo.ecm.core.schema.types.resolver.ObjectResolver;
025
026/**
027 * Object to resolve entities referenced by a property. Works only on properties whose type has an object resolver.
028 *
029 * @since 7.1
030 */
031public interface PropertyObjectResolver {
032
033    /**
034     * {@link ObjectResolver#getManagedClasses()}
035     *
036     * @since 7.2
037     */
038    List<Class<?>> getManagedClasses();
039
040    /**
041     * {@link ObjectResolver#validate(Object)}
042     *
043     * @since 7.1
044     */
045    boolean validate();
046
047    /**
048     * {@link ObjectResolver#validate(Object,Object)}
049     *
050     * @since 10.2
051     */
052    default boolean validate(Object context) {
053        return validate();
054    }
055
056    /**
057     * {@link ObjectResolver#fetch(Object)}
058     *
059     * @since 7.1
060     */
061    Object fetch();
062
063    /**
064     * {@link ObjectResolver#fetch(Object,Object)}
065     *
066     * @since 10.2
067     */
068    default Object fetch(Object context) {
069        return fetch();
070    }
071
072    /**
073     * {@link ObjectResolver#fetch(Class, Object)}
074     *
075     * @since 7.1
076     */
077    <T> T fetch(Class<T> type);
078
079    /**
080     * Gets a reference to the object and set the corresponding value to this property.
081     * {@link ObjectResolver#fetch(Class, Object)}
082     *
083     * @since 7.1
084     */
085    void setObject(Object object);
086
087    /**
088     * Returns the underlying {@link ObjectResolver}.
089     *
090     * @since 7.1
091     */
092    ObjectResolver getObjectResolver();
093
094}