org.seedstack.i18n.rest.internal.key.KeyFinder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of i18n-rest Show documentation

The newest version!

/*
 * Copyright © 2013-2018, The SeedStack authors 
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
package org.seedstack.i18n.rest.internal.key;


import org.seedstack.business.finder.Finder;
import org.seedstack.business.view.Page;
import org.seedstack.business.view.PaginatedView;

import java.util.List;

/**
 * @author [email protected]
 */
@Finder
public interface KeyFinder {

    /**
     * Returns a key for a specified locale.
     *
     * @param name key name
     * @return a key representation
     */
    KeyRepresentation findKeyWithName(String name);

    /**
     * Returns request ranged result of key representations.
     *
     * @param page    the page to query
     * @param criteria the criteria filters
     * @return paginated key representations
     */
    PaginatedView findKeysWithTheirDefaultTranslation(Page page, KeySearchCriteria criteria);

    /**
     * Finds all keys with criteria.
     *
     * @param criteria criteria
     * @return list of key representation
     */
    List findKeysWithTheirDefaultTranslation(KeySearchCriteria criteria);
}