Méthodes du service Web du centre des enregistrements

Windows SharePoint Services 3

Pour qu'un service Web agisse comme un service Web du centre des enregistrements pour Windows SharePoint Services, il doit implémenter les méthodes définies dans la description du service Web du centre des enregistrements. Cette description de service définit les méthodes suivantes :

  • SubmitFile

  • GetRecordRouting

  • GetRecordRoutingCollection

  • GetServerInfo

Actuellement, Windows SharePoint Services appelle uniquement la méthode SubmitFile.

Voici des descriptions de ces méthodes. Pour la description complète du service Web, voir Description du service Web du centre d'enregistrements.

Méthode SubmitFile

Soumet un fichier en tant que type de routage d'enregistrement spécifique, avec ses métadonnées et son historique d'audit.

Windows SharePoint Services appelle cette méthode lorsqu'un utilisateur envoie un fichier au centre des enregistrements, via l'interface utilisateur ou le modèle objet.

public string SubmitFile(
    byte []fileToSubmit, 
    RecordsRepositoryProperty []properties, 
    string recordRouting, 
    string sourceUrl, 
    string userLoginName)

Paramètres

fileToSubmit

Le fichier soumis.

properties

Les métadonnées soumises avec le fichier. Chaque objet RecordsRepositoryProperty a les champs de type chaîne publics suivants :

  • Name   Nom de la propriété de métadonnées.

  • Other   Toute information supplémentaire à envoyer avec la propriété.

  • Type   Type de données de la propriété, si elle correspond au type de données d'un champ Windows SharePoint Services.

  • Value   Valeur de la propriété de métadonnées.

Si vous le souhaitez, vous pouvez inclure du code XML qui représente l'historique d'audit du fichier envoyé. Pour ce faire, incluez une propriété nommée Audit History, avec une propriété Type du code XML. Stockez l'historique réel d'audit en tant que code XML dans la propriété Other.

Windows SharePoint Services inclut automatiquement l'historique d'audit lorsqu'il appelle la méthode SubmitFile lorsqu'un utilisateur envoie un fichier au centre des enregistrements, vie l'interface utilisateur ou le modèle objet.

recordSeries

Type de routage d'enregistrement du fichier.

sourceUrl

URL d'origine du fichier envoyé.

userLoginName

Nom d'ouverture de session de l'utilisateur qui envoie le fichier.

Type de retour

Cette méthode doit retourner une chaîne qui représente le résultat de l'appel de méthode, dans le format suivant :

<ResultCode>Success</ResultCode>

Les valeurs de code de résultat incluent :

  • Success

  • MoreInformation

  • InvalidConfiguration

  • InvalidArgument

  • InvalidUser

  • NotFound

  • FileRejected

  • UnknownError

Si des propriétés requises sont manquantes dans le fichier, la méthode SubmitFile peut retourner une demande pour plus d'informations, à l'aide du code de résultat MoreInformation :

<ResultCode>MoreInformation</ResultCode>
<ResultUrl>
http://servername/officialsitename/MissingProperties/Forms/EditForm.aspx?ID=SomeGUID
</ResultUrl>

où l'élément ResultUrl représente le chemin d'accès au formulaire de modification de l'élément, où l'utilisateur peut entrer les propriétés manquantes pour l'élément.

Si le fichier est téléchargé avec succès, la méthode SubmitFile retourne un code de résultat Success.

Méthode GetRecordRoutingCollection

Retourne les propriétés de tous les types de routage d'enregistrements pour un centre des enregistrements, ainsi que le schéma de métadonnées pour chacun des types.

Actuellement, Windows SharePoint Services n'appelle pas cette méthode.

public string GetRecordRoutingCollection()

Type de retour

Cette méthode retourne une chaîne représentant un document XML qui contient les informations de définition pour chaque type de routage d'enregistrement :

  • Name

  • Description

  • Aliases

Dans le cas d'une exception, cette méthode peut retourner à la place une chaîne représentant un message d'exception.

Méthode GetRecordRouting

Retourne le nom, la description et les alias d'un type de routage d'enregistrement donné.

Actuellement, Windows SharePoint Services n'appelle pas cette méthode.

public string GetRecordRouting(string recordRouting)

Paramètres

recordSeries

Type de routage d'enregistrement pour lequel vous souhaitez obtenir des informations.

Type de retour

Cette méthode retourne une chaîne représentant un document XML qui contient les informations de définition pour le type de routage d'enregistrement spécifié :

  • Name

  • Description

  • Aliases

Par exemple :

<RecordRouting>
   <Name>value</Name>
   <Description>value</Description>
   <Default>value</Default>
   <Mappings>
      <Mapping>value</Mapping>
   </Mappings>
</RecordRouting>

Chaque élément Mapping définit un alias pour le type de routage d'enregistrement.

Dans le cas d'une exception, cette méthode peut retourner à la place une chaîne représentant un message d'exception.

Méthode GetServerInfo

Retourne des informations sur une implémentation du centre des enregistrements.

Actuellement, Windows SharePoint Services n'appelle pas cette méthode.

public string GetServerInfo()

Type de retour

Retourne une chaîne qui représente un fragment XML contenant des informations sur le serveur agissant en tant que centre des enregistrements pour cette application Web.

Dans le cas d'une exception, cette méthode peut retourner à la place une chaîne représentant un message d'exception.

Voir aussi

Afficher: