Ir al contenido
Otras versiones

Cargando…

Ejemplos de PropertyGroup

Conceptos básicos

Sección titulada «Conceptos básicos»

Ejemplo de código sugerido

Sección titulada «Ejemplo de código sugerido»

Primero, debes crear el objeto de servicio web:

OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

A continuación debes iniciar sesión usando el método “login”. Puedes acceder al método “login” desde el objeto de servicio web “ws” como se muestra a continuación:

ws.login(user, password);

Llegados a este punto puedes usar todos los métodos de Property Group desde la clase “propertyGroup” como se muestra a continuación:

ws.propertyGroup.addGroup("8cd1e072-8595-4dd3-b121-41d622c43f08", "okg:consulting", propertiesMap);

Métodos

Sección titulada «Métodos»

addGroup

Sección titulada «addGroup»

Descripción:

Método Valores de retorno Descripción
addGroup(String uuid, String grpName, Map<String, String> propertiesMap) void
Añade un grupo de metadatos vacío a un nodo.
  • grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

package com.openkm;


import java.util.Calendar;
import java.util.HashMap;
import java.util.Map;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;
import com.openkm.sdk4j.util.ISO8601;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            Map<String, String> properties = new HashMap<>();
            properties.put("okp:technology.type", "[ \"t1\", \"t2\" ]");
            Calendar cal = Calendar.getInstance();
            // Value must be converted to String ISO 8601 compliant
            properties.put("okp:technology.date", ISO8601.formatBasic(cal));
            properties.put("okp:technology.comment", "comment sample");
            properties.put("okp:technology.description", "description sample");
            properties.put("okp:technology.language", "[ \"java\" ]");
            properties.put("okp:technology.important", String.valueOf(true));
            ws.propertyGroup.addGroup("4a3b1c1b-c880-45a3-a6ff-2c8b7c5adfa5", "okg:technology", properties);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

removeGroup

Sección titulada «removeGroup»

Descripción:

Método Valores de retorno Descripción
removeGroup(String uuid, String grpName) void
Elimina un grupo de metadatos de un nodo.
  • grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            ws.propertyGroup.removeGroup("8cd1e072-8595-4dd3-b121-41d622c43f08", "okg:consulting");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getGroups

Sección titulada «getGroups»

Descripción:

