Vue d’ensemble du modèle objet de flux de travail dans SharePoint Foundation
Dernière modification : jeudi 15 avril 2010
S’applique à : SharePoint Foundation 2010
Après avoir déployé votre solution de flux de travail, vous pouvez utiliser le modèle objet Microsoft SharePoint Foundation pour interroger les processus de flux de travail et effectuer par programme des actions de flux de travail, en ajoutant par exemple un flux de travail à une liste ou en démarrant un flux de travail pour un élément.
Principaux objets Microsoft.SharePoint.Workflow
L'espace de noms Microsoft.SharePoint.Workflow représente les fonctionnalités de flux de travail contenues dans SharePoint Foundation.
L'objet SPWorkflowTemplateCollection représente les modèles de flux de travail actuellement déployés sur un site. Chaque objet SPWorkflowTemplate représente un modèle de flux de travail et contient des propriétés que vous pouvez utiliser pour obtenir ou définir des informations sur le modèle, telles que les données d'instanciation et d'historique et les listes de tâches pour le modèle.
Pour associer un flux de travail à une liste ou une bibliothèque de documents, utilisez la méthode AddWorkflowAssociation de l'objet SPList. Pour associer un flux de travail à un type de contenu, utilisez la méthode AddWorkflowAssociation de l'objet SPContentType. Chacune de ces méthodes prend un type de contenu SPWorkflowAssociation et l'ajoute à la liste ou au type de contenu spécifié. Pour créer l'association de flux de travail appropriée, utilisez la méthode CreateListAssociation, CreateListContentTypeAssociation ou CreateSiteContentTypeAssociation de l'objet SPWorkflowAssociation lui-même.
Tout comme pour l'ajout d'un flux de travail dans l'interface utilisateur, l'association d'un flux de travail par programme entraîne l'ajout d'une colonne d'état pour le flux de travail dans la liste.
Utilisez la méthode RemoveWorkflowAssociation pour supprimer une association de flux de travail dans une liste, ainsi que la méthode RemoveWorkflowAssociation pour supprimer une association de flux de travail dans un type de contenu de site ou de liste.
Chaque objet SPWorkflowAssociation représente un modèle de flux de travail associé à un type de liste ou de contenu spécifique, qui contient les propriétés renvoyant des informations personnalisées sur cette association de flux de travail, ainsi que sur le type de liste ou de contenu spécifique. Ces informations indiquent si le flux de travail est activé et s'il peut être démarré automatiquement ; par ailleurs, ces informations indiquent également quel est le type de liste ou de contenu auquel le flux de travail est associé.
SPWorkflowCollection représente les instances de flux de travail qui se sont exécutées ou sont en cours d’exécution pour un élément de liste spécifié. Chaque objet SPWorkflow contient des propriétés qui renvoient des informations sur l’instance de flux de travail, par exemple l’état d’achèvement du flux de travail, son état interne et son historique. En outre, chaque flux de travail contient une collection des tâches du flux de travail, SPWorkflowTaskCollection.
Utilisez la propriété Workflows pour renvoyer un objet SPWorkflowCollection représentant les flux de travail en cours d'exécution pour cet élément de liste.
Gestion par programme des instances de flux de travail en cours d'exécution
Les utilisateurs interagissent avec les flux de travail qui s'exécutent de manière individuelle sur des éléments, via l'interface utilisateur de SharePoint Foundation. Toutefois, SharePoint Foundation vous apporte des fonctionnalités qui vous permettent de contrôler de manière centrale les instances de flux de travail en cours d'exécution dans l'ensemble de votre collection de sites via le modèle objet. Utilisez l'objet SPWorkflowManager pour gérer les instances de flux de travail en cours d'exécution dans l'ensemble d'une collection de sites. L'objet SPWorkflowManager n'a pas d'équivalent dans l'interface utilisateur. Utilisez l'objet SPWorkflowManager pour effectuer les actions suivantes :
démarrer, exécuter ou annuler des flux de travail ;
renvoyer tous les flux de travail en cours d'exécution pour un élément spécifique ;
effectuer d'autres opérations d'administration de flux de travail.
Pour démarrer manuellement un flux de travail spécifique pour un élément, c’est-à-dire un flux de travail non configuré pour démarrer automatiquement, utilisez la méthode StartWorkflow(SPListItem, SPWorkflowAssociation, String) ou StartWorkflow(SPListItem, SPWorkflowAssociation, String, Boolean).