LockManager API

Sommario
Nel presente articolo sono descritti i metodi web del Web Service LockManager.

Elenco metodi web
Per facilitare la ricerca di uno specifico metodo sono di seguito elencati i metodi web trattati nel proseguo dell'articolo:

• GetCompanyDBAndTableLocksList
• GetLockEntriesAtt
• GetLockInfo
• GetLocksList
• Init
• InitLock
• IsAlive
• IsCurrentLocked
• IsRecordLocked
• LockRecord
• UnlockAll
• UnlockAllContext
• UnlockAllForCompanyDBName
• UnlockAllForCompanyDBNameAndTable
• UnlockAllForCompanyDBNameAndTableAndUser
• UnlockAllForCompanyDBNameAndUser
• UnlockAllForCurrentConnection
• UnlockAllForUser
• UnlockCompanyDBNameAndTableAndLock
• UnlockRecord

GetCompanyDBAndTableLocksList
Il metodo GetCompanyDBAndTableLocksList consente di creare un file XML contenente l'elenco delle aziende e delle tabelle aventi dei lock. Il metodo crea il file LockLog.xml in <cartella installazione>/<nome prodotto>/Custom.

void GetCompanyDBAndTableLocksList()

GetLockEntriesAtt
Il metodo GetLockEntriesAtt ritorna l'elenco di tutti i lock del database. Il risultato del metodo è in formato DIME Attachment.

void GetLockEntriesAtt()

GetLockInfo
Il metodo GetLockInfo permette di ottenere le informazioni relative al blocco di uno specifico record.

bool GetLockInfo(
			string companyDBName, 
			string lockKey, 
			string tableName, 
			out string user, 
			out DateTime lockTime,
                        out string processName
		 )

Parametri input

Parametri output

Valore di ritorno
Valore booleano che se impostato a true indica che il metodo è stato completato con successo.
 

GetLocksList
Il metodo GetLocksList consente di creare un file XML contenente l'elenco dei record bloccati per una specifica tabella di una azienda. Il metodo crea il file LockLog.xml in <cartella installazione>/<nome prodotto>/Custom.

bool GetLocksList(string companyDBName, string tableName)

Parametri input

Valore di ritorno
Valore booleano che se impostato a true indica che il metodo è stato completato con successo.
 

Init
Il metodo Init consente di inizializzare il LockManager e sbloccare tutti i record bloccati di tutte le società collegate.

void Init(string authenticationToken)

 Parametri input

InitLock
Il metodo InitLock permette di inizializzare la gestione dei lock di una specifica azienda.

bool InitLock(string companyDBName, string authenticationToken)

Parametri input

Valore di ritorno
Valore booleano che indica se l'inizializzazione ha avuto successo.
 

IsAlive
Il metodo IsAlive controlla la risposta del LockManager Web Service.

bool IsAlive()

Valore di ritorno
Valore booleano che indica se il metodo è vivo e riceve la richiesta.

IsCurrentLocked
Il metodo IsCurrentLocked consente di sapere se uno specifico record è bloccato da un indirizzo diverso da quello passato.

bool IsCurrentLocked(
			string companyDBName, 
			string tableName, 
                        string lockKey,  
			string address
		     )

Parametri input

Valore di ritorno
Valore booleano che indica se il record è bloccato da un altro indirizzo.

IsRecordLocked
Il metodo IsRecordLocked permette di sapere se uno specifico record è bloccato.

bool IsRecordLocked(
			string companyDBName, 
			string tableName, 
                        string lockKey
		    )

Parametri input

Valore di ritorno
Valore booleano che indica se il record è bloccato.

LockRecord
Il metodo LockRecord consente di bloccare uno specifico record di una tabella.

bool LockRecord(
			string companyDBName,  
                        string authenticationToken, 
                        string userName,
			string tableName, 
                        string lockKey,  
			string address,  
                        string processName,
		 )

Parametri input

Valore di ritorno
Valore booleano che indica se il record è stato bloccato con successo.

