/*
 * Smart GWT (GWT for SmartClient)
 * Copyright 2008 and beyond, Isomorphic Software, Inc.
 *
 * Smart GWT is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License version 3
 * as published by the Free Software Foundation.  Smart GWT is also
 * available under typical commercial license terms - see
 * http://smartclient.com/license
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 */
/* sgwtgen */
 
package com.smartgwt.client.ai;


import com.smartgwt.client.event.*;
import com.smartgwt.client.core.*;
import com.smartgwt.client.types.*;
import com.smartgwt.client.data.*;
import com.smartgwt.client.data.Record;
import com.smartgwt.client.data.events.*;
import com.smartgwt.client.browser.window.*;
import com.smartgwt.client.rpc.*;
import com.smartgwt.client.ai.*;
import com.smartgwt.client.callbacks.*;
import com.smartgwt.client.tools.*;
import com.smartgwt.client.bean.*;
import com.smartgwt.client.widgets.*;
import com.smartgwt.client.widgets.ai.*;
import com.smartgwt.client.widgets.events.*;
import com.smartgwt.client.widgets.form.*;
import com.smartgwt.client.widgets.form.validator.*;
import com.smartgwt.client.widgets.form.fields.*;
import com.smartgwt.client.widgets.tile.*;
import com.smartgwt.client.widgets.tile.events.*;
import com.smartgwt.client.widgets.grid.*;
import com.smartgwt.client.widgets.grid.events.*;
import com.smartgwt.client.widgets.chart.*;
import com.smartgwt.client.widgets.layout.*;
import com.smartgwt.client.widgets.layout.events.*;
import com.smartgwt.client.widgets.menu.*;
import com.smartgwt.client.widgets.tour.*;
import com.smartgwt.client.widgets.notify.*;
import com.smartgwt.client.widgets.rte.*;
import com.smartgwt.client.widgets.rte.events.*;
import com.smartgwt.client.widgets.ace.*;
import com.smartgwt.client.widgets.ace.events.*;
import com.smartgwt.client.widgets.tab.*;
import com.smartgwt.client.widgets.toolbar.*;
import com.smartgwt.client.widgets.tree.*;
import com.smartgwt.client.widgets.tree.events.*;
import com.smartgwt.client.widgets.tableview.*;
import com.smartgwt.client.widgets.viewer.*;
import com.smartgwt.client.widgets.calendar.*;
import com.smartgwt.client.widgets.calendar.events.*;
import com.smartgwt.client.widgets.cube.*;
import com.smartgwt.client.widgets.notify.*;
import com.smartgwt.client.widgets.drawing.*;
import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;

import com.google.gwt.event.shared.*;
import com.google.gwt.dom.client.Element;
import com.google.gwt.user.client.ui.Widget;
import com.google.gwt.core.client.JavaScriptObject;

import com.smartgwt.client.util.*;
import com.smartgwt.client.util.events.*;
import com.smartgwt.client.util.workflow.*;
import com.smartgwt.client.util.workflow.Process; // required to override java.lang.Process
import com.smartgwt.client.util.tour.*;


/**
 * Descriptor for an AI service that can be registered with {@link com.smartgwt.client.ai.AI#registerAIService
 * AI.registerAIService()} (globally) or {@link com.smartgwt.client.widgets.Canvas#registerAIService
 * Canvas.registerAIService()} (component-scoped) so that the AIDelegator can choose to invoke it on behalf of the user.
 * <p> See the {@link com.smartgwt.client.docs.AiAssist AI Assist overview} for the full registration and routing model.
 * @see com.smartgwt.client.ai.AI#registerAIService
 * @see com.smartgwt.client.widgets.Canvas#registerAIService
 * @see com.smartgwt.client.ai.AI#delegate
 */
@BeanFactory.FrameworkClass
public class AIServiceDescriptor extends RefDataClass {

    public static AIServiceDescriptor getOrCreateRef(JavaScriptObject jsObj) {
        if (jsObj == null) return null;

        final RefDataClass existingObj = RefDataClass.getRef(jsObj);

        if (existingObj instanceof AIServiceDescriptor) {
            existingObj.setJsObj(jsObj);
            return (AIServiceDescriptor)existingObj;
        } else

        {
            return new AIServiceDescriptor(jsObj);
        }
    }
        


    public AIServiceDescriptor(){
        
    }

    public AIServiceDescriptor(JavaScriptObject jsObj){
        
        setJavaScriptObject(jsObj);
    }



    // ********************* Properties / Attributes ***********************

    /**
     * Natural-language description of what this service does, shown to the AI so it can decide whether this service is
     * appropriate for a given user request.  Should be a concise sentence or two.
     *
     * @param description New description value. Default value is null
     * @return {@link com.smartgwt.client.ai.AIServiceDescriptor AIServiceDescriptor} instance, for chaining setter calls
     */
    public AIServiceDescriptor setDescription(String description) {
        return (AIServiceDescriptor)setAttribute("description", description);
    }

    /**
     * Natural-language description of what this service does, shown to the AI so it can decide whether this service is
     * appropriate for a given user request.  Should be a concise sentence or two.
     *
     * @return Current description value. Default value is null
     */
    public String getDescription()  {
        return getAttributeAsString("description");
    }
    
    

    /**
     * Unique name for this service (e.g. "answerEngine", "buildUI", "legacyAssist"). Used as the key in the registry and as
     * the identifier the AI selects.
     *
     * @param name New name value. Default value is null
     * @return {@link com.smartgwt.client.ai.AIServiceDescriptor AIServiceDescriptor} instance, for chaining setter calls
     */
    public AIServiceDescriptor setName(String name) {
        return (AIServiceDescriptor)setAttribute("name", name);
    }

    /**
     * Unique name for this service (e.g. "answerEngine", "buildUI", "legacyAssist"). Used as the key in the registry and as
     * the identifier the AI selects.
     *
     * @return Current name value. Default value is null
     */
    public String getName()  {
        return getAttributeAsString("name");
    }
    

    // ********************* Methods ***********************

    // ********************* Static Methods ***********************

    // ***********************************************************

}
