FilePlan samples

Aspectos básicos

Ejemplo de código sugerido

Primero debe crear el objeto del servicio web:

OKMWebservices ws = OKMWebservicesFactory.getInstance(host);

A continuación, debe iniciar sesión mediante el método “login”. Puede acceder al método “login” desde el objeto del servicio web “ws”, tal y como se muestra a continuación:

ws.login(user, password);

Precaución

Una vez que ha iniciado sesión en el servicio web, la sesión se mantiene en el objeto del servicio web. A partir de ahí puede usar el resto de métodos de la API.

Llegados a este punto, puede usar todos los métodos de FilePlan desde la clase “filePlan”, tal y como se muestra a continuación:

ws.filePlan.getRootSections();

Métodos

getRootSections

Descripción:

Método	Valores de retorno	Descripción
getRootSections()	List	Devuelve una lista de objetos NodeClassSectionDefinition.

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClassSectionDefinition;
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);
            List<NodeClassSectionDefinition> list = ws.filePlan.getRootSections();
            for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
                System.out.println(nodeClassSectionDefinition);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRootSectionsFilteredBySecurity

Descripción:

Método	Valores de retorno	Descripción
getRootSectionsFilteredBySecurity(int permissions)	List	Devuelve una lista de objetos NodeClassSectionDefinition filtrada por permisos.

Nota

La clase com.openkm.sdk4j.bean.Permission contiene los valores de permiso (READ, WRITE, etc.). Debe usarla junto con los métodos que cambian u obtienen permisos de seguridad.

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClassSectionDefinition;
import com.openkm.sdk4j.bean.Permission;
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);
            List<NodeClassSectionDefinition> list = ws.filePlan.getRootSectionsFilteredBySecurity(Permission.ALL_GRANTS);
            for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
                System.out.println(nodeClassSectionDefinition);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChildrenSections

Descripción:

Método	Valores de retorno	Descripción
getChildrenSections(long parentId)	List	Devuelve una lista de objetos NodeClassSectionDefinition para la sección padre.

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClassSectionDefinition;
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);
            int parentId = 1;
            List<NodeClassSectionDefinition> list = ws.filePlan.getChildrenSections(parentId);
            for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
                System.out.println(nodeClassSectionDefinition);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChildrenSectionsFilteredBySecurity

Descripción:

Método	Valores de retorno	Descripción
getChildrenSectionsFilteredBySecurity(long parentId, int permissions)	List	Devuelve una lista de objetos NodeClassSectionDefinition para la sección padre, filtrada por permisos.

Nota

La clase com.openkm.sdk4j.bean.Permission contiene los valores de permiso (READ, WRITE, etc.). Debe usarla junto con los métodos que cambian u obtienen permisos de seguridad.

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClassSectionDefinition;
import com.openkm.sdk4j.bean.Permission;
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);
            int parentId = 4;
            List<NodeClassSectionDefinition> list = ws.filePlan.getChildrenSectionsFilteredBySecurity(parentId, Permission.READ + Permission.WRITE);
            for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
                System.out.println(nodeClassSectionDefinition);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChildrenClasses

Descripción:

Método	Valores de retorno	Descripción
getChildrenClasses(long sectionId)	List	Devuelve una lista de objetos NodeClass para la sección.

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;
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);
            int sectionId = 3;
            List<NodeClass> list = ws.filePlan.getChildrenClasses(sectionId);
            for (NodeClass nodeClass : list) {
                System.out.println(nodeClass);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChildrenClassesFilteredBySecurity

Descripción:

Método	Valores de retorno	Descripción
getChildrenClassesFilteredBySecurity(long sectionId, int permissions)	List	Devuelve una lista de objetos NodeClass para la sección, filtrada por permisos.

Nota

La clase com.openkm.sdk4j.bean.Permission contiene los valores de permiso (READ, WRITE, etc.). Debe usarla junto con los métodos que cambian u obtienen permisos de seguridad.

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;
import com.openkm.sdk4j.bean.Permission;
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);
            int sectionId = 3;
            List<NodeClass> list = ws.filePlan.getChildrenClassesFilteredBySecurity(sectionId, Permission.WRITE);
            for (NodeClass nodeClass : list) {
                System.out.println(nodeClass);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findNodeClassByPk

Descripción:

Método	Valores de retorno	Descripción
findNodeClassByPk(long id)	NodeClass	Devuelve un NodeClass.

Ejemplo:

package com.openkm;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;
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);
            int id = 4;
            NodeClass nodeClass = ws.filePlan.findNodeClassByPk(id);
            System.out.println(nodeClass);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findElectronicRecordClasses

Descripción:

Método	Valores de retorno	Descripción
findElectronicRecordClasses()	List	Devuelve una lista de objetos NodeClass que son expedientes electrónicos (Electronic Records).

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;
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);
            List<NodeClass> list = ws.filePlan.findElectronicRecordClasses();
            for (NodeClass nodeClass : list) {
                System.out.println(nodeClass);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findElectronicRecordClassesFilteredBySecurity

Descripción:

Método	Valores de retorno	Descripción
findElectronicRecordClassesFilteredBySecurity(int permissions)	List	Devuelve una lista de objetos NodeClass que son expedientes electrónicos para la sección, filtrada por permisos.

Nota

La clase com.openkm.sdk4j.bean.Permission contiene los valores de permiso (READ, WRITE, etc.). Debe usarla junto con los métodos que cambian u obtienen permisos de seguridad.

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;
import com.openkm.sdk4j.bean.Permission;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

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

        try {
            ws.login(user, password);
            List<NodeClass> list = ws.filePlan.findElectronicRecordClassesFilteredBySecurity(Permission.ALL_GRANTS);
            for (NodeClass nodeClass : list) {
                System.out.println(nodeClass);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findFilteredByCodeOrNameFilteredBySecurity

Descripción:

Método	Valores de retorno	Descripción
findFilteredByCodeOrNameFilteredBySecurity(String code, String name, int permissions)	List	Devuelve una lista de NodeClass filtrada por código, nombre y permisos.

Nota

La clase com.openkm.sdk4j.bean.Permission contiene los valores de permiso (READ, WRITE, etc.). Debe usarla junto con los métodos que cambian u obtienen permisos de seguridad.

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;
import com.openkm.sdk4j.bean.Permission;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

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

        try {
            ws.login(user, password);
            List<NodeClass> list = ws.filePlan.findFilteredByCodeOrNameFilteredBySecurity("1.", "", Permission.ALL_GRANTS);
            for (NodeClass nodeClass : list) {
                System.out.println(nodeClass);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findSectionFiltered

Descripción:

Método	Valores de retorno	Descripción
findSectionFiltered(String code, String name, int permissions)	List	Devuelve una lista de NodeClassSectionDefinition filtrada por código, nombre y permisos.

Nota

La clase com.openkm.sdk4j.bean.Permission contiene los valores de permiso (READ, WRITE, etc.). Debe usarla junto con los métodos que cambian u obtienen permisos de seguridad.

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClassSectionDefinition;
import com.openkm.sdk4j.bean.Permission;
import com.openkm.sdk4j.impl.OKMWebservices;

public class Test {

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

        try {
            ws.login(user, password);
            List<NodeClassSectionDefinition> list = ws.filePlan.findSectionFiltered("1.", "invoice", Permission.ALL_GRANTS);
            for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
                System.out.println(nodeClassSectionDefinition);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getNodeClassBreadcrumb

Descripción:

Método	Valores de retorno	Descripción
getNodeClassBreadcrumb(long sectionId)	List	Devuelve una lista de objetos NodeClassSectionDefinition que son expedientes electrónicos (Electronic Records).

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClassSectionDefinition;
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);
            int sectionId = 3;
            List<NodeClassSectionDefinition> list = ws.filePlan.getNodeClassBreadcrumb(sectionId);
            for (NodeClassSectionDefinition nodeClassSectionDefinition : list) {
                System.out.println(nodeClassSectionDefinition);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

findAllNodeClasses

Descripción:

Método	Valores de retorno	Descripción
findAllNodeClasses()	List	Devuelve una lista de objetos NodeClass.

Ejemplo:

package com.openkm;

import java.util.List;

import com.openkm.sdk4j.OKMWebservicesFactory;
import com.openkm.sdk4j.bean.NodeClass;
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);
            List<NodeClass> list = ws.filePlan.findAllNodeClasses();
            for (NodeClass nodeClass : list) {
                System.out.println(nodeClass);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getRootSectionsIdWithChildren

Descripción:

Método	Valores de retorno	Descripción
getRootSectionsIdWithChildren()	List	Devuelve una lista de IDs de sección que tienen hijos y cuyo padre es la raíz.

Ejemplo:

package com.openkm;

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

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<Long> list = ws.filePlan.getRootSectionsIdWithChildren();
            for (long id : list) {
                System.out.println(id);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChildrenSectionsIdByTenantWithChildren

Descripción:

Método	Valores de retorno	Descripción
getChildrenSectionsIdByTenantWithChildren(long parendId)	List	Devuelve una lista de IDs de sección que tienen hijos, con padre igual a parentId y filtrada por tenant.

Ejemplo:

package com.openkm;

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

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);
            long parentId = 1;
            List<Long> list = ws.filePlan.getChildrenSectionsIdByTenantWithChildren(parentId);
            for (long id : list) {
                System.out.println(id);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}