APIs Avanteam

Tableau de description des objets disponibles dans l’application

Le tableau ci-dessous décrit de manière non exhaustive la liste des objets accessibles suivant le contexte de paramétrage.

Contexte dans l’application	Objets disponibles
Paramétrage c# d’un champ de formulaire	Nom : docClasse : _IApsDocument castable en DocumentDocHelper  _
Possibilité de créer un objet de type DirectoryManagerWrapper.
Paramétrage d’une action sur une transition de workflow	Nom : documentClasse : IApsDocument castable en DocumentDocHelper
Nom : instanceClasse : Instance
Paramétrage d’une condition sur une transition de workflow	Nom : dataSourceClasse : ApplicationDataSource
Nom : instanceClasse : Instance
Paramétrage d’un héritage de champs (création sous process)	Nom : targetDocument, sourceDocumentClasse : DocumentDocHelper
Création d’un acteur ou d’une action auto (les objets sont récupérés d’une HashTable passée en paramètre)	Nom : dataSourceClasse : ApplicationDataSource
Nom : instanceClasse : Instance
Possibilité de créer un objet de type DirectoryManagerWrapper.

Liste des classes

Voici ci-dessous une description des classes les fréquemment utiles lors de paramétrage avancé sur l’application.

Avanteam.Documents.DocumentDocHelper

Fonctions membres publiques

bool	SaveDocument ()
object	GetValues (string fieldName)
void	SetValues (string fieldName, object values)
StringPair[]	GetReaders (int userType)
StringPair[]	GetAuthors (int userType)
void	SetReaders (StringPair[] users)
void	SetAuthors (StringPair[] users)
string	GetStringValue (string fieldName)
_ _	_Get the value of a field as a single sring. If the field is multi-valued, return the first value.  _
void	AppendValue (string fieldName, string value)
_ _	_Append a  _string _  value to a field. _
bool	HasField (string fieldName)
_ _	_Test if the current document contains this field.  _

Propriétés

string	IdDocument [get]
string	IdFormular [get]
_ _	_Wrapper to the id_formular column of the DataRow.  _

|

DocumentManagerWrapper | DocumentDataSource [get, set]

Interface Avanteam.Documents.Interface.IApsDocument

Cette interface est implémentée par DocumentDocHelper

Fonctions membres publiques

robject	GetValues (string fieldName)
void	SetValues (string fieldName, object values)
string	GetStringValue (string fieldName)
void	AppendValue (string fieldName, string value)
StringPair[]	GetReaders (int userType)
StringPair[]	GetAuthors (int userType)
void	SetReaders (StringPair[] users)
void	SetAuthors (StringPair[] users)

Propriétés

string	IdDocument [get]

Avanteam.Application.DataSource.ApplicationDataSource

Fonctions membres publiques

double	GetDocumentDoubleValue (string fieldName)
double	GetDocumentDoubleValue (string fieldName, double defaultValue)
double	GetDocumentNumValue (string fieldName)
double	GetDocumentNumValue (string fieldName, double defaultValue)
int	GetDocumentIntValue (string fieldName)
int	GetDocumentIntValue (string fieldName, int defaultValue)
string	GetDocumentStringValue (string fieldName)
string	GetDocumentStringValue (string fieldName, string defaultValue)
_ _	_Load the history of an activity (last execution).  _
_ _	_Return the picture of a process (as a Byte[]) or null.  _
List< string >	GetReaders (string idDocument)
List< string >	GetAuthors (string idDocument)

Propriétés

string	CurrentIdDocument [get, set]
Documents.DocumentDocHelper	Document [get, set]
UserDataSource	User [get]
string	UserName [get, set]
string	UserLanguage [get]
Documents.DataSource.DocumentManagerWrapper	DocumentsDataSource [get, set]
DirectoryManagerWrapper	DirectoryDataSource [get, set]

Avanteam.Documents.DataSource.DocumentManagerWrapper

Fonctions membres publiques

bool	DeleteDocument (string idDocument)
DocumentDocHelper	CreateDocument (string idFormular, string idDocument)
DocumentDocHelper	GetDocument (string id)
bool	SaveDocument (DocumentDocHelper doc)
List< string >	GetReaders (string idDocument)
List< string >	GetAuthors (string idDocument)
object	SQL_ExecuteScalar (string query, params KeyPair[] args)
_ _	_Execute a Scalar query with args.  _
List< object >	SQL_ExecuteScalarColection (string query, params KeyPair[] args)
_ _	_Execute a Scalar collection query with args.  _
int	SQL_ExecuteNonQuery (string query, params KeyPair[] args)
_ _	_Execute a non query with args.  _
DataTable	SQL_ExecuteSelect (string query, params KeyPair[] args)
_ _	_Execute a Select Query return result in a DataTable.  _

