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

import java.io.*;

import org.litesoft.core.typeutils.*;
import org.litesoft.ui.def.nonpublic.support.*;

public class FormUsage extends AbstractFormUsage implements Serializable,
                                                            UiUsage
{
    public static final long serialVersionUID = -7832343234032168111L;

    public static final FormUsage[] EMPTY_ARRAY = new FormUsage[0];

    // Basic Base Form
    private boolean mHot = false;
    private String mRootType = null;

    // Basic Sub Form
    private String mRelAttributeRef = null;

    // Shared
    private Integer mUniqueID;
    private IntendedUse mIntendedUse;
    private LabelUsage[] mLabels;
    private ActionUsage[] mActions;
    private AttributeUsage[] mAttributes;
    private FormUsage[] mRelSubForms;

    /**
     * @deprecated GWT ONLY
     */
    public FormUsage()
    {
    }

    public FormUsage( boolean pIsRoot, String pRootTypeOrRelAttributeRef, boolean pHot, //
                      Integer pUniqueID, IntendedUse pIntendedUse, //
                      LabelUsage[] pLabels, //
                      ActionUsage[] pActions, //
                      AttributeUsage[] pAttributes, //
                      FormUsage[] pRelSubForms )
    {
        if ( pIsRoot )
        {
            mRootType = required( "RootType", pRootTypeOrRelAttributeRef );
            mHot = pHot;
        }
        else
        {
            mRelAttributeRef = required( "RelAttributeRef", pRootTypeOrRelAttributeRef );
        }
        Objects.assertNotNull( "UniqueID", mUniqueID = pUniqueID );
        Objects.assertNotNull( "IntendedUse", mIntendedUse = pIntendedUse );
        mLabels = (pLabels != null) ? pLabels : LabelUsage.EMPTY_ARRAY;
        mActions = (pActions != null) ? pActions : ActionUsage.EMPTY_ARRAY;
        mAttributes = (pAttributes != null) ? pAttributes : AttributeUsage.EMPTY_ARRAY;
        mRelSubForms = (pRelSubForms != null) ? pRelSubForms : EMPTY_ARRAY;
    }

    public Integer getUniqueID()
    {
        return mUniqueID;
    }

    public String getRelAttributeRef()
    {
        return mRelAttributeRef;
    }

    public boolean isHot()
    {
        return mHot;
    }

    public String getRootType()
    {
        return mRootType;
    }

    public IntendedUse getIntendedUse()
    {
        return mIntendedUse;
    }

    public LabelUsage[] getLabels()
    {
        return mLabels;
    }

    public ActionUsage[] getActions()
    {
        return mActions;
    }

    public AttributeUsage[] getAttributes()
    {
        return mAttributes;
    }

    public FormUsage[] getRelSubForms()
    {
        return mRelSubForms;
    }

    protected boolean anyChildren()
    {
        return (mLabels.length != 0) || (mActions.length != 0) || (mAttributes.length != 0) ||
               (mRelSubForms.length != 0);
    }

    public String toString()
    {
        return toStringBuilder( new StringBuilder().append( "FormUsage-" ), 0 ).toString();
    }
}