// This Source Code is in the Public Domain per: http://litesoft.org/License.txt
package org.litesoft.ui.def.nonpublic.support;

import java.io.*;

import org.litesoft.commonfoundation.typeutils.*;
import org.litesoft.core.util.*;

public abstract class AbstractServicePeerToFormData
{
    protected AbstractServicePeerToFormData()
    {
    }

    abstract public Integer getAsyncMessageNumber();

    abstract public boolean isFullUpdate();

    abstract public String getRootType();

    abstract public String getRootObjectKey();

    /**
     * @return !null
     */
    public final ActionUpdateFormData[] getActionUpdates()
    {
        ActionUpdateFormData[] rv = LLgetActionUpdates();
        return (rv != null) ? rv : ActionUpdateFormData.EMPTY_ARRAY;
    }

    /**
     * @return !null
     */
    public final AttributeUpdateFormData[] getAttributeUpdates()
    {
        AttributeUpdateFormData[] rv = LLgetAttributeUpdates();
        return (rv != null) ? rv : AttributeUpdateFormData.EMPTY_ARRAY;
    }

    /**
     * @return !null
     */
    public final RelSubFormRowKeys[] getRelSubFormRowKeysList()
    {
        RelSubFormRowKeys[] rv = LLgetRelSubFormRowKeysList();
        return (rv != null) ? rv : RelSubFormRowKeys.EMPTY_ARRAY;
    }

    /**
     * @return !null
     */
    public final String[] getFormErrors()
    {
        String[] rv = LLgetFormErrors();
        return (rv != null) ? rv : Strings.EMPTY_ARRAY;
    }

    /**
     * @return !null
     */
    public final String[] getFormWarnings()
    {
        String[] rv = LLgetFormWarnings();
        return (rv != null) ? rv : Strings.EMPTY_ARRAY;
    }

    abstract public boolean isCloseRequested();

    abstract public String getSuccessfulTriggeringActionID();

    abstract public Serializable getServicePeerXtra();

    /**
     * @return null or !empty
     */
    abstract protected ActionUpdateFormData[] LLgetActionUpdates();

    /**
     * @return null or !empty
     */
    abstract protected String[] LLgetFormErrors();

    /**
     * @return null or !empty
     */
    abstract protected String[] LLgetFormWarnings();

    /**
     * @return null or !empty
     */
    abstract protected AttributeUpdateFormData[] LLgetAttributeUpdates();

    abstract protected RelSubFormRowKeys[] LLgetRelSubFormRowKeysList();

    public String toString()
    {
        StringBuilder zSB = new StringBuilder();
        zSB.append( "ServicePeerToFormData(" ).append( getAsyncMessageNumber() ).append( "):" );
        return toStringBuilder( zSB, 0 ).toString();
    }

    public StringBuilder toStringBuilder( StringBuilder pSB, int pDepth )
    {
        pSB.append( isCloseRequested() ? "CloseRequested" : "---" );
        pSB.append( ',' );
        pSB.append( (getSuccessfulTriggeringActionID() != null) ? getSuccessfulTriggeringActionID() : "--" );
        pSB.append( ',' );
        String zRootType = getRootType();
        String zKey = getRootObjectKey();
        if ( zRootType == null )
        {
            if ( zKey == null )
            {
                pSB.append( "-" );
            }
            else
            {
                pSB.append( '(' ).append( zKey ).append( ')' );
            }
        }
        else
        {
            pSB.append( zRootType );
            if ( zKey != null )
            {
                pSB.append( '(' ).append( zKey ).append( ')' );
            }
        }
        if ( isFullUpdate() )
        {
            pSB.append( '!' );
        }
        if ( getServicePeerXtra() != null )
        {
            pSB.append( ',' ).append( getServicePeerXtra() );
        }
        ActionUpdateFormData[] zActionUpdates = LLgetActionUpdates();
        if ( zActionUpdates != null )
        {
            LineIndentUtil.newLine( pSB, pDepth + 1 ).append( "Actions:" );
            for ( int i = 0; i < zActionUpdates.length; i++ )
            {
                LineIndentUtil.newLine( pSB, pDepth + 2 );
                zActionUpdates[i].toStringBuilder( pSB, pDepth + 2 );
            }
        }
        String[] zFormErrors = LLgetFormErrors();
        if ( zFormErrors != null )
        {
            LineIndentUtil.newLine( pSB, pDepth + 1 ).append( "Errors:" );
            for ( int i = 0; i < zFormErrors.length; i++ )
            {
                LineIndentUtil.newLine( pSB, pDepth + 2 ).append( zFormErrors[i] );
            }
        }
        String[] zFormWarnings = LLgetFormWarnings();
        if ( zFormWarnings != null )
        {
            LineIndentUtil.newLine( pSB, pDepth + 1 ).append( "Warnings:" );
            for ( int i = 0; i < zFormWarnings.length; i++ )
            {
                LineIndentUtil.newLine( pSB, pDepth + 2 ).append( zFormWarnings[i] );
            }
        }

        AttributeUpdateFormData[] zAttributeUpdates = LLgetAttributeUpdates();
        if ( zAttributeUpdates != null )
        {
            LineIndentUtil.newLine( pSB, pDepth + 1 ).append( "Attributes:" );
            for ( int i = 0; i < zAttributeUpdates.length; i++ )
            {
                LineIndentUtil.newLine( pSB, pDepth + 2 );
                zAttributeUpdates[i].toStringBuilder( pSB, pDepth + 2 );
            }
        }

        RelSubFormRowKeys[] zRelSubFormRowKeysList = LLgetRelSubFormRowKeysList();
        if ( zRelSubFormRowKeysList != null )
        {
            LineIndentUtil.newLine( pSB, pDepth + 1 ).append( "RelSubFormRowKeysList:" );
            for ( int i = 0; i < zRelSubFormRowKeysList.length; i++ )
            {
                LineIndentUtil.newLine( pSB, pDepth + 2 );
                zRelSubFormRowKeysList[i].toStringBuilder( pSB, pDepth + 2 );
            }
        }

        return pSB;
    }

    public abstract FormPopupMessage[] getPopups();
}