Relation 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

getRelationTypes

Descripción:

Método	Valores de retorno	Descripción
getRelationTypes(String type)	RelationTypeList	Obtiene una lista de todas las relaciones definidas para un tipo.

Tipos disponibles:

• RelationType.BIDIRECTIONAL
• RelationType.PARENT_CHILD
• RelationType.MANY_TO_MANY

Nota

Más información en Relation types.

Ejemplo:

package com.openkm;

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

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 {
    for (RelationType type : ws.getRelationTypes(RelationType.PARENT_CHILD).getList()) {
     System.out.println(type);
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addRelation

Descripción:

Método	Valores de retorno	Descripción
addRelation(String nodeAId, String nodeBId, long relTypeId)	void	Establece una relación entre dos nodos.

Los parámetros nodeAId y nodeBId deben ser un UUID o una ruta (path) válidos de documento, carpeta, correo o expediente.

Ejemplo:

package com.openkm;

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

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 {
    for (RelationType type : ws.getRelationTypes(RelationType.PARENT_CHILD).getList()) {
     // looking for a relation named invoice
     if (type.getTitleAToB().equals("invoice")) {
      ws.addRelation("/okm:root/invoice.pdf", "/okm:root/budget.pdf", type.getId());
     }
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteRelation

Descripción:

Método	Valores de retorno	Descripción
deleteRelation(long relationId)	void	Elimina una relación.

Precaución

Una relación solo puede eliminarse cuando ningún nodo la utiliza. En caso contrario, obtendrá un error.

Ejemplo:

package com.openkm;

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

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 {
    for (RelationType type : ws.getRelationTypes(RelationType.PARENT_CHILD).getList()) {
     // looking for a relation named invoice
     if (type.getTitle().equals("invoice")) {
      ws.deleteRelation(type.getId());
     }
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRelations

Descripción:

Método	Valores de retorno	Descripción
getRelations(String nodeId)	RelationList	Obtiene una lista de todas las relaciones de un nodo..

Ejemplo:

package com.openkm;

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

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 {
    for (Relation relation : ws.getRelations("/okm:root/invoice.pdf").getList()) {
     System.out.println(relation);
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRelationGroups

Descripción:

Método	Valores de retorno	Descripción
getRelationGroups(String nodeId)	RelationGroupList	Obtiene una lista de todos los grupos de relación de un nodo.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservices;
import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.Relation;
import com.openkm.sdk4j.bean.RelationGroup;

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 {
    for (RelationGroup rGroup : ws.getRelationGroups("/okm:root/invoice.pdf").getList()) {
     System.out.println(rGroup);
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addRelationGroup

Descripción:

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

Un grupo de relación solo tiene sentido para el tipo de relación RelationType.MANY_TO_MANY.

Nota

Más información en Relation types.

Ejemplo:

package com.openkm;

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

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 {
    for (RelationType type : ws.getRelationTypes(RelationType.MANY_TO_MANY).getList()) {
     if (type.getTitle().equals("staple")) {
      ws.addRelationGroup("/okm:root/invoice.pdf", "staple group", type.getId());
     }
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

addNodeToGroup

Descripción:

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

Un grupo de relación solo tiene sentido para el tipo de relación RelationType.MANY_TO_MANY.

Nota

Más información en Relation types.

Ejemplo:

package com.openkm;

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

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 {
    for (RelationGroup rGroup : ws.getRelationGroups("/okm:root/invoice.pdf").getList()) {
     if (rGroup.getName().equals("staple group")) {
      ws.addNodeToGroup("/okm:root/complaint.pdf", rGroup.getId());
     }
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

deleteRelationGroup

Descripción:

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

Ejemplo:

package com.openkm;

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

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 {
    for (RelationGroup rGroup : ws.getRelationGroups("/okm:root/invoice.pdf").getList()) {
     if (rGroup.getName().equals("staple group")) {
      ws.deleteRelationGroup("/okm:root/complaint.pdf", rGroup.getId());
     }
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findRelationGroup

Descripción:

Método	Valores de retorno	Descripción
findRelationGroup(long groupId)	RelationGroup	Busca un grupo de relación por su id.

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 {
    long groupId = 11;
    System.out.println(ws.findRelationGroup(groupId));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setRelationGroupName

Descripción:

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

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 {
    long groupId = 11;
    ws.setRelationGroupName(groupId, "new name");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}