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

import java.util.*;

import org.litesoft.bo.*;
import org.litesoft.changemanagement.ServerStateChange.*;
import org.litesoft.encryption.symmetric.*;
import org.litesoft.orsup.selection.nonpublic.*;
import org.litesoft.orsup.transact.*;

public interface PersistentObject<T extends PersistentObject> extends WhereClauseToSQLable,
                                                                      Comparable<PersistentObject>
{
    public SymmetricEncryptorManager getEncryptorManager();

    /**
     * @return either the Transaction's finder if in a Transaction of the DataStore's finder
     */
    public Finder getFinder();

    public NonTransactionalFinder<?> getNonTransactionalFinder();

    public Transaction getTransaction();

    public String getObjectName();

    public String getRegisteredName();

    public PersistentObjectUniqueKey getPersistentObjectUniqueKey();

    public PersistentObjectURL getPersistentObjectURL();

    public ObjectHandle getObjectHandle();

    public String getDisplayValue();

    public boolean isImmortal();

    public boolean isUpdatable();

    public void requestDelete();

    public boolean isDeleteRequested();

    public boolean isNew();

    public boolean isDirty();

    public void forceUpdate();

    public void forceChangeNotification();

    public boolean isForcedChangeNotification();

    public int getChangeNumber();

    public int numberOfAttributeChanged();

    public boolean isAnyAttributeChanged();

    public String[] getChangedAttributeNames();

    public Object getOriginalValueFor( String pAttributeName );

    public void rehydationComplete();

    /**
     * @return is Attribute exists && if it has changed
     */
    public boolean isAttributeChanged( String pAttributeName );

    public boolean isAttributeChanged( AttributeAccessorSCD pAttributeAccessorSCD );

    public Object getAttributeValue( String pAttributeName )
            throws NoSuchElementException;

    public void setAttributeValue( String pAttributeName, Object pValue )
            throws NoSuchElementException, AttributeIllegalArgumentException;

    public void addToAttributeSet( String pAttributeName, PersistentObject<?> pPOtoAdd )
            throws NoSuchElementException, AttributeIllegalArgumentException;

    public void removeFromAttributeSet( String pAttributeName, PersistentObject<?> pPOtoRemove )
            throws NoSuchElementException, AttributeIllegalArgumentException;

    /**
     * @return non-Transactional copy of the latest version of this PO, or Null if the PO is in a Transaction and isNew() OR has been deleted
     */
    public T refreshNonTransactionally();

    /**
     * Refresh this PO into the provided transaction.
     *
     * @param pTransaction !null
     *
     * @return Transactional copy of the latest version read via Transaction, or Null if the PO is in another Transaction and isNew() OR has been deleted
     *
     * @throws UnsupportedOperationException - if the PO is already in the Transaction
     */
    public T refreshInto( Transaction pTransaction )
            throws UnsupportedOperationException;

    /**
     * Copy this PO (without re-fetching it) into the provided transaction.
     *
     * @param pTransaction !null
     *
     * @return copy of this PO
     */
    public T copyInto( Transaction pTransaction )
            throws UnsupportedOperationException;

    public MetaDataForPO getMetaDataForPO();

    /**
     * If the PO is in a Transaction, this method returns the appropriate StateChange.Action. If the PO is not
     * in a Transaction it returns null.
     *
     * @return DELETED if isDeleteRequest(); CREATED if isNew(); UPDATED if getTransaction() != null;
     *         otherwise null.
     */
    public Action makeStateChangeAction();

    public boolean willTossFromTransactionCommit();
}