com.formkiq.server.dao.ClientDao Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of formkiq-server Show documentation

Server-side integration for the FormKiQ ios application

There is a newer version: 0.6.1

/*
 * Copyright (C) 2016 FormKiQ Inc.
 *
 * Licensed 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 com.formkiq.server.dao;

import com.formkiq.server.domain.User;
import com.formkiq.server.domain.type.ClientDTO;
import com.formkiq.server.domain.type.ClientListDTO;

/**
 * Methods for retrieving Client data from the database.
 *
 */
public interface ClientDao {

    /** Additional Information Key. */
    String CLIENT_NAME = "clientName";

    /**
     * Client Count.
     * @return int
     */
    int clientCount();

    /**
     * Find Client.
     * @param user {@link User}
     * @param client {@link String}
     * @return {@link ClientDTO}
     */
    ClientDTO findClient(User user, String client);

    /**
     * Find Clients.
     * @param token {@link String}
     * @return {@link ClientListDTO}
     */
    ClientListDTO findClients(final String token);

    /**
     * Gets the client name from string.
     * @param s {@link String}
     * @return {@link String}
     */
    String getClientnameFromString(final String s);
}