Método Valores de retorno Descripción
getGroups(String uuid) List Obtiene una lista de los grupos de metadatos asignados a un nodo.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.PropertyGroup;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            for (PropertyGroup pGroup : ws.propertyGroup.getGroups("8cd1e072-8595-4dd3-b121-41d622c43f08")) {
                System.out.println(pGroup);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAllGroups

Sección titulada «getAllGroups»

Descripción:

Método Valores de retorno Descripción
getAllGroups() List Obtiene una lista de todos los grupos de metadatos definidos en la aplicación.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.PropertyGroup;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            for (PropertyGroup pGroup : ws.propertyGroup.getAllGroups()) {
                System.out.println(pGroup);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getAllGroups

Sección titulada «getAllGroups»

Descripción:

Método Valores de retorno Descripción
getAllGroups(String uuid) List Obtiene una lista de todos los grupos de metadatos definidos en la aplicación.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.PropertyGroup;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            for (PropertyGroup pGroup : ws.propertyGroup.getAllGroups("8cd1e072-8595-4dd3-b121-41d622c43f08")) {
                System.out.println(pGroup);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPropertyGroupForm

Sección titulada «getPropertyGroupForm»

Descripción:

Método Valores de retorno Descripción
getPropertyGroupForm(String grpName) List Obtiene una lista de todas las definiciones de elementos del grupo de metadatos.
  • grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.form.FormElement;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            for (FormElement fElement : ws.propertyGroup.getPropertyGroupForm("okg:consulting")) {
                System.out.println(fElement);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPropertyGroupFormDefinition

Sección titulada «getPropertyGroupFormDefinition»

Descripción:

Método Valores de retorno Descripción
getPropertyGroupFormDefinition(String grpName) List Obtiene una lista de todas las definiciones de elementos del grupo de metadatos.
  • grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.form.FormElement;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            for (FormElement fElement : ws.propertyGroup.getPropertyGroupFormDefinition("okg:consulting")) {
                System.out.println(fElement);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPropertyGroupFormDefinition

Sección titulada «getPropertyGroupFormDefinition»

Descripción:

Método Valores de retorno Descripción
getPropertyGroupFormDefinition(String grpName, String uuid) List Obtiene una lista de todas las definiciones de elementos del grupo de metadatos.
  • grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.form.FormElement;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            for (FormElement fElement : ws.propertyGroup.getPropertyGroupFormDefinition("okg:consulting", "8cd1e072-8595-4dd3-b121-41d622c43f08")) {
                System.out.println(fElement);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPropertyGroupForm

Sección titulada «getPropertyGroupForm»

Descripción:

Método Valores de retorno Descripción
getPropertyGroupForm(String uuid, String grpName) List Obtiene una lista de los valores de metadatos de un nodo.
  • grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.form.FormElement;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            for (FormElement fElement : ws.propertyGroup.getPropertyGroupForm("8cd1e072-8595-4dd3-b121-41d622c43f08","okg:consulting")) {
                System.out.println(fElement);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setProperties

Sección titulada «setProperties»

Descripción:

Método Valores de retorno Descripción
setProperties(String uuid, String grpName, Map<String, String> properties) void Cambia los valores del grupo de metadatos de un nodo.
  • grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

package com.openkm;


import java.util.Calendar;
import java.util.HashMap;
import java.util.Map;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;
import com.openkm.sdk4j.util.ISO8601;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            Map<String, String> properties = new HashMap<>();
            properties.put("okp:technology.type", "[ \"t1\", \"t2\" ]");
            Calendar cal = Calendar.getInstance();
            // Value must be converted to String ISO 8601 compliant
            properties.put("okp:technology.date", ISO8601.formatBasic(cal));
            properties.put("okp:technology.comment", "comment sample");
            properties.put("okp:technology.description", "description sample");
            properties.put("okp:technology.language", "[ \"java\" ]");
            properties.put("okp:technology.important", String.valueOf(true));
            ws.propertyGroup.setProperties("8cd1e072-8595-4dd3-b121-41d622c43f08", "okg:consulting", properties);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

hasGroup

Sección titulada «hasGroup»

Descripción:

Método Valores de retorno Descripción
hasGroup(String uuid, String grpName) Boolean Devuelve un booleano que indica si el nodo tiene un grupo de metadatos.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            System.out.println("Have metadata group:" + ws.propertyGroup.hasGroup("8cd1e072-8595-4dd3-b121-41d622c43f08", "okg:consulting"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRegisteredDefinition

Sección titulada «getRegisteredDefinition»

Descripción:

Método Valores de retorno Descripción
getRegisteredDefinition() String Devuelve la definición XML de grupos de metadatos.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            System.out.println(ws.propertyGroup.getRegisteredDefinition());
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

registerDefinition

Sección titulada «registerDefinition»

Descripción:

Método Valores de retorno Descripción
registerDefinition(InputStream is, String name) void Establece la definición XML de grupos de metadatos en el repositorio.

Ejemplo:

package com.openkm;


import java.io.FileInputStream;
import java.io.InputStream;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            InputStream is = new FileInputStream("/home/openkm/PropertyGroups.xml");
            ws.propertyGroup.registerDefinition(is, "test");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getSuggestions

Sección titulada «getSuggestions»

Descripción:

Método Valores de retorno Descripción
getSuggestions(String uuid, String grpName, String propName) List Obtiene una lista de valores sugeridos para un campo de metadatos.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            for (String value : ws.propertyGroup.getSuggestions("8cd1e072-8595-4dd3-b121-41d622c43f08", "okg:technology", "okp:technology.language")) {
                System.out.println(value);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getProperties

Sección titulada «getProperties»

Descripción:

Método Valores de retorno Descripción
getProperties(String uuid, String grpName) Map<String, String> Obtiene un mapa - pares (clave, valor) - con los valores del grupo de metadatos de un nodo.

Ejemplo:

package com.openkm;


import java.util.HashMap;
import java.util.Map;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            Map<String, String> properties = new HashMap<>();
            properties = ws.propertyGroup.getProperties("8cd1e072-8595-4dd3-b121-41d622c43f08", "okg:technology");


            for (String key : properties.keySet()) {
                System.out.println(key + " > " + properties.get(key));
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getGroupsByVersion

Sección titulada «getGroupsByVersion»

Descripción:

Método Valores de retorno Descripción
getGroupsByVersion(String uuid, String versionName) List Obtiene una lista de los grupos de metadatos asignados a una versión específica de un nodo.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.PropertyGroup;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            for (PropertyGroup pGroup : ws.propertyGroup.getGroupsByVersion("118cb06b-9df7-4d59-bed9-ba986a4f8e0b", "1.3")) {
                System.out.println(pGroup);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPropertiesByVersion

Sección titulada «getPropertiesByVersion»

Descripción:

Método Valores de retorno Descripción
getPropertiesByVersion(String uuid, String grpName, String versionName) Map<String, String> Obtiene un mapa - pares (clave, valor) - con los valores del grupo de metadatos asignados a una versión específica de un nodo.

Ejemplo:

package com.openkm;


import java.util.HashMap;
import java.util.Map;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            Map<String, String> properties = new HashMap<>();
            properties = ws.propertyGroup.getPropertiesByVersion("118cb06b-9df7-4d59-bed9-ba986a4f8e0b", "okg:technology", "1.3");


            for (String key : properties.keySet()) {
                System.out.println(key + " > " + properties.get(key));
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPropertiesByVersionForm

Sección titulada «getPropertiesByVersionForm»

Descripción:

Método Valores de retorno Descripción
getPropertiesByVersionForm(String uuid, String grpName, String versionName) List Obtiene una lista de todas las definiciones de elementos del grupo de metadatos para una versión específica de un nodo.
  • grpName debe ser un nombre de grupo de metadatos válido.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.form.FormElement;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            for (FormElement fElement : ws.propertyGroup.getPropertiesByVersionForm("118cb06b-9df7-4d59-bed9-ba986a4f8e0b", "okg:consulting", "1.3")) {
                System.out.println(fElement);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getGroup

Sección titulada «getGroup»

Descripción:

Método Valores de retorno Descripción
getGroup(String grpName) PropertyGroup Obtiene el grupo de metadatos.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            System.out.println(ws.propertyGroup.getGroup("okg:consulting"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getSuggestBoxKeyValue

Sección titulada «getSuggestBoxKeyValue»

Descripción:

Método Valores de retorno Descripción
getSuggestBoxKeyValue(String grpName, String propertyName, String key) String Devuelve el valor de suggestBox para una clave.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            System.out.println(ws.propertyGroup.getPropertyGroup("okg:consulting"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getSuggestBoxKeyValuesFiltered

Sección titulada «getSuggestBoxKeyValuesFiltered»

Descripción:

Método Valores de retorno Descripción
getSuggestBoxKeyValuesFiltered(String grpName, String propertyName, String filter) Map<String, String>
Obtiene un mapa - pares (clave, valor) - con valores de suggestBox.

Ejemplo:

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


import java.util.Map;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            Map<String, String> values = ws.propertyGroup.getSuggestBoxKeyValuesFiltered(Config.GROUP_CONSULTING, "okp:consulting.suggestbox", "pai");
            for (String key : values.keySet()) {
                String value = values.get(key);
                System.out.println(key + ":" + value);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

validateField

Sección titulada «validateField»
Método Valores de retorno Descripción
validateField(String value, String className, List uuids) String Devuelve el mensaje de validación.

Ejemplo

package com.openkm;


import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.impl.OKMWebservices;


import java.util.ArrayList;
import java.util.List;


public class Test {


    public static void main(String[] args) {
        String host = "http://localhost:8080/openkm";
        String user = "okmAdmin";
        String password = "admin";
        OKMWebservices ws = OKMWebservicesFactory.getInstance(host);


        try {
            ws.login(user, password);
            List<String> uuids = new ArrayList<>();
            uuids.add("26ece92f-9708-4d3f-8033-18dc98b9e7f5");
            uuids.add("7984b622-7c5f-425a-9451-7611c0caf227");


            String value = "test";
            String className = "com.openkm.plugin.form.validator.DuplicateDocumentNumberValidator";
            String message = ws.propertyGroup.validateField(value, className, uuids);
            System.out.println("Validate: " + message);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}