View Javadoc

    1   /***
    2    * @(#)ServiceEntry.java
    3    *
    4    * JFoxSOAF, Service-Oriented Application Framework
    5    *
    6    * Copyright(c) JFoxSOAF Team
    7    *
    8    * Licensed under the GNU LGPL, Version 2.1 (the "License");
    9    * you may not use this file except in compliance with the License.
    10   * You may obtain a copy of the License at
    11   *
    12   * http://www.gnu.org/copyleft/lesser.html
    13   *
    14   * Unless required by applicable law or agreed to in writing, software
    15   * distributed under the License is distributed on an "AS IS" BASIS,
    16   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    17   * See the License for the specific language governing permissions and
    18   * limitations under the License.
    19   *
    20   * For more information, please visit:
    21   * http://www.jfox.cn/confluence/display/JFoxSOAF/Home
    22   * http://www.huihoo.org/jfox/jfoxsoaf
    23   */
    24
    25  package org.huihoo.jfox.soaf.container;
    26
    27  import java.util.Enumeration;
    28
    29  import org.huihoo.jfox.soaf.schema.service.Parameter;
    30
    31  /***
    32   * <p>
    33   * The service entry is used to access a boundary service in the container.
    34   * </p>
    35   *
    36   * @author <a href="mailto:founder_chen@yahoo.com.cn">Peter Cheng </a>
    37   * @version $Revision: 1.7 $ $Date: 2005/05/22 06:46:49 $
    38   * @version Revision: 1.0
    39   */
    40
    41  public interface ServiceEntry {
    42
    43      /***
    44       * Method addParameter
    45       *
    46       * @param vParameter
    47       */
    48      public void addParameter(Parameter vParameter)
    49              throws IndexOutOfBoundsException;
    50
    51      /***
    52       * Method addParameter
    53       *
    54       * @param index
    55       * @param vParameter
    56       */
    57      public void addParameter(int index,
    58              org.huihoo.jfox.soaf.schema.service.Parameter vParameter)
    59              throws IndexOutOfBoundsException;
    60
    61      /***
    62       * Method enumerateParameter
    63       */
    64      public Enumeration enumerateParameter();
    65
    66      /***
    67       * Method getDescriptionReturns the value of field 'description'.
    68       *
    69       * @return the value of field 'description'.
    70       */
    71      public String getDescription();
    72
    73      /***
    74       * Method getIdReturns the value of field 'id'.
    75       *
    76       * @return the value of field 'id'.
    77       */
    78      public String getId();
    79
    80      /***
    81       * Method getImplementationReturns the value of field 'implementation'.
    82       *
    83       * @return the value of field 'implementation'.
    84       */
    85      public String getImplementation();
    86
    87      /***
    88       * Method getInterfaceReturns the value of field 'interface'.
    89       *
    90       * @return the value of field 'interface'.
    91       */
    92      public String getInterface();
    93
    94      /***
    95       * Method getManageableReturns the value of field 'manageable'.
    96       *
    97       * @return the value of field 'manageable'.
    98       */
    99      public String getManageable();
    100
    101     /***
    102      * Method getParameter
    103      *
    104      * @param index
    105      */
    106     public Parameter getParameter(int index) throws IndexOutOfBoundsException;
    107
    108     /***
    109      * Method getParameter
    110      */
    111     public Parameter[] getParameter();
    112
    113     /***
    114      * Method getParameterCount
    115      */
    116     public int getParameterCount();
    117
    118     /***
    119      * Method isValid
    120      */
    121     public boolean isValid();
    122
    123     /***
    124      * Method marshal
    125      *
    126      * @param out
    127      */
    128     public void marshal(java.io.Writer out)
    129             throws org.exolab.castor.xml.MarshalException,
    130             org.exolab.castor.xml.ValidationException;
    131
    132     /***
    133      * Method marshal
    134      *
    135      * @param handler
    136      */
    137     public void marshal(org.xml.sax.ContentHandler handler)
    138             throws java.io.IOException, org.exolab.castor.xml.MarshalException,
    139             org.exolab.castor.xml.ValidationException;
    140
    141     /***
    142      * Method removeAllParameter
    143      */
    144     public void removeAllParameter();
    145
    146     /***
    147      * Method removeParameter
    148      *
    149      * @param index
    150      */
    151     public Parameter removeParameter(int index);
    152
    153     /***
    154      * Method setDescriptionSets the value of field 'description'.
    155      *
    156      * @param description the value of field 'description'.
    157      */
    158     public void setDescription(String description);
    159
    160     /***
    161      * Method setIdSets the value of field 'id'.
    162      *
    163      * @param id the value of field 'id'.
    164      */
    165     public void setId(String id);
    166
    167     /***
    168      * Method setImplementationSets the value of field 'implementation'.
    169      *
    170      * @param implementation the value of field 'implementation'.
    171      */
    172     public void setImplementation(String implementation);
    173
    174     /***
    175      * Method setInterfaceSets the value of field 'interface'.
    176      *
    177      * @param _interface
    178      * @param interface the value of field 'interface'.
    179      */
    180     public void setInterface(String _interface);
    181
    182     /***
    183      * Method setManageableSets the value of field 'manageable'.
    184      *
    185      * @param manageable the value of field 'manageable'.
    186      */
    187     public void setManageable(String manageable);
    188
    189     /***
    190      * Method setParameter
    191      *
    192      * @param index
    193      * @param vParameter
    194      */
    195     public void setParameter(int index, Parameter vParameter)
    196             throws IndexOutOfBoundsException;
    197
    198     /***
    199      * Method setParameter
    200      *
    201      * @param parameterArray
    202      */
    203     public void setParameter(Parameter[] parameterArray);
    204
    205     /***
    206      * Method validate
    207      */
    208     public void validate() throws org.exolab.castor.xml.ValidationException;
    209
    210 }