Record samples

Aspectos básicos

Consejo

Ejemplo de UUID:

• Usando UUID -> “a66664a3-0e1d-4b03-9049-a2f4732a0802”;

Ejemplo de código sugerido

Primero debe crear el objeto del servicio web:

OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

A continuación, debe iniciar sesión mediante el método “login”. Puede acceder al método “login” desde el objeto del servicio web “ws”, tal y como se muestra a continuación:

ws.login(user, password);

Precaución

Una vez que ha iniciado sesión en los servicios web, la sesión se mantiene en el objeto del servicio web. A partir de ahí puede usar el resto de métodos de la API.

Llegados a este punto puede usar todos los métodos de Record desde la clase “record”, tal y como se muestra a continuación:

ws.record.create("ada67d44-b081-4b23-bdc1-74181cafbc5d", "PKI-100200", "new title", 0)

Métodos

create

Descripción:

Método	Valores de retorno	Descripción
create(String uuid, String name, String title, long nodeClass)	Record	Crea un nuevo expediente y devuelve un objeto Record.

El parámetro uuid debe ser un UUID válido de carpeta o expediente.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            Record record = ws.record.create("ada67d44-b081-4b23-bdc1-74181cafbc5d", "PKI-100200", "new title", 0);
            System.out.println(record);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getProperties

Descripción:

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

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            System.out.println(ws.record.getProperties("fbe2933e-b141-4557-ab7a-736820ecdb2e"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

delete

Descripción:

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

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.record.delete("fbe2933e-b141-4557-ab7a-736820ecdb2e");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

purge

Descripción:

Método	Valores de retorno	Descripción
purge(String uuid)	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.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.record.purge("fbe2933e-b141-4557-ab7a-736820ecdb2e");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

rename

Descripción:

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

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.record.rename("5489fc37-3eb7-43de-998c-319725ae0ca0", "new_name");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

move

Descripción:

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

El valor del parámetro dstId debe ser un UUID de carpeta o de expediente.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.record.move("5489fc37-3eb7-43de-998c-319725ae0ca0", "8599eab7-ae61-4628-8010-1103d6950c63");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

copy

Descripción:

Método	Valores de retorno	Descripción
copy(String uuid, 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 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.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.record.copy("5489fc37-3eb7-43de-998c-319725ae0ca0", "8599eab7-ae61-4628-8010-1103d6950c63", "PKI-100200");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

isValid

Descripción:

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

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            System.out.println("Is a record:" + ws.record.isValid("5489fc37-3eb7-43de-998c-319725ae0ca0"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChildren

Descripción:

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

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

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            for (Record rec : ws.record.getChildren("8599eab7-ae61-4628-8010-1103d6950c63")) {
                System.out.println(rec);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setTitle

Descripción:

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

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.record.setTitle("5489fc37-3eb7-43de-998c-319725ae0ca0", "some title");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPath

Descripción:

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

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            System.out.println(ws.record.getPath("5489fc37-3eb7-43de-998c-319725ae0ca0"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setNodeClass

Descripción:

Método	Valores de retorno	Descripción
setNodeClass(String uuid, long ncId)	void	Establece el NodeClass.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            long ncId = 2;
            ws.record.setNodeClass("7ce1b4a8-4ade-4dce-8d7d-4e99a6cd368b", ncId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setDispositionStage

Descripción:

Método	Valores de retorno	Descripción
setDispositionStage(String uuid, long stage)	void	Establece la etapa de disposición

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            long stage = 1;
            ws.record.setDispositionStage("7ce1b4a8-4ade-4dce-8d7d-4e99a6cd368b", stage);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setDescription

Descripción:

Método	Valores de retorno	Descripción
setDescription(String uuid, String description)	void	Establece una descripción.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.record.setDescription("7ce1b4a8-4ade-4dce-8d7d-4e99a6cd368b", "some description");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

extendedCopy

Descripción:

Método	Valores de retorno	Descripción
extendedCopy(String uuid, String dstId, String newName, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean security)	Record	Copia un expediente con los datos asociados en una carpeta o expediente.

El valor del parámetro dstId debe ser un UUID de carpeta o de expediente.

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

Nota

Por defecto solo se copian los datos binarios y los permisos de seguridad; los metadatos, palabras clave, etc. de la carpeta 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án los valores originales de las notas.
• Cuando el parámetro security es true, se copiará el valor original de la seguridad.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            Record record = ws.record.extendedCopy("ada67d44-b081-4b23-bdc1-74181cafbc5d", "8599eab7-ae61-4628-8010-1103d6950c63",
                    "new name record", true, true, true, true, true);
            System.out.println(record);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createWizard

Descripción:

Método	Valores de retorno	Descripción
createWizard(String uuid, String name, String title, long nodeClass)	WizardNode	Crea un nuevo expediente mediante un asistente.

El parámetro uuid debe ser cualquier UUID válido de carpeta o expediente.

Nota

El WizardNode contiene una lista de acciones pendientes que deben realizarse para completar el proceso de creación del expediente. Estas pueden ser:

• Añadir palabra clave
• Añadir categorías
• Añadir metadatos

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.WizardNode;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            WizardNode wn = ws.record.createWizard("1f323e88-64ee-4f57-91e2-9276f8c603f9", "PKI-100200", "new title", 0);
            System.out.print(wn);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createFromTemplate

Descripción:

Método	Valores de retorno	Descripción
createFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, Map<String, String> properties)	Record	Crea un nuevo expediente a partir de la plantilla y devuelve un objeto Record.

El parámetro uuid es el valor UUID del fichero de plantilla.

El valor de dstPath es la ruta de destino del expediente.

Cuando la plantilla usa grupos de metadatos para rellenar campos, entonces estos valores son obligatorios y deben establecerse en el parámetro properties.

Nota

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 notes es true, se copiarán los valores originales de las notas.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Record;
import com.openkm.sdk4j.impl.OKMWebservices;
import com.openkm.sdk4j.util.ISO8601;

import java.util.Calendar;
import java.util.HashMap;
import java.util.Map;

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);

            Map<String, String> properties = new HashMap<>();
            // okg:tpl
            properties.put("okp:tpl.name", "Some name");
            Calendar cal = Calendar.getInstance();
            // El valor debe convertirse a String compatible con ISO 8601
            properties.put("okp:tpl.bird_date", ISO8601.formatBasic(cal));
            properties.put("okp:tpl.language", "[ \"java\" ]");

            // Propiedad okg:technology
            properties.put("okp:technology.comment", "sdk name");
            Record record = ws.record.createFromTemplate("9a114b17-7e51-41e7-9d3a-dc7b77e37656", "/okm:root/sdk/recTemplate", true, true, true, properties);
            System.out.println(record);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createMissingRecords

Descripción:

Método	Valores de retorno	Descripción
createMissingRecords(String recPath)	String	Crea los expedientes faltantes.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

        try {
            ws.login(user, password);
            ws.record.createMissingRecords("/okm:root/missingrec1/missingrec2/missingrec3");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}