$lock

Bloqueia e desbloqueia uma entidade utilizando o mecanismo pessimista.

Sintaxe

Para bloquear uma entidade para outras sessões e processos 4D:

/?$lock=true

Para desbloquear a entidade para outras sessões e processos 4D:

/?$lock=false

A propriedade lockKindText é "Locked by session".

Descrição

Os bloqueios accionados pela API REST são colocados ao nível da sessão.

Uma entidade bloqueada é vista como bloqueada (ou seja, as acções de bloquear/desbloquear/atualizar/eliminar não são possíveis) por:

• outras sessões REST
• Processos 4D (cliente/servidor, datastore remoto, autónomo) em execução no servidor REST.

Uma entidade bloqueada pela API REST só pode ser desbloqueada:

• pelo seu locker, ou seja, um /?$lock=false na sessão REST que define /?$lock=true
• ou se o tempo limite de inatividade da sessão for atingido (a sessão é encerrada).

Resposta

Um pedido ?$lock devolve um objeto JSON com "result"=true se a operação de bloqueio for bem sucedida e "result"=false se falhar.

O objeto "__STATUS" devolvido tem as seguintes propriedades:

| Propriedade | | Tipo | Descrição | | ------------ | | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | | | | Disponível apenas em caso de sucesso: | | success | | boolean | true se a ação de bloqueio for bem sucedida (ou se a entidade já estiver bloqueada na sessão atual), false caso contrário (não devolvido neste caso). | | | | | Disponível apenas em caso de erro: | | status | | number | Código de erro, ver abaixo | | statusText | | text | Descrição do erro, ver abaixo | | lockKind | | number | Código de bloqueio | | lockKindText | | text | "Bloqueado por sessão" se bloqueado por uma sessão REST, "Bloqueado por registo" se bloqueado por um processo 4D |

Os seguintes valores podem ser devolvidos nas propriedades status e statusText do objeto __STATUS em caso de erro:

status	statusText	Comentário
2	"Stamp has changed"	O valor de selo interno da entidade não corresponde a uma da entidade armazenada nos dados (bloqueio otimista).
3	"Already locked"	A entidade está fechada por uma fechadura pessimista.
4	"Other error"	Um erro grave é um erro de banco de dados de baixo nível (por exemplo, chave duplicada), um erro de hardware, etc.
5	"Entity does not exist anymore"	A entidade não existe mais nos dados.

Exemplo

Bloqueamos uma entidade num primeiro navegador:

GET /rest/Customers(1)/?$lock=true

Responsa:

{
    "result": true,
    "__STATUS": {
        "success": true
    }
}

Num segundo navegador (outra sessão), enviamos o mesmo pedido.

Responsa:

{
    "result":false,
    "__STATUS":{
        "status":3,
        "statusText":"Already Locked",
        "lockKind":7,
        "lockKindText":"Locked By Session",
    }
}