OKMRecord

Conceptos básicos

En casi todos los métodos verá un parámetro llamado “recId”. El valor de este parámetro puede ser el UUID o la ruta de un registro válido.

Consejo

Ejemplo de recId:

• Usando UUID -> “c52f9ea0-0d6c-45da-bae4-d72b66f42da3”;
• Usando ruta -> “/okm:root/test”

Además, en todos los métodos verá un parámetro llamado “token”. Al acceder a la aplicación a través de SOAP, el proceso de inicio de sesión devuelve un token que se utiliza para identificar al usuario en todos los métodos expuestos. Desde el contexto de ejecución por defecto de la aplicación debe utilizar el valor “null”, que indica a la aplicación que debe utilizar la “sesión del usuario”.

Consejo

En casos especiales puede ser “promovido a Administrador” utilizando el “token de administrador”.

String systemToken = DbSessionManager.getInstance().getSystemToken();

Métodos

create

Descripción:

Método	Valores devueltos	Descripción
create(String token, Record rec)	Record	Crea un nuevo registro y devuelve como resultado un objeto Record.

Precaución

El resto de variables del registro ( rec ) no tendrán ningún efecto en la creación del registro.

Le sugerimos utilizar el método siguiente para crear el registro de forma simple en lugar de este.

• La variable path del parámetro rec debe estar inicializada. Indica la ruta de la carpeta en OpenKM.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRecord;
import com.openkm.bean.Record;

public class Test {
    public static void main(String[] args) {
        try {
            Record rec = new Record();
            rec.setPath("/okm:root/test");
            OKMRecord.getInstance().create(null, rec);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createSimple

Descripción:

Método	Valores devueltos	Descripción
createSimple(String token, String recPath)	Record	Crea un nuevo registro y devuelve como resultado un objeto Record.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRecord;

public class Test {
    public static void main(String[] args) {
        try {
            String recPath = "/okm:root/PKI-100200";
            OKMRecord.getInstance().createSimple(null, recPath);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getProperties

Descripción:

Método	Valores devueltos	Descripción
getProperties(String token, String recId)	Record	Devuelve las propiedades del registro.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRecord;
import com.openkm.bean.Record;

public class Test {
    public static void main(String[] args) {
        try {
            Record rec = OKMRecord.getInstance().getProperties(null, "/okm:root/PKI-100200");
            System.out.println(rec);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

delete

Descripción:

Método	Valores devueltos	Descripción
delete(String token, String recId)	void	Elimina un registro.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRecord;

public class Test {
    public static void main(String[] args) {
        try {
            OKMRecord.getInstance().delete(null, "/okm:root/PKI-100200");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

purge

Descripción:

Método	Valores devueltos	Descripción
purge(String token, String recId)	void	El registro se elimina definitivamente del repositorio.

Precaución

Cuando se purga un registro, solo podrá restaurarse desde una copia de seguridad previa del repositorio. La acción de purga elimina el registro definitivamente del repositorio.

• Normalmente purgará carpetas de /okm:trash/userId (las ubicaciones de la papelera personal del usuario), pero es posible purgar directamente cualquier registro de todo el repositorio.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRecord;

public class Test {
    public static void main(String[] args) {
        try {
            OKMRecord.getInstance().purge(null, "/okm:root/PKI-100200");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

rename

Descripción:

Método	Valores devueltos	Descripción
rename(String token, String recId, String newName)	Record	Renombra un registro.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRecord;

public class Test {
    public static void main(String[] args) {
        try {
            OKMRecord.getInstance().rename(null, "/okm:root/test", "newname");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

move

Descripción:

Método	Valores devueltos	Descripción
move(String token, String recId, String dstId)	void	Mueve un registro a una carpeta o a otro registro

• Los valores del parámetro dstId deben ser el UUID o la ruta de una carpeta o de un registro.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRecord;

public class Test {
    public static void main(String[] args) {
        try {
            OKMRecord.getInstance().move(null, "/okm:root/PKI-100200", "/okm:root/move/destination");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

copy

Descripción:

Método	Valores devueltos	Descripción
copy(String token, String recId, String dstId)	void	Copia un registro en una carpeta o en otro registro.

Precaución

Solo se copian al destino los datos binarios y los permisos de seguridad; los metadatos, palabras clave, etc. del documento no se copian.

Consulte el método “extendedCopy” para esta funcionalidad.

• Los valores del parámetro dstId deben ser el UUID o la ruta de una carpeta o de un registro.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRecord;

public class Test {
    public static void main(String[] args) {
        try {
            OKMRecord.getInstance().copy(null, "/okm:root/PKI-100200", "/okm:root/move/destination");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

copy

Descripción:

Método	Valores devueltos	Descripción
copy(String token, String recId, String dstId, String newName)	void	Copia un registro en una carpeta o en otro registro.

Precaución

Solo se copian al destino los datos binarios y los permisos de seguridad; los metadatos, palabras clave, etc. del documento no se copian.

Consulte el método “extendedCopy” para esta funcionalidad.

• Los valores del parámetro dstId deben ser el UUID o la ruta de una carpeta o de un registro.
• Cuando el valor del parámetro newName es null, la carpeta conservará el mismo nombre.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRecord;

public class Test {
    public static void main(String[] args) {
        try {
            OKMRecord.getInstance().copy(null, "/okm:root/PKI-100200", "/okm:root/move/destination", "newname");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

extendedCopy

Descripción:

Método	Valores devueltos	Descripción
extendedCopy(String token, String recId, String dstId, String newName, ExtendedAttributes extAttr)	void	Copia un registro con sus datos asociados en una carpeta o en otro registro.

Nota

Por defecto solo se copian los datos binarios y los permisos de seguridad; los metadatos, palabras clave, etc. del documento no se copian.

Adicionalmente:

• Cuando el parámetro category es true, se copiarán los valores originales de las categorías.
• Cuando el parámetro keywords es true, se copiarán los valores originales de las palabras clave.
• Cuando el parámetro propertyGroups es true, se copiarán los valores originales de los grupos de metadatos.
• Cuando el parámetro notes es true, se copiará el valor original de las notas.
• Cuando el parámetro wiki es true, se copiará el valor original de la wiki.

• Los valores del parámetro dstId deben ser el UUID o la ruta de una carpeta o de un registro.
• Cuando el valor del parámetro newName es null, el registro conservará el mismo nombre.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRecord;
import com.openkm.bean.ExtendedAttributes;

public class Test {
    public static void main(String[] args) {
        try {
            ExtendedAttributes extAttr = new ExtendedAttributes();
            // copy keywords
            extAttr.setKeywords(true);
            OKMRecord.getInstance().extendedCopy(null, "/okm:root/records/rec-0012343", "/okm:root/temp", "rec-0012344", extAttr);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

isValid

Descripción:

Método	Valores devueltos	Descripción
isValid(String token, String recId)	boolean	Devuelve un booleano que indica si el nodo es un registro o no.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRecord;

public class Test {
    public static void main(String[] args) {
        try {
            boolean valid =  OKMRecord.getInstance().isValid(null, "/okm:root/PKI-100200");
            System.out.println(valid);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPath

Descripción:

Método	Valores devueltos	Descripción
getPath(String token, String recId)	String	Convierte el UUID de una carpeta en la ruta del registro.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRecord;

public class Test {
    public static void main(String[] args) {
        try {
            String path =  OKMRecord.getInstance().getPath(null, "/okm:root/PKI-100200");
            System.out.println(path);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChildren

Descripción:

Método	Valores devueltos	Descripción
getChildren(String token, String fldId)	List	Devuelve una lista de todos los registros cuyo padre es fldId.

• El parámetro fldId puede ser un nodo de carpeta o de registro.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRecord;
import com.openkm.bean.Record;

public class Test {
    public static void main(String[] args) {
        try {
            for (Record rec : OKMRecord.getInstance().getChildren(null, "/okm:root/PKI-100200")) {
                System.out.println(rec);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

lock

Descripción:

Método	Valores devueltos	Descripción
lock(String token, String recId)	LockInfo	Bloquea un registro y devuelve un objeto con la información del bloqueo.

Precaución

Solo el usuario que bloqueó el registro puede desbloquearlo.

Un registro bloqueado no puede ser modificado por otros usuarios.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRecord;

public class Test {
    public static void main(String[] args) {
        try {
            OKMRecord.getInstance().lock(null, "/okm:root/PKI-100200");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

unlock

Descripción:

Método	Valores devueltos	Descripción
unlock(String token, String recId)	void	Desbloquea un registro bloqueado.

Precaución

Solo el usuario que bloqueó el registro puede desbloquearlo.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRecord;

public class Test {
    public static void main(String[] args) {
        try {
            OKMRecord.getInstance().unlock(null, "/okm:root/PKI-100200");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

forceUnlock

Descripción:

Método	Valores devueltos	Descripción
forceUnlock(String token, String recId)	void	Desbloquea un registro bloqueado.

Precaución

Esta acción solo puede realizarla un superusuario (usuario con ROLE_ADMIN).

• Este método permite desbloquear cualquier registro bloqueado.
• No es obligatorio que esta acción la ejecute el mismo usuario que ejecutó previamente la acción de bloqueo (checkout).

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRecord;

public class Test {
    public static void main(String[] args) {
        try {
            OKMRecord.getInstance().forceUnlock(null, "/okm:root/PKI-100200");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setTitle

Descripción:

Método	Valores devueltos	Descripción
setTitle(String token, String recId, String title)	void	Establece el título de un registro.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRecord;

public class Test {
    public static void main(String[] args) {
        try {
            OKMRecord.getInstance().setTitle(null, "/okm:root/PKI-100200", "title");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}