Avanteam.Directory.DataSource.DirectoryManagerWrapper

Fonctions membres publiques

string[]	GetPersonsInRole (string roleName)
_ _	_Get an Array of all persons having this role.  _
_ _	_Get a  _Resource _ (retrieve it by this key / value). _
bool	IsUserInRole (string user, string role)
_ _	_Get a boolean that indicates if the user has the specified role.  _
_ _	_Default Constructor : use the provider & connection _string _  declared in App.config or Web.config. _
ICollection< string >	GetServiceLeaders (string service)
_ _	_Return a collection of Leaders for the required service (use the Manager relation).  _
ICollection< string >	GetPersonServices (string person)
_ _	_Return a collection of all services to witch a person belongs (use the Member relation).  _
List< string >	GetRolesForPerson (string userName)
List< string >	GetRoles ()
List< string >	GetServices ()
int	DeleteRelation (string relationName, string fromValue, string toValue)
_List < string > _	LoadRelationNodesBackward _ (string relationName, string toValue)_
_List < string > _	LoadRelationNodesForward _ (string relationName, string fromValue)_
int	InsertRelation (string relationName, string fromValue, string toValue)
string	GetUserEMail (string userName)
_ _	Get the email address of a user(any resource) userName is cn or dn.

Avanteam.Application.DataSource.UserDataSource

Propriétés

string	Name [get, set]

Avanteam.Application.Security.APSUser

Propriétés

string	FullName [get, set]
_ _	_Get Full name of the user (ie: CN=....).  _
string	DisplayName [get, set]
_ _	_Get the Display name of the user (ie: Name FirstName).  _
List< string >	Roles [get]
_ _	_Get the list of roles of this user.  _
_ _	_Get the list of groups of this user.  _
List< string >	Services [get]
_ _	_Get the list of services of this user.  _

Avanteam.Kernel.StringPair

Fonctions membres publiques

	StringPair ()
	StringPair (string first, string second)

Propriétés

string	First [get, set]
string	Second [get, set]

Avanteam.Process.Library.Runtime.ComponentModel.Runtime.Instance

Fonctions membres publiques

int	GetIntProperty (string propertyName, bool promote)
_ _	_Return the Int value of a property or 0 if the property does not exist. search in previous instances if promote is true.  _
object	GetProperty (string propertyName)
int	GetExecutorIntValue (string key)
int	GetRootExecutorIntValue (string key)
string	GetExecutorStringValue (string key)
string	GetRootExecutorStringValue (string key)
List< string >	GetExecutorStringListValues (string key)
List< string >	GetRootExecutorStringListValues (string key)
void	AddEvent (SubProcessEvent evt)

Propriétés

Instance	Parent [get, set]
Instance	Previous [get, set]
List< Instance >	Childs [get]
List< Instance >	Nexts [get]
Instance	NavigateRootParent [get]
Instance	FirstParent [get]
string	Id [get]
DateTime	StartDate [get]
DateTime	EndDate [get]
int	Index [get, set]
int	Counter [get, set]
ExecutorPropertyCollection	ExecutorProperties [get]
IRuntime	Runtime [get, set]
List< InstanceHistory >	History [get]
_ _	_Get/Set the Timer  _object _  for this instance. _

Avanteam.Process.Library.Runtime.ComponentModel.Runtime.ExecutorProperty

Fonctions membres publiques

	ExecutorProperty ()

Propriétés

string	Id [get, set]
string	Name [get, set]
object	Value [get, set]

Avanteam.Workflow.Runtime.ExecutorPropertyCollection

Fonctions membres publiques

---

bject | GetValue (string key)
bool | GetValueBool (string key, bool defaultValue)
int | GetValueInt (string key, int defaultValue)
string | GetValueString (string key, string defaultValue)
List< string > | GetValueListString (string key)
void | AddValueListString (string key, string value)

Avanteam.Workflow.Runtime.InstanceHistory

Propriétés

string	Id [get, set]
string	IdInstance [get, set]
string	IdRootInstance [get, set]
int	Idx [get, set]
string	Activity [get, set]
string	Action [get, set]
DateTime	Date [get, set]
string	Performer [get, set]
string	Comment [get, set]
string	Summary [get]