UnlockAll
Il metodo UnlockAll permette di sbloccare tutti i record associati ad un indirizzo di una specifica tabella di un database aziendale.

bool UnlockAll(
			string companyDBName,
                        string authenticationToken,
			string tableName, 
                        string address
		)

Parametri input

Valore di ritorno
Valore booleano che indica se i record sono stati sbloccati con successo.

UnlockAllContext
Il metodo UnlockAllContext consente di sbloccare tutti i record associati ad un indirizzo di uno specifico database aziendale.

bool UnlockAllContext(
			string companyDBName,
                        string authenticationToken,
                        string address
		      )

Parametri input

Valore di ritorno
Valore booleano che indica se i record sono stati sbloccati con successo.

UnlockAllForCompanyDBName
Il metodo UnlockAllForCompanyDBName permette di sbloccare tutti i record di una specifica azienda.

bool UnlockAllForCompanyDBName(string companyDBName, string authenticationToken)

Parametri input

Valore di ritorno
Valore booleano che indica se i record sono stati sbloccati con successo.
 

UnlockAllForCompanyDBNameAndTable
Il metodo UnlockAllForCompanyDBNameAndTable consente di sbloccare tutti i record associati ad una tabella di un database aziendale.

bool UnlockAllForCompanyDBNameAndTable(
			                string companyDBName,
			                string tableName,
                                        string authenticationToken
		                       )

Parametri input

Valore di ritorno
Valore booleano che indica se i record sono stati sbloccati con successo.

UnlockAllForCompanyDBNameAndTableAndUser
Il metodo UnlockAllForCompanyDBNameAndTableAndUser permette di sbloccare tutti i record associati ad una tabella di un database aziendale e bloccati da un particolare utente.

bool UnlockAllForCompanyDBNameAndTableAndUser(
			                       string companyDBName, 
                                               string tableName, 
                                               string userName,  
                                               string authenticationToken
		                              )

Parametri input

Valore di ritorno
Valore booleano che indica se i record sono stati sbloccati con successo.

UnlockAllForCompanyDBNameAndUser
Il metodo UnlockAllForCompanyDBNameAndUser consente di sbloccare tutti i record associati ad uno specifico database aziendale e bloccati da un particolare utente.

bool UnlockAllForCompanyDBNameAndUser(
			               string companyDBName, 
                                       string userName,  
                                       string authenticationToken
		                     )

Parametri input

Valore di ritorno
Valore booleano che indica se i record sono stati sbloccati con successo.

UnlockAllForCurrentConnection
Il metodo UnlockAllForCurrentConnection permette di sbloccare i record di una specifica azienda associati alla connessione riconosciuta dal codice di autenticazione.

bool UnlockAllForCurrentConnection(string companyDBName, string authenticationToken)

Parametri input

Valore di ritorno
Valore booleano che indica se i record sono stati sbloccati con successo.
 

UnlockAllForUser
Il metodo UnlockAllForUser consente di sbloccare tutti i record associati ad uno specifico utente.

bool UnlockAllForUser(string userName, string authenticationToken)

Parametri input

Valore di ritorno
Valore booleano che indica se i record sono stati sbloccati con successo.

UnlockCompanyDBNameAndTableAndLock
Il metodo UnlockCompanyDBNameAndTableAndLock permette di sbloccare il record associato ad una tabella di un database aziendale e chiave primaria.

bool UnlockCompanyDBNameAndTableAndLock(
			                 string companyDBName, 
                                         string tableName, 
                                         string lockKey,  
                                         string authenticationToken
		                        )

Parametri input

Valore di ritorno
Valore booleano che indica se i record sono stati sbloccati con successo.

UnlockRecord
Il metodo UnlockRecord consente di sbloccare uno specifico record.

bool UnlockRecord(
			string companyDBName,  
                        string authenticationToken, 
			string tableName, 
                        string lockKey,  
			string address
		 )

Parametri input

Valore di ritorno
Valore booleano che indica se il record è stato sbloccato con successo.