/*
    * Copyright 2001-2004 The Apache Software Foundation.
    * 
    * Licensed under the Apache License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    * 
    *      http://www.apache.org/licenses/LICENSE-2.0
    * 
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.apache.juddi.datatype.request;
  
  import org.apache.juddi.datatype.CategoryBag;
  import org.apache.juddi.datatype.IdentifierBag;
  import org.apache.juddi.datatype.KeyedReference;
  import org.apache.juddi.datatype.Name;
  import org.apache.juddi.datatype.RegistryObject;
  
  /***
   * "Used to locate one or more tModel information structures. Returns a
   *  tModelList structure."
   *
   * @author Steve Viens (sviens@apache.org)
   */
  public class FindTModel implements RegistryObject,Inquiry
  {
    String generic;
    Name name;
    IdentifierBag identifierBag;
    CategoryBag categoryBag;
    FindQualifiers findQualifiers;
    int maxRows;
  
    /***
     * Constructs a new empty find_tModel request.
     */
    public FindTModel()
    {
    }
  
    /***
     *
     * @param genericValue
     */
    public void setGeneric(String genericValue)
    {
      this.generic = genericValue;
    }
  
    /***
     *
     * @return String UDDI request's generic value.
     */
    public String getGeneric()
    {
      return this.generic;
    }
  
    /***
     * Sets the name argument of the search to the given name. This value is a partial
     * name. The tModelList return contains tModelInfo objects for tModels whose
     * name matches the value passed (leftmost match).
     *
     * @param newName The name argument of the search.
     */
    public void setName(String newName)
    {
      setName(new Name(newName));
    }
  
    /***
     * Sets the name argument of the search to the given name. This value is a partial
     * name. The tModelList return contains tModelInfo objects for tModels whose
     * name matches the value passed (leftmost match).
     *
     * @param newname The name argument of the search.
     */
    public void setName(Name newname)
    {
      name = newname;
    }
  
    /***
     * Returns the name argument of the search. Null is returned if the name
     * argument for this search has not been specified.
     *
     * @return The name argument of the search, or null if the argument has not been specified.
     */
    public Name getName()
    {
      return name;
    }
  
    /***
    * Returns the name argument of the search. Null is returned if the name
    * argument for this search has not been specified.
    *
    * @return The name argument of the search as a String, or null if the argument has not been specified.
    */
   public String getNameString()
   {
     if (this.name != null)
       return this.name.getValue();
     else
       return null;
   }
 
   /***
    * Adds a business identifier reference to the identifierBag argument of this search.
    *
    * @param ref The business identifer reference to add.
    */
   public void addIdentifier(KeyedReference ref)
   {
     // just return if the KeyedReference parameter is null (nothing to add)
     if (ref == null)
       return;
 
     // make sure the IdentifierBag has been initialized
     if (this.identifierBag == null)
       this.identifierBag = new IdentifierBag();
 
     this.identifierBag.addKeyedReference(ref);
   }
 
   /***
    * Sets this TModels IdentifierBag the the new TModelBag object passed in.
    *
    * @param bag The references to add.
    */
   public void setIdentifierBag(IdentifierBag bag)
   {
     this.identifierBag = bag;
   }
 
   /***
    * Returns the list of business identifier references as an enumeration. If the
    * identifierBag has not been specified, an empty list is returned.
    *
    * @return The list of business identifier references.
    */
   public IdentifierBag getIdentifierBag()
   {
     return this.identifierBag;
   }
 
   /***
    * Adds a category reference to the categoryBag argument of this search.
    *
    * @param ref The category reference to add.
    */
   public void addCategory(KeyedReference ref)
   {
     // just return if the KeyedReference parameter is null (nothing to add)
     if (ref == null)
       return;
 
     // make sure the CategoryBag has been initialized
     if (this.categoryBag == null)
       this.categoryBag = new CategoryBag();
 
     this.categoryBag.addKeyedReference(ref);
   }
 
   /***
    * Sets the CategoryBag
    *
    * @param bag The new CategoryBag
    */
   public void setCategoryBag(CategoryBag bag)
   {
     this.categoryBag = bag;
   }
 
   /***
    * Returns the CategoryBag
    *
    * @return The current CategoryBag value.
    */
   public CategoryBag getCategoryBag()
   {
     return categoryBag;
   }
 
   /***
    *
    */
   public int getMaxRows()
   {
     return maxRows;
   }
 
   /***
    *
    */
   public void setMaxRows(int maxRows)
   {
     this.maxRows = maxRows;
   }
 
   /***
    *
    */
   public void setMaxRows(String maxRows)
   {
     setMaxRows(Integer.parseInt(maxRows));
   }
 
   /***
    *
    */
   public void addFindQualifier(FindQualifier findQualifier)
   {
     if (this.findQualifiers == null)
       this.findQualifiers = new FindQualifiers();
     this.findQualifiers.addFindQualifier(findQualifier);
   }
 
   /***
    *
    */
   public void setFindQualifiers(FindQualifiers qualifiers)
   {
     this.findQualifiers = qualifiers;
   }
 
   /***
    *
    */
   public FindQualifiers getFindQualifiers()
   {
     return this.findQualifiers;
   }
 }