Note samples

Aspectos básicos

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

Consejo

Ejemplo de nodeId:

• Usando UUID -> “f123a950-0329-4d62-8328-0ff500fd42db”;
• Usando path -> “/okm:root/logo.png”

Métodos

addNote

Descripción:

Método	Valores de retorno	Descripción
addNote(String nodeId, String text)	Note	Añade una nota a un nodo y devuelve un objeto Note.

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.addNote("/okm:root/logo.png", "the note text");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getNote

Descripción:

Método	Valores de retorno	Descripción
getNote(String noteId)	Note	Recupera la nota.

Nota

El noteId es un UUID.

El objeto Node tiene una variable llamada path; en ese caso, el path contiene un UUID.

Ejemplo:

package com.openkm;

import java.util.List;

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

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 {
    List<Note> notes = ws.listNotes("/okm:root/logo.png");
    if (notes.size() > 0) {
     System.out.println(ws.getNote(notes.get(0).getPath()));
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteNote

Descripción:

Método	Valores de retorno	Descripción
deleteNote(String noteId)	Note	Elimina una nota.

Nota

El noteId es un UUID.

El objeto Node tiene una variable llamada path; en ese caso, el path contiene un UUID.

Ejemplo:

package com.openkm;

import java.util.List;

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

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 {
    List<Note> notes = ws.listNotes("/okm:root/logo.png");
    if (notes.size() > 0) {
     ws.deleteNote(notes.get(0).getPath());
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setNote

Descripción:

Método	Valores de retorno	Descripción
setNote(String noteId, String text)	void	Cambia el texto de la nota.

Nota

El noteId es un UUID.

El objeto Node tiene una variable llamada path; en ese caso, el path contiene un UUID.

Ejemplo:

package com.openkm;

import java.util.List;

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

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 {
    List<Note> notes = ws.listNotes("/okm:root/logo.png");
    if (notes.size() > 0) {
     ws.setNote(notes.get(0).getPath(), "text modified");
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

listNotes

Descripción:

Método	Valores de retorno	Descripción
listNotes(String nodeId)	List	Recupera una lista con todas las notas de un nodo.

Ejemplo:

package com.openkm;

import java.util.List;

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

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 {
    List<Note> notes = ws.listNotes("/okm:root/logo.png");
    for (Note note : notes) {
     System.out.println(note);
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}