OKMBookmark

Se utiliza para gestionar los marcadores de los usuarios. Por ejemplo, añadir o eliminar el marcador de un nodo para un usuario. 

Conceptos básicos

En casi todos los métodos verá un parámetro llamado “nodeId”. El valor de este parámetro puede ser el UUID de un nodo válido (carpeta, documento, correo, registro) o la ruta del nodo.

Consejo

Ejemplo de nodeId:

• Usando el UUID -> “c41f9ea0-0d6c-45da-bae4-d72b66f42d0f”;
• Usando la ruta -> “/okm:root/sample.pdf”

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 “promocionarse como Administrador” utilizando el “token de administrador”.

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

Métodos

add

Descripción:

Método	Valores devueltos	Descripción
add(String token, String nodeId, String name)	Bookmark	Añade un nuevo marcador de un nodo.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMBookmark;
import com.openkm.dao.bean.Bookmark;

public class Test {
    public static void main(String[] args) {
        try {
            Bookmark bookmark = OKMBookmark.getInstance().add(null, "/okm:root/document.doc", "document.doc");
            System.out.println(bookmark);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

get

Descripción:

Método	Valores devueltos	Descripción
get(String token, int bmId)	Bookmark	Obtiene los datos del marcador.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMBookmark;
import com.openkm.dao.bean.Bookmark;

public class Test {
    public static void main(String[] args) {
        try {
            int bmId = 23;
            Bookmark bookmark = OKMBookmark.getInstance().get(null, bmId);
            System.out.println(bookmark);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAll

Descripción:

Método	Valores devueltos	Descripción
getAll(String token)	List	Obtiene todos los marcadores del usuario conectado.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMBookmark;
import com.openkm.dao.bean.Bookmark;

public class Test {
    public static void main(String[] args) {
        try {
            for (Bookmark bookmark : OKMBookmark.getInstance().getAll(null)) {
                System.out.println(bookmark);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

remove

Descripción:

Método	Valores devueltos	Descripción
remove(String token, int bmId)	void	Elimina un marcador.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMBookmark;

public class Test {
    public static void main(String[] args) {
        try {
            int bmId = 23;
            OKMBookmark.getInstance().remove(null, bmId);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

rename

Descripción:

Método	Valores devueltos	Descripción
rename(String token, int bmId, String newName	Bookmark	Renombra un marcador.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMBookmark;
import com.openkm.dao.bean.Bookmark;

public class Test {
    public static void main(String[] args) {
        try {
            int bmId = 23;
            Bookmark bookmark = OKMBookmark.getInstance().rename(null, bmId, "newname.doc");
            System.out.println(bookmark);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}