// This Source Code is in the Public Domain per: http://unlicense.org
package org.litesoft.GWT.forms.client.rpc;

import org.litesoft.GWT.eventbus.client.eventpackages.*;
import org.litesoft.GWT.eventbus.client.nonpublic.*;
import org.litesoft.GWT.eventbus.client.rpc.*;
import org.litesoft.commonfoundation.base.*;
import org.litesoft.core.util.*;
import org.litesoft.ui.def.nonpublic.support.*;
import org.litesoft.ui.support.*;

import java.io.*;

/**
 * An image of all these events is available (as of 11/7/2007) on the vantos wiki as FormSystemEvents.
 * <p/>
 * Legend:
 * ----> to Server
 * <---- from Server
 * <p/>
 * ----> FormCreationRequestPackage
 * <---- FormCreationResponsePackage
 * ----> FormValuesRequestPackage
 * ----> FormComponentValueUpdatePackage
 * ----> FormActionRequestPackage
 * ----> FormDisposePackage
 * <---- ServicePeerToFormPackage
 * <---- TypedServicePeerXtraPackage
 */
public interface FormComponentBusConstants {
    public static final String FormServicePeerFactory = "FormServicePeerFactory";

    static final String sCommaSpace = ", ";

    public static class FormCreationRequestPackage extends NoXtraEventPackage {
        /**
         * @deprecated GWT ONLY
         */
        public FormCreationRequestPackage() {
        }

        private FormUsage mFormUsage;
        private Serializable mInitializationPayload;

        public FormCreationRequestPackage( String pSource, String pFormServicePeerFactoryName,
                                           FormUsage pFormUsage, Serializable pInitializationPayload ) {
            super( pSource, FormServicePeerFactory, pFormServicePeerFactoryName );
            Confirm.isNotNull( "FormUsage", mFormUsage = pFormUsage );
            mInitializationPayload = pInitializationPayload;
        }

        public FormUsage getFormUsage() {
            return mFormUsage;
        }

        public Serializable getInitializationPayload() {
            return mInitializationPayload;
        }

        protected void augmentToString( StringBuilder pSB ) {
            super.augmentToString( pSB );
            pSB.append( mInitializationPayload );
            LineIndentUtil.newLine( pSB, 1 ).append( "FormUsage-" );
            mFormUsage.toStringBuilder( pSB, 2 );
        }
    }

    public static class FormCreationResponsePackage extends SerializablePayloadWithExceptiontextEventPackage {
        public static final String EVENT_TYPE = "FormCreationResponsePackage";

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

        public FormCreationResponsePackage( String pSource, String pDest,
                                            ServicePeerToFormCreationData pFormCreationData ) {
            super( pSource, pDest, EVENT_TYPE, pFormCreationData );
        }

        public FormCreationResponsePackage( String pSource, String pDest, String pExceptionText ) {
            super( pSource, pDest, EVENT_TYPE, pExceptionText );
        }

        public ServicePeerToFormCreationData getFormCreationData() {
            return (ServicePeerToFormCreationData) getEventPayload();
        }
    }

    public static class FormResourceResponsePackage
            extends PayloadEventPackage<AttributeResourceOptionsResponseData>
            implements ChannelEventPackage {
        public static final String EVENT_TYPE = "FormResourceResponsePackage";

        private AttributeResourceOptionsRequestData mRequest;

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

        public FormResourceResponsePackage( String pSource, String pDest,
                                            AttributeResourceOptionsRequestData pRequest,
                                            AttributeResourceOptionsResponseData pResponse ) {
            super( pSource, pDest, EVENT_TYPE, pResponse );
            Confirm.isNotNull( "Request", mRequest = pRequest );
            Confirm.isNotNull( "Response", pResponse );
        }

        public AttributeResourceOptionsRequestData getRequest() {
            return mRequest;
        }

        public AttributeResourceOptionsResponseData getResponse() {
            return getEventPayload();
        }
    }

    public static class FormResourceRequestPackage
            extends PayloadEventPackage<AttributeResourceOptionsRequestData>
            implements ChannelEventPackage {
        /**
         * @deprecated GWT ONLY
         */
        public FormResourceRequestPackage() {
        }

        public FormResourceRequestPackage( String pSource, String pDest,
                                           AttributeResourceOptionsRequestData pRequest ) {
            super( pSource, pDest, null, pRequest );
            Confirm.isNotNull( "Request", pRequest );
        }

        public AttributeResourceOptionsRequestData getRequest() {
            return getEventPayload();
        }
    }

    public static class FormValuesRequestPackage extends StringPayloadEventPackage {
        private Integer mAsyncMessageNumber;

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

        public FormValuesRequestPackage( String pSource, String pDest, Integer pAsyncMessageNumber,
                                         String pRootTypeKeyOrNullForNew ) {
            super( pSource, pDest, null, pRootTypeKeyOrNullForNew );
            mAsyncMessageNumber = pAsyncMessageNumber;
        }

        public Integer getAsyncMessageNumber() {
            return mAsyncMessageNumber;
        }

        public String getKey() {
            return getEventPayload();
        }
    }

    public static class FormDisposePackage extends NoXtraEventPackage {
        /**
         * @deprecated GWT ONLY
         */
        public FormDisposePackage() {
        }

        public FormDisposePackage( String pSource, String pDest ) {
            super( pSource, pDest, null );
        }
    }

    public static class FormToServicePeerPackage extends SerializablePayloadEventPackage {
        /**
         * @deprecated GWT ONLY
         */
        public FormToServicePeerPackage() {
        }

        public FormToServicePeerPackage( String pSource, String pDest,
                                         FormToServicePeerData pToServicePeerData ) {
            super( pSource, pDest, null, pToServicePeerData );
            Confirm.isNotNull( "ToServicePeerData", pToServicePeerData );
        }

        public FormToServicePeerData getToServicePeerData() {
            return (FormToServicePeerData) getEventPayload();
        }
    }

    public static class ServicePeerToFormPackage extends SerializablePayloadWithExceptiontextEventPackage {
        public static final String RESPONSE_FROM_REQUEST_VALUES = "ResponseFromRequestValues";
        public static final String UNSOLICITED_DATA = "UnsolicitedData";

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

        private ServicePeerToFormPackage( String pSource, String pDest, String pType,
                                          ServicePeerToFormData pToFormData ) {
            super( pSource, pDest, pType, pToFormData );
        }

        private ServicePeerToFormPackage( String pSource, String pDest, String pType, String pExceptionText ) {
            super( pSource, pDest, pType, pExceptionText );
        }

        public static ServicePeerToFormPackage responseFromRequestValues( String pSource, String pDest,
                                                                          ServicePeerToFormData pToFormData ) {
            return new ServicePeerToFormPackage( pSource, pDest, RESPONSE_FROM_REQUEST_VALUES, pToFormData );
        }

        public static ServicePeerToFormPackage responseFromRequestValues( String pSource, String pDest,
                                                                          String pExceptionText ) {
            return new ServicePeerToFormPackage( pSource, pDest, RESPONSE_FROM_REQUEST_VALUES,
                                                 pExceptionText );
        }

        public static ServicePeerToFormPackage unsolicitedData( String pSource, String pDest,
                                                                ServicePeerToFormData pToFormData ) {
            return new ServicePeerToFormPackage( pSource, pDest, UNSOLICITED_DATA, pToFormData );
        }

        public static ServicePeerToFormPackage unsolicitedData( String pSource, String pDest,
                                                                String pExceptionText ) {
            return new ServicePeerToFormPackage( pSource, pDest, UNSOLICITED_DATA, pExceptionText );
        }

        public ServicePeerToFormData getToFormData() {
            return (ServicePeerToFormData) getEventPayload();
        }
    }
}