OKMBookmark

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

Fundamentos

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

Además, en todos los métodos verá un parámetro llamado “token”. Como las tareas de Cron se ejecutan en segundo plano sin autenticación, los métodos usados en ese escenario pueden usar el parámetro token. En el contexto de ejecución por defecto de la aplicación, debe usarse el valor “null”, que indica que la aplicación debe usar la “sesión de usuario”.

Métodos

add

Descripción:

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMBookmark;
import com.openkm.db.bean.Bookmark;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMBookmark okmBookmark = ContextWrapper.getContext().getBean(OKMBookmark.class);
            Bookmark bookmark = okmBookmark.add(null, "3887ae75-dd67-4019-b4d1-2f6962815403", "document.doc");
            System.out.println(bookmark);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

get

Descripción:

Método	Valores de retorno	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.db.bean.Bookmark;
import com.openkm.util.ContextWrapper;

public class Test {

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

remove

Descripción:

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

Ejemplo:

package com.openkm;

import com.openkm.api.OKMBookmark;
import com.openkm.util.ContextWrapper;

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

rename

Descripción:

Método	Valores de retorno	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.db.bean.Bookmark;
import com.openkm.util.ContextWrapper;

public class Test {

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

getAll

Descripción:

Método	Valores de retorno	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.db.bean.Bookmark;
import com.openkm.util.ContextWrapper;

public class Test {

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