OKMFolder

Conceptos básicos

En casi todos los métodos verá un parámetro llamado “fldId”. El valor de este parámetro puede ser un UUID o una ruta válidos de carpeta.

Consejo

Ejemplo de fldId:

• Usando UUID -> “c52f9ea0-0d6c-45da-bae4-d72b66f42da3”;
• Usando ruta -> “/okm:root/test”

Respecto al parámetro llamado “dstId”, su valor puede ser el UUID o la ruta de una carpeta válida.

Consejo

Ejemplo de dstId:

• Usando el UUID -> “c4455667-0d6c-45da-1234-d98564323e0”;
• Usando la ruta -> “/okm:root/folder2”

Además, en todos los métodos verá un parámetro llamado “token”. Al acceder a la aplicación a través de SOAP, el proceso de inicio de sesión devuelve un token, que se utiliza para identificar al usuario en todos los métodos expuestos. Desde el contexto de ejecución por defecto de la aplicación debe utilizar el valor “null”, que indica a la aplicación que debe utilizar la “sesión del usuario”.

Consejo

En casos especiales puede “promocionarse como Administrador” utilizando el “token de administrador”.

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

Métodos

create

Descripción:

Método	Valores de retorno	Descripción
create(String token, Folder fld)	Folder	Crea una nueva carpeta y devuelve como resultado un objeto Folder.

Precaución

El resto de variables de la carpeta ( fld ) no tendrán ningún efecto en la creación de la carpeta.

Le sugerimos utilizar el método siguiente (createSimple) para crear la carpeta, en lugar de este.

• La variable path del parámetro fld debe estar inicializada. Indica la ruta de la carpeta en OpenKM.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMFolder;
import com.openkm.bean.Folder;

public class Test {
    public static void main(String[] args) {
        try {
            Folder fld = new Folder();
            fld.setPath("/okm:root/test");
            OKMFolder.getInstance().create(null, fld);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createSimple

Descripción:

Método	Valores de retorno	Descripción
createSimple(String token, String fldPath)	Folder	Crea una nueva carpeta y devuelve como resultado un objeto Folder.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMFolder;

public class Test {
    public static void main(String[] args) {
        try {
            String fldPath = "/okm:root/test";
            OKMFolder.getInstance().createSimple(null, fldPath);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getProperties

Descripción:

Método	Valores de retorno	Descripción
getProperties(String token, String fldId)	Folder	Devuelve las propiedades de la carpeta.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMFolder;
import com.openkm.bean.Folder;

public class Test {
    public static void main(String[] args) {
        try {
            Folder fld = OKMFolder.getInstance().getProperties(null, "/okm:root/test");
            System.out.println(fld);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

delete

Descripción:

Método	Valores de retorno	Descripción
delete(String token, String fldId)	void	Elimina una carpeta.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMFolder;

public class Test {
    public static void main(String[] args) {
        try {
            OKMFolder.getInstance().delete(null, "/okm:root/test");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

purge

Descripción:

Método	Valores de retorno	Descripción
purge(String token, String fldId)	void	La carpeta se elimina definitivamente del repositorio.

Precaución

Cuando se purga una carpeta, solo se podrá restaurar desde una copia de seguridad previa del repositorio. La acción de purga elimina la carpeta definitivamente del repositorio.

• Normalmente purgará carpetas de /okm:trash/userId (las ubicaciones de la papelera personal del usuario), pero es posible purgar directamente cualquier carpeta de todo el repositorio.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMFolder;

public class Test {
    public static void main(String[] args) {
        try {
            OKMFolder.getInstance().purge(null, "/okm:root/test");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

rename

Descripción:

Método	Valores de retorno	Descripción
rename(String token, String fldId, String newName)	Folder	Renombra una carpeta.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMFolder;

public class Test {
    public static void main(String[] args) {
        try {
            OKMFolder.getInstance().rename(null, "/okm:root/test", "newname");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

move

Descripción:

Método	Valores de retorno	Descripción
move(String token, String fldId, String dstId)	void	Mueve una carpeta a otra carpeta.

• El valor del parámetro dstId debe ser un UUID o una ruta (path) de carpeta.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMFolder;

public class Test {
    public static void main(String[] args) {
        try {
            OKMFolder.getInstance().move(null, "/okm:root/test", "/okm:root/move/destination");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

copy

Descripción:

Método	Valores de retorno	Descripción
copy(String token, String fldId, String dstId)	void	Copia una carpeta en otra carpeta.

Precaución

Solo se copian al destino los permisos de seguridad; los metadatos, las palabras clave, etc. de la carpeta no se copian.

Consulte el método “extendedCopy” para esta funcionalidad.

• El valor del parámetro dstId debe ser un UUID o una ruta (path) de carpeta.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMFolder;

public class Test {
    public static void main(String[] args) {
        try {
            OKMFolder.getInstance().copy(null, "/okm:root/test", "/okm:root/move/destination");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

extendedCopy

Descripción:

Método	Valores de retorno	Descripción
extendedCopy(String token, String fldId, String dstId, ExtendedAttributes extAttr)	void	Copia una carpeta con sus datos asociados en otra carpeta.

Nota

Por defecto solo se copian los datos binarios y los permisos de seguridad; los metadatos, las palabras clave, etc. de la carpeta no se copian.

Parámetros adicionales de atributos extendidos:

• Cuando el parámetro category es true, se copiarán los valores originales de las categorías.
• Cuando el parámetro keywords es true, se copiarán los valores originales de las palabras clave.
• Cuando el parámetro propertyGroups es true, se copiarán los valores originales de los grupos de metadatos.
• Cuando el parámetro notes es true, se copiarán los valores originales de las notas.
• Cuando el parámetro wiki es true, se copiarán los valores originales de la wiki.

• El valor del parámetro dstId debe ser un UUID o una ruta (path) de carpeta.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMFolder;
import com.openkm.bean.ExtendedAttributes;

public class Test {
    public static void main(String[] args) {
        try {
            ExtendedAttributes extAttr = new ExtendedAttributes();
            extAttr.setKeywords(true);
            OKMFolder.getInstance().extendedCopy(null, "/okm:root/sample.pdf","/okm:root/test", extAttr);

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

extendedCopy

Descripción:

Método	Valores de retorno	Descripción
extendedCopy(String token, String fldId, String dstId, ExtendedAttributes extAttr, String newName)	void	Copia una carpeta con sus datos asociados en otra carpeta.

Nota

Por defecto solo se copian los datos binarios y los permisos de seguridad; los metadatos, las palabras clave, etc. de la carpeta no se copian.

Parámetros adicionales de atributos extendidos:

• Cuando el parámetro category es true, se copiarán los valores originales de las categorías.
• Cuando el parámetro keywords es true, se copiarán los valores originales de las palabras clave.
• Cuando el parámetro propertyGroups es true, se copiarán los valores originales de los grupos de metadatos.
• Cuando el parámetro notes es true, se copiarán los valores originales de las notas.
• Cuando el parámetro wiki es true, se copiarán los valores originales de la wiki.

• El valor del parámetro dstId debe ser un UUID o una ruta (path) de carpeta.
• Cuando el valor del parámetro newName es null, la carpeta conservará el mismo nombre.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMFolder;
import com.openkm.bean.ExtendedAttributes;

public class Test {
    public static void main(String[] args) {
        try {
            ExtendedAttributes extAttr = new ExtendedAttributes();
            extAttr.setKeywords(true);
            OKMFolder.getInstance().extendedCopy(null, "/okm:root/sample.pdf","/okm:root/test", extAttr, "new_name.pdf");

        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChilds

Descripción:

Método	Valores de retorno	Descripción
getChilds(String token, String fldId)	List	Devuelve una lista de todas las carpetas cuyo padre es fldId.

Peligro

Este método está obsoleto en favor del método getChildren. Le recomendamos no utilizarlo, porque en un futuro próximo se eliminará.

• El parámetro fldId puede ser un nodo de tipo carpeta.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMFolder;
import com.openkm.bean.Folder;

public class Test {
    public static void main(String[] args) {
        try {
            for (Folder fld : OKMFolder.getInstance().getChilds(null, "/okm:root/test")) {
                System.out.println(fld);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getChildren

Descripción:

Método	Valores de retorno	Descripción
getChildren(String token, String fldId)	List	Devuelve una lista de todas las carpetas cuyo padre es fldId.

• El parámetro fldId puede ser un nodo de tipo carpeta.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMFolder;
import com.openkm.bean.Folder;

public class Test {
    public static void main(String[] args) {
        try {
            for (Folder fld : OKMFolder.getInstance().getChildren(null, "/okm:root/test")) {
                System.out.println(fld);
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getContentInfo

Descripción:

Método	Valores de retorno	Descripción
getContentInfo(String token, String fldId)	ContentInfo	Devuelve un objeto ContentInfo con información sobre la carpeta.

• El objeto ContentInfo recupera información sobre:

Ejemplo:

package com.openkm;

import com.openkm.api.OKMFolder;
import com.openkm.bean.ContentInfo;

public class Test {
    public static void main(String[] args) {
        try {
            ContentInfo ci =  OKMFolder.getInstance().getContentInfo(null, "/okm:root/test");
            System.out.println(ci);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

isValid

Descripción:

Método	Valores de retorno	Descripción
isValid(String token, String fldId)	boolean	Devuelve un booleano que indica si el nodo es una carpeta o no.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMFolder;

public class Test {
    public static void main(String[] args) {
        try {
            boolean valid =  OKMFolder.getInstance().isValid(null, "/okm:root/test");
            System.out.println(valid);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getPath

Descripción:

Método	Valores de retorno	Descripción
getPath(String token, String uuid)	String	Convierte el UUID de una carpeta en su ruta.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMFolder;

public class Test {
    public static void main(String[] args) {
        try {
            String path =  OKMFolder.getInstance().getPath(null, "c52f9ea0-0d6c-45da-bae4-d72b66f42da3");
            System.out.println(path);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createMissingFolders

Descripción:

Método	Valores de retorno	Descripción
createMissingFolders(String token, String fldPath)	void	Crea las carpetas que falten a partir de todos los nodos de la ruta.

Nota

El método comprueba todas las subcarpetas y, cuando detecta que falta alguna, crea todas las subcarpetas que faltan a partir de ahí.

Ejemplo:

package com.openkm;

import com.openkm.api.OKMFolder;

public class Test {
    public static void main(String[] args) {
        try {
            OKMFolder.getInstance().createMissingFolders(null, "/okm:root/test/missing/from/here");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}