SingleResultType.java

/*
 * 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.deltaspike.data.api;

/**
 * Defines the way a single result query is fetched.
 */
public enum SingleResultType
{

    /**
     * Expects a single result, throws a {@link javax.persistence.NoResultException} or
     * {@link javax.persistence.NonUniqueResultException} otherwise. This is the JPA
     * default behavior.
     */
    JPA,

    /**
     * Expects a single result. Other than {@link SingleResultType#JPA} it returns {@code null}
     * if no result is found.
     */
    OPTIONAL,

    /**
     * Returns any result, or {@code null} if nothing is found. If more than one result is found,
     * it returns the first one from the result list.
     */
    ANY

}