élément method

Modèle de contenu

method:==( help | parameters)

Attributs

  • @_operation (string)
  • @access (string)
  • @const (boolean)
  • @hidden (boolean)
  • @label (string)
  • @library (string)
  • @name (MNTOKEN)
  • @pkonly (boolean)
  • @static (boolean)

Parents

<methods> , <interface />

Enfants

  • <help>
  • <parameters>

Description

Cet élément permet de définir une méthode SOAP.

Usage et contexte d'utilisation

Les méthodes SOAP permettent des traitements applicatifs.

L'utilisation de l'attribut "@library" est nécessaire pour déclarer une nouvelle méthode (non native): l'espace de noms et le nom utilisés pour la bibliothèque sont indépendants de l'espace de noms et du nom du schéma dans lequel se trouve la déclaration.

Description des attributs

  • access (string): cet attribut définit un contrà´le d'accès sur l'utilisation de la méthode. Si cet attribut est absent, l'identification est obligatoire. Les valeurs disponibles sont 'anonymous', 'admin' et 'sql'.
  • const (boolean): si cet attribut est activé, les paramètres sont compris dans un élément XML qui définit la méthode.
  • label (string): libellé de la méthode.
  • library (string): méthode qui n'est pas native à l'application . Cet attribut prend la valeur de la bibliothèque de méthodes dans laquelle se trouve la définition de la méthode (nms:mabibliotheque.js).
  • name (MNTOKEN): nom unique de la méthode.
  • static (boolean): si cet attribut est activé, la méthode est considérée comme autonome, tous les paramètres doivent être indiqués à la méthode lors de son appel.

Exemples

Définition de la méthode d'usine "Subscribe" :

 
<method name="Subscribe" static="true">
      <help>Creation of update of a recipient's subscription to an information service</help>
      <parameters>
        <param desc="Name of the information service(s) (separated with commas)"
               name="serviceName" type="string"/>
        <param desc="Recipient to subscribe and possibly create" name="recipient"
               type="DOMElement"/>
        <param desc="Create the recipient if they don't exist" name="create" type="boolean"/>
      </parameters>     
    </method>

Sur cette page