Record samples

En la mayoría de los métodos verá un parámetro llamado “recId”. El valor de este parámetro puede ser un UUID o una ruta (path) válidos de expediente.

Consejo

Ejemplo de recId:

• Usando UUID -> “a66664a3-0e1d-4b03-9049-a2f4732a0802”;
• Usando path -> “/okm:root/PKI-100200”

Métodos

createRecord

Descripción:

Método	Valores de retorno	Descripción
createRecord(Record record)	Record	Crea un nuevo expediente y devuelve como resultado un objeto Record.

La variable path del parámetro record debe inicializarse. Indica la ruta de la carpeta dentro de OpenKM.

Record record = new Record();
record.setPath("/okm:root/PKI-100200");

Precaución

Opcionalmente puede establecerse la variable title; el resto de variables del objeto Record (record) no tendrán ningún efecto en la creación del expediente.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Record;

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);

        try {
    Record record = new Record();
    record.setPath("/okm:root/PKI-100200");
    record.setTitle("some title");
    ws.createRecord(record);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRecordProperties

Descripción:

Método	Valores de retorno	Descripción
getRecordProperties(String recId)	Record	Devuelve las propiedades del expediente.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);

        try {
    System.out.println(ws.getRecordProperties("/okm:root/PKI-100200"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteRecord

Descripción:

Método	Valores de retorno	Descripción
deleteRecord(String recId)	void	Elimina un expediente.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);

        try {
    ws.deleteRecord("/okm:root/PKI-100200");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

purgeRecord

Descripción:

Método	Valores de retorno	Descripción
purgeRecord(String recId)	void	El expediente se elimina definitivamente del repositorio.

Normalmente los expedientes se purgan a /okm:trash/userId - la ubicación personal de la papelera del usuario -, pero es posible purgar directamente cualquier expediente desde cualquier punto del repositorio.

Precaución

Cuando se purga un expediente, solo puede restaurarse a partir de una copia de seguridad anterior del repositorio. La acción de purga elimina el expediente de forma permanente del repositorio.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);

        try {
    ws.purgeRecord("/okm:trash/okmAdmin/PKI-100200");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

renameRecord

Descripción:

Método	Valores de retorno	Descripción
renameRecord(String recId, String newName)	Record	Renombra un expediente.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);

        try {
    ws.renameRecord("/okm:root/PKI-100200", "new_name");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

moveRecord

Descripción:

Método	Valores de retorno	Descripción
moveRecord(String recId, String dstId)	void	Mueve un expediente a una carpeta o a otro expediente.

El valor del parámetro dstId debe ser un UUID o una ruta (path) de carpeta o de expediente.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);

        try {
    ws.moveRecord("/okm:root/PKI-100200", "/okm:root/tmp");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

copyRecord

Descripción:

Método	Valores de retorno	Descripción
copyRecord(String recId, String dstId, String newName)	void	Copia un expediente a una carpeta o a otro expediente.

El valor del parámetro dstId debe ser un UUID o una ruta (path) de carpeta o de expediente.

Cuando el valor del parámetro newName es null, el expediente conservará el mismo nombre.

Precaución

Solo se copian los permisos de seguridad al destino; los metadatos, palabras clave, etc. del expediente no se copian.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);

        try {
    ws.copyRecord("/okm:root/PKI-100200", "/okm:root/tmp", "new_name");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

isValidRecord

Descripción:

Método	Valores de retorno	Descripción
isValidRecord(String recId)	Boolean	Devuelve un booleano que indica si el nodo es un expediente.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);

        try {
    System.out.println("Is a record:" + ws.isValidRecord("/okm:root/PKI-100200"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRecordChildren

Descripción:

Método	Valores de retorno	Descripción
getRecordChildren(String fldId)	List	Devuelve una lista de todos los expedientes cuyo padre es fldId

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

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Record;

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);

        try {
    for (Record rec : ws.getRecordChildren("/okm:root/folder")) {
     System.out.println(rec);
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

lockRecord

Descripción:

Método	Valores de retorno	Descripción
lockRecord(String recId)	LockInfo	Bloquea un expediente y devuelve un objeto con la información del bloqueo.

Precaución

Solo el usuario que bloqueó el expediente puede desbloquearlo.

Un expediente bloqueado no puede ser modificado por otros usuarios.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);

        try {
    ws.lockRecord("/okm:root/PKI-100200");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

unlockRecord

Descripción:

Método	Valores de retorno	Descripción
unlockRecord(String recId)	void	Desbloquea un expediente bloqueado.

Precaución

Solo el usuario que bloqueó el documento puede desbloquearlo.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);

        try {
    ws.unlockRecord("/okm:root/PKI-100200");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

forceUnlockRecord

Descripción:

Método	Valores de retorno	Descripción
forceUnlockRecord(String recId)	void	Desbloquea un expediente bloqueado.

Este método permite desbloquear cualquier expediente bloqueado.

No es obligatorio que esta acción la ejecute el mismo usuario que ejecutó previamente la acción de bloqueo (checkout).

Precaución

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

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);

        try {
    ws.forceUnlockRecord("/okm:root/PKI-100200");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setRecordTitle

Descripción:

Método	Valores de retorno	Descripción
setRecordTitle(String recId, String title)	void	Establece el título de un expediente.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);

        try {
    ws.setRecordTitle("/okm:root/PKI-100200","some title");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRecordPath

Descripción:

Método	Valores de retorno	Descripción
getRecordPath(String uuid)	String	Convierte un UUID de expediente en una ruta de expediente.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;

public class Test {
    public static void main(String[] args) {
        String host = "http://localhost:8080/OpenKM";
        String username = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.newInstance(host, username, password);

        try {
    System.out.println(ws.getRecordPath("a66664a3-0e1d-4b03-9049-a2f4732a0802"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}