All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.landawn.abacus.core.command.Command Maven / Gradle / Ivy

The newest version!
/*
 * Copyright (c) 2015, Haiyang Li.
 * 
 * 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.landawn.abacus.core.command;

import java.util.Map;

import com.landawn.abacus.metadata.EntityDefinition;
import com.landawn.abacus.type.Type;
import com.landawn.abacus.util.OperationType;

// TODO: Auto-generated Javadoc
/**
 *
 * @author Haiyang Li
 * @since 0.8
 */
public interface Command {

    /**
     * Gets the operation type.
     *
     * @return
     */
    OperationType getOperationType();

    /**
     * Gets the entity def.
     *
     * @return
     */
    EntityDefinition getEntityDef();

    /**
     * Gets the options.
     *
     * @return
     */
    Map getOptions();

    /**
     * Gets the parameters.
     *
     * @return
     */
    Object[] getParameters();

    /**
     * Gets the parameter types.
     *
     * @return
     */
    Type[] getParameterTypes();

    /**
     * Gets the parameter.
     *
     * @param index
     * @return
     */
    Object getParameter(int index);

    /**
     * Gets the parameter type.
     *
     * @param index
     * @return
     */
    Type getParameterType(int index);

    /**
     * Sets the parameter.
     *
     * @param index
     * @param value
     * @param type
     */
    void setParameter(int index, Object value, Type type);

    /**
     * Gets the parameter.
     *
     * @param parameterName
     * @return
     */
    Object getParameter(String parameterName);

    /**
     * Gets the parameter type.
     *
     * @param parameterName
     * @return
     */
    Type getParameterType(String parameterName);

    /**
     * Sets the parameter.
     *
     * @param parameterName
     * @param value
     * @param type
     */
    void setParameter(String parameterName, Object value, Type type);

    /**
     * Gets the parameter count.
     *
     * @return
     */
    int getParameterCount();

    /**
     * Clear parameters.
     */
    void clearParameters();

    /**
     *
     * @param 
     * @return
     */
     T copy();

    /**
     * Clear.
     */
    void clear();
}