package gu.sql2java;

import java.util.Map;

/**
 * general operation definition for accessing a record from database  
 * @author guyadong
 *
 */
public interface BaseBean {
    /**
     * Determines if the current object is new.
     *
     * @return true if the current object is new, false if the object is not new
     */
    public boolean isNew();
    
    /**
         * Specifies to the object if it has been set as new.
         *
         * @param isNew the boolean value to be assigned to the isNew field
         */
        public void setNew(boolean isNew);

        /**
     * @return the initialized status of columns
     */
    public int getInitialized();

    /**
     * @param initialized the initialized status of columns 
     */
    public void setInitialized(int initialized);
    
    /**
     * @return the modified status of columns
     */
    public int getModified();
    
    /**
     * @param modified the modified status of columns
     */
    public void setModified(int modified);
    
    /**
     * Determines if the object has been modified since the last time this method was called.<br>
     * We can also determine if this object has ever been modified since its creation.
     *
     * @return true if the object has been modified, false if the object has not been modified
     */
    public boolean beModified();
    /**
     * Resets the object modification status to 'not modified'.
     */
    public void resetIsModified();
    /**
     * Resets the primary keys modification status to 'not modified'.
     */
    public void resetPrimaryKeysModified();
    /**
     * Determines if the {@code columnID} has been initialized.<br>
     * It is useful to determine if a field is null on purpose or just because it has not been initialized.
     * @param columnID column id
     * @return true if the field has been initialized, false otherwise
     */
    public boolean isInitialized(int columnID);
    /**
     * Determines if the {@code column} has been modified.
     * @param columnID column id
     * @return true if the field has been modified, false if the field has not been modified
     */
    public boolean isModified(int columnID);
    /**
     * Determines if the {@code column} has been initialized.<br>
     * It is useful to determine if a field is null on purpose or just because it has not been initialized.
     * @param column column name
     * @return true if the field has been initialized, false otherwise
     */
    public boolean isInitialized(String column);
    /**
     * Determines if the {@code column} has been modified.
     * @param column column name
     * @return true if the field has been modified, false if the field has not been modified
     */
    public boolean isModified(String column);
    /**
     * Copies the passed bean into the current bean.
     *
     * @param bean the bean to copy into the current bean
     * @return this bean
     */
    public <B extends BaseBean> B copy(B bean);
    /**
     * Copies the passed bean into the current bean.
     *
     * @param bean the bean to copy into the current bean
     * @param fieldList the column id list to copy into the current bean,if null or empty,copy all fields
     * @return always this bean
     */
    public <B extends BaseBean> B copy(B bean, int... fieldList);
    /**
     * Copies the passed bean into the current bean.
     *
     * @param bean the bean to copy into the current bean
     * @param fieldList the column name list to copy into the current bean
     * @return always this bean
     */
    public <B extends BaseBean> B copy(B bean, String... fieldList);
    /**
     * Copies the passed F bean into the current bean.
     * @param <B> from bean type
     * @param <F> this bean type
     * @param from
     * @param columnsMap columns map from F to B 
     * @return always this bean
     */
    <B extends BaseBean, F extends BaseBean> B copy(F from, Map<Integer,Integer> columnsMap);
    
    /**
     * Copies the passed values into the current bean.
     * @param values
     * @return always this bean
     */
    public <B extends BaseBean> B copy(Map<Integer, Object>values);
        /**
     * 
     * @param columnID column id
     * @return return a object representation of the given column id
     */
    public <T> T getValue(int columnID);
    /**
     * set a value representation of the given column id
     * @param columnID column id
     * @param value
     */
    public <T> void setValue(int columnID,T value);
    /**
     * 
     * @param column column name
     * @return return a object representation of the given field
     */
    public <T> T getValue(String column);
    /**
     * 
     * @param columnID column id
     * @return return a object representation of the given column id or throw {@link NullPointerException} if value is null
     */
    public <T> T getValueChecked(int columnID);
    /**
     * 
     * @param column column name
     * @return return a object representation of the given field or throw {@link NullPointerException} if value is null
     */
    public <T> T getValueChecked(String column);
    /**
     * set a value representation of the given field
     * @param column column name
     * @param value
     */
    public <T> void setValue(String column,T value);
    
    /**
     * @param columnIds column id that will be output, if null or empty,output all columns
     * @return values array for all fields
     */
    public Object[] asValueArray(int...columnIds);
    /**
         * @return values map for all fields, column name -- value
         */
        public Map<String, Object> asNameValueMap();

    /**
     * @return values array for all primary key, empty array if no primary key
     */
    public Object[] primaryValues();
    /**
     * @param <T> PK type
     * @return value for primary key, throw {@link UnsupportedOperationException} if there is more than one primary key
     */
    public <T> T primaryValue();
   
    /**
     * @return table name of this bean
     */
    public String tableName();

        /**
     * @param notNull output not null field only if {@code true}
     * @param fullIfStringOrBytes for string or bytes field,output full content if {@code true},otherwise output length.
     * @return Returns a string representation of the object
     */
    public String toString(boolean notNull, boolean fullIfStringOrBytes);

}