OKMRelation

Fundamentos

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

Consejo

Ejemplo de nodeId:

• Usando UUID -> “d168924d-e801-426d-a222-00124a1461bd”;

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

Consejo

En casos especiales, puede ser “promovido a Administrador” usando el “token de administrador”.

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

Métodos

getRelationTypes

Descripción:

Método	Valores devueltos	Descripción
getRelationTypes(String token, String type)	List	Recupera una lista de todas las relaciones definidas para un tipo.

Nota

Más información en Relation types.

• Tipos disponibles:

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRelation;
import com.openkm.bean.RelationType;
import com.openkm.db.bean.NodeRelationType;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRelation okmRelation = ContextWrapper.getContext().getBean(OKMRelation.class);
            for (RelationType rt : okmRelation.getRelationTypes(null, NodeRelationType.BIDIRECTIONAL)) {
                System.out.println(rt);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

add

Descripción:

Método	Valores devueltos	Descripción
add(String token, String nodeAId, String nodeBId, long relationType)	void	Establece una relación entre dos nodos.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRelation;
import com.openkm.bean.RelationType;
import com.openkm.db.bean.NodeRelationType;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRelation okmRelation = ContextWrapper.getContext().getBean(OKMRelation.class);
            for (RelationType rt : okmRelation.getRelationTypes(null, NodeRelationType.BIDIRECTIONAL)) {
                // looking for a relation named invoice
                if (rt.getTitle().equals("invoice")) {
                    okmRelation.add(null, "d168924d-e801-426d-a222-00124a1461bd", "1f8ee9b8-0357-447b-95d0-c7b0adf887ec", rt.getId());
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

delete

Descripción:

Método	Valores devueltos	Descripción
delete(String token, long relationId)	void	Elimina una relación.

Precaución

Una relación solo puede eliminarse cuando ningún nodo la usa; en caso contrario obtendrá un error.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRelation;
import com.openkm.bean.Relation;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRelation okmRelation = ContextWrapper.getContext().getBean(OKMRelation.class);
            for (Relation relation : okmRelation.getRelations(null, "d168924d-e801-426d-a222-00124a1461bd")) {
                if (relation.getRelationTitle().equals("invoice")) {
                    okmRelation.delete(null, relation.getId());
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRelations

Descripción:

Método	Valores devueltos	Descripción
getRelations(String token, String nodeId)	List	Recupera una lista de todas las relaciones de un nodo.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRelation;
import com.openkm.bean.Relation;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRelation okmRelation = ContextWrapper.getContext().getBean(OKMRelation.class);
            for (Relation relation : okmRelation.getRelations(null, "d168924d-e801-426d-a222-00124a1461bd")) {
                System.out.println(relation);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRelationGroups

Descripción:

Método	Valores devueltos	Descripción
getRelationGroups(String token, String nodeId)	List	Recupera una lista de todos los grupos de relación de un nodo.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRelation;
import com.openkm.bean.RelationGroup;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRelation okmRelation = ContextWrapper.getContext().getBean(OKMRelation.class);
            for (RelationGroup rg : okmRelation.getRelationGroups(null, "d168924d-e801-426d-a222-00124a1461bd")) {
                System.out.println(rg);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRelationGroups (paginado)

Descripción:

Método	Valores devueltos	Descripción
getRelationGroups(String token, long relationTypeId, String filter, int offset, int limit)	RelationGroupResultSet	Recupera una lista paginada de grupos de relación filtrada por tipo de relación.

• El parámetro relationTypeId es el ID del tipo de relación por el que filtrar.
• El parámetro filter es un filtro de texto opcional aplicado a los nombres de los grupos.
• Los parámetros offset y limit controlan la paginación.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRelation;
import com.openkm.bean.RelationGroupResultSet;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRelation okmRelation = ContextWrapper.getContext().getBean(OKMRelation.class);
            RelationGroupResultSet resultSet = okmRelation.getRelationGroups(null, 1, "", 0, 10);
            System.out.println(resultSet);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addGroup

Descripción:

Método	Valores devueltos	Descripción
addGroup(String token, String nodeId, String groupName, long type)	void	Añade un grupo de relación a un nodo.

Nota

Más información en Relation types.

• Solo tiene sentido aplicar el tipo de relación NodeRelationType.MANY_TO_MANY a un grupo de relación.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRelation;
import com.openkm.bean.RelationType;
import com.openkm.db.bean.NodeRelationType;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRelation okmRelation = ContextWrapper.getContext().getBean(OKMRelation.class);
            for (RelationType rt : okmRelation.getRelationTypes(null, NodeRelationType.MANY_TO_MANY)) {
                if (rt.getTitle().equals("staple")) {
                    okmRelation.addGroup(null, "d168924d-e801-426d-a222-00124a1461bd", "staple group", rt.getId());
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addNodeToGroup

Descripción:

Método	Valores devueltos	Descripción
addNodeToGroup(String token, String nodeId, long groupId)	void	Añade un nodo a un grupo de relación existente.

Nota

Más información en Relation types.

• Solo tiene sentido aplicar el tipo de relación NodeRelationType.MANY_TO_MANY a un grupo de relación.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRelation;
import com.openkm.bean.RelationGroup;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRelation okmRelation = ContextWrapper.getContext().getBean(OKMRelation.class);
            for (RelationGroup rg : okmRelation.getRelationGroups(null, "d168924d-e801-426d-a222-00124a1461bd")) {
                if (rg.getRelationTitle().equals("staple")) {
                    okmRelation.addNodeToGroup(null, "1f8ee9b8-0357-447b-95d0-c7b0adf887ec", rg.getId());
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteGroup

Descripción:

Método	Valores devueltos	Descripción
deleteGroup(String token, String nodeId, long groupId)	void	Elimina un nodo de un grupo de relación.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRelation;
import com.openkm.bean.RelationGroup;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRelation okmRelation = ContextWrapper.getContext().getBean(OKMRelation.class);
            for (RelationGroup rg : okmRelation.getRelationGroups(null, "8f101a85-88e7-4abe-8175-c5fea3e17d8b")) {
                if (rg.getName().equals("staple group")) {
                    okmRelation.deleteGroup(null, "46762f90-82c6-4886-8d21-ad3017dd78a7", rg.getId());
                }
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getGroup

Descripción:

Método	Valores devueltos	Descripción
getGroup(String token, long groupId)	RelationGroup	Busca un grupo de relación por ID.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMRelation;
import com.openkm.bean.RelationGroup;
import com.openkm.util.ContextWrapper;

public class Test {

    public static void main(String[] args) {
        try {
            OKMRelation okmRelation = ContextWrapper.getContext().getBean(OKMRelation.class);
            long groupId = 1;
            RelationGroup rg = okmRelation.getGroup(null, groupId);
            System.out.println(rg);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setGroupName

Descripción:

Método	Valores devueltos	Descripción
setGroupName(String token, long groupId, String groupName)	void	Cambia el nombre del grupo de relación.

Ejemplo:

package com.openkm;

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

public class Test {

    public static void main(String[] args) {
        try {
            OKMRelation okmRelation = ContextWrapper.getContext().getBean(OKMRelation.class);
            long groupId = 1;
            okmRelation.setGroupName(null, groupId, "new name");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}