// This Source Code is in the Public Domain per: http://unlicense.org
package org.litesoft.orsup.base;

import org.litesoft.commonfoundation.base.*;
import org.litesoft.orsup.selection.*;
import org.litesoft.orsup.transact.*;

import java.util.*;

public interface MetaDataForPO<T extends PersistentObject> extends SimpleFromIdentifier,
                                                                   Comparable<MetaDataForPO> {
    public MetaDataStore getMetaDataStore();

    public String getDisplayValueFormat();

    /**
     * Reference POs are maintained in memory to minimize the DB reads
     */
    public boolean isReferencePO();

    public boolean isORMetaDataMutating();

    public boolean isImportable();

    public boolean isPotentiallyImmortallyInActive();

    public Mortality getMortality();

    public String getImmortalInactiveAttributeName();

    public String getInstanceImmortalImmortalAttributeName();

    public boolean isUpdatable();

    public String getInstanceManagedUpdatabilityLockedAttributeName();

    public boolean isCreationTimestampable();

    public String getCreationTimestampAttributeName();

    public boolean isTransactionTimestampable();

    public String getTransactionTimestampAttributeName();

    public boolean isRecordVersionable();

    public String getRecordVersionAttributeName();

    public boolean isSnagable();

    public String getSnagAttributeName();

    public String getDefaultOrderByAttributeName();

    public String getPOregistrationName();

    public T createNew( Transaction pTransaction );

    /**
     * a gift to the Groovy world, allows new objects to be initialized via named parameters
     */
    public T createNew( Map<String, ?> pInitialAttributeNameValues, Transaction pTransaction );

    public AttributeAccessorSCD getAccessorSCDrequired( String pAttributeName );

    public AttributeAccessorSCD getAccessorSCDoptional( String pAttributeName );

    public boolean hasAttribute( String pAttributeName );

    /**
     * @return A (!Null) array of all the attribute names available for this PO type
     */
    public String[] getAttributeNames();

    /**
     * @return A (!Null) array of all the AttributeAccessorSCD available for this PO type
     */
    public AttributeAccessorSCD[] getAccessorSCDs();

    public AttributeAccessorSCD[] getPersistingAccessorSCDs();

    public AttributeAccessorKeySet getKeySet();

    public PersistentObjectUniqueKey createUniqueKeyFrom( String pKeyToString )
            throws IllegalArgumentException;

    public Index[] getIndexes();

    public Class getPOclass();

    public static class Index {
        public static final Index[] EMPTY_ARRAY = new Index[0];

        private String mIndexName;
        private String mCreationParameters;
        private boolean mUnique;
        private String[] mColumns;

        public Index( String pIndexName, String pCreationParameters, boolean pUnique, SimpleColumnDefinition... pColumns ) {
            mIndexName = Confirm.significant( "IndexName", pIndexName );
            mCreationParameters = ConstrainTo.notNull( pCreationParameters ).trim();
            mUnique = pUnique;
            Confirm.isNotNullOrEmpty( "Columns", pColumns );
            mColumns = new String[pColumns.length];
            for ( int i = 0; i < pColumns.length; i++ ) {
                mColumns[i] = pColumns[i].getSearchColumnName();
            }
        }

        public String getIndexName() {
            return mIndexName;
        }

        public String getCreationParameters() {
            return mCreationParameters;
        }

        public boolean isUnique() {
            return mUnique;
        }

        public String[] getColumns() {
            return mColumns;
        }
    }
}