hw_api::checkin

(PHP 4, PHP 5 < 5.2.0, PECL hwapi SVN)

hw_api::checkinRegistra un objeto

Descripción

hw_api::checkin ( array $parameter ) : bool

Esta función registra un objeto o una jerarquía entera de objetos. El array de parámetros contiene el elemento obligatorio 'objectIdentifier' y los elementos opcionales 'version', 'comment', 'mode' y 'objectQuery'. 'version' especifica la versión del objeto. Consiste en la versión mayor y menor separada por un punto. Si la versión no está definida, se incrementa la menor versión. 'mode' puede ser uno de los siguientes valores:

HW_API_CHECKIN_NORMAL
Registra y consolida el objeto. El objeto debe ser un documento.
HW_API_CHECKIN_RECURSIVE
Si el objeto a registrar es una colección, todos los hijos serán registrados recursivamente si son documentos. Si se intenta registrar una colección devolverá un error.
HW_API_CHECKIN_FORCE_VERSION_CONTROL
Registra un objeto aunque no pase el control de versiones.
HW_API_CHECKIN_REVERT_IF_NOT_CHANGED
Valida si la versión nueva es diferente de la última versión. A menos que este sea el caso, el objeto será registrado.
HW_API_CHECKIN_KEEP_TIME_MODIFIED
Conserva la fecha de modificación del objeto más reciente.
HW_API_CHECKIN_NO_AUTO_COMMIT
El objeto no se consolida automáticamente (commit) en el momento de ser registrado.

Parámetros

parameter

Valores devueltos

Devuelve TRUE en caso de éxito o FALSE en caso de error.

Ver también

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top