Folder samples

Aspectos básicos

En la mayoría de los métodos verá un parámetro llamado “fldId”. El valor de este parámetro puede ser un UUID o una ruta (path) válidos de carpeta.

Consejo

Ejemplo de fldId:

• Usando UUID -> “f123a950-0329-4d62-8328-0ff500fd42db”;
• Usando path -> “/okm:root/test”

Métodos

createFolder

Descripción:

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

La variable path del parámetro fld debe inicializarse. Indica la ruta de la carpeta dentro de OpenKM.

Folder fld = new Folder();
fld.setPath("/okm:root/test");

Precaución

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

Le recomendamos usar el método siguiente, createFolderSimple, en lugar de este.

Ejemplo:

package com.openkm;

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

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 {
    Folder fld = new Folder();
    fld.setPath("/okm:root/test");
    ws.createFolder(fld);
   } catch (Exception e) {
    e.printStackTrace();
   }
  }
}

createFolderSimple

Descripción:

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

Ejemplo:

package com.openkm;

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

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 {
    ws.createFolderSimple("/okm:root/test");
   } catch (Exception e) {
    e.printStackTrace();
   }
  }
}

getFolderProperties

Descripción:

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

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 {
    System.out.println(ws.getFolderProperties("/okm:root/test"));
   } catch (Exception e) {
    e.printStackTrace();
   }
  }
}

deleteFolder

Descripción:

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

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 {
    ws.deleteFolder("/okm:root/test");
   } catch (Exception e) {
    e.printStackTrace();
   }
  }
}

renameFolder

Descripción:

Método	Valores de retorno	Descripción
renameFolder(String fldId, String newName)	void	Cambia el nombre de una carpeta.

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 {
    // Exists folder /okm:root/test
    ws.renameFolder("/okm:root/test","renamedFolder");
    // Folder has renamed to /okm:root/renamedFolder
   } catch (Exception e) {
    e.printStackTrace();
   }
  }
}

moveFolder

Descripción:

Método	Valores de retorno	Descripción
moveFolder(String fldId, String dstId)	void	Mueve la carpeta a otra carpeta o expediente.

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

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 {
    // Exists folder /okm:root/test
    ws.moveFolder("/okm:root/test","/okm:root/tmp");
    // Folder has moved to /okm:root/tmp/test
   } catch (Exception e) {
    e.printStackTrace();
   }
  }
}

getFolderChildren

Descripción:

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

El parámetro fldId puede ser un nodo de carpeta o de expediente.

Ejemplo:

package com.openkm;

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

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 (Folder fld : ws.getFolderChildren("/okm:root")) {
     System.out.println(fld);
    }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

isValidFolder

Descripción:

Método	Valores de retorno	Descripción
isValidFolder(String fldId)	Boolean	Devuelve un booleano que indica si el nodo es una carpeta.

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 {
            // Return false
            ws.isValidFolder("/okm:root/logo.png");

            // Return true
            ws.isValidFolder("/okm:root");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getFolderPath

Descripción:

Método	Valores de retorno	Descripción
getFolderPath(String uuid)	String	Convierte un UUID de carpeta en una ruta de carpeta.

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 {
            System.out.println(ws.getFolderPath("f123a950-0329-4d62-8328-0ff500fd42db"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

copyFolder

Descripción:

Método	Valores de retorno	Descripción
copyFolder(String fldId, String dstId, String newName)	void	Copia una carpeta en otra carpeta o expediente.

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

Cuando el valor del parámetro newName es null, la carpeta conserva el mismo nombre.

Precaución

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

Vea el método “extendedFolderCopy” para esta funcionalidad.

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 {
            ws.copyFolder("/okm:root/test","/okm:root/temp","new_name");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

extendedFolderCopy

Descripción:

Método	Valores de retorno	Descripción
extendedFolderCopy(String fldId, String dstId, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki)	void	Copia una carpeta junto con los datos asociados a otra carpeta o expediente.

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

Nota

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

Adicionalmente:

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

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 {
            ws.extendedFolderCopy("/okm:root/test", "/okm:root/tmp", true, true, true, true, true);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

getContentInfo

Descripción:

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

El objeto ContentInfo recoge información sobre:

• El número de carpetas dentro de la carpeta.
• El número de documentos dentro de la carpeta.
• El número de expedientes dentro de la carpeta.
• El número de correos dentro de la carpeta.
• El tamaño en bytes de todos los objetos de la carpeta.

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 {
            System.out.println(ws.getContentInfo("/okm:root/test"));
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

purgeFolder

Descripción:

Método	Valores de retorno	Descripción
purgeFolder(String fldId)	void	La carpeta se elimina permanentemente del repositorio.

Normalmente se purgan carpetas en /okm:trash/userId - las ubicaciones personales de la papelera de cada usuario - pero es posible purgar directamente cualquier carpeta del repositorio.

Precaución

Cuando se purga una carpeta, solo podrá restaurarse a partir de una copia de seguridad anterior del repositorio. La acción de purgar elimina la carpeta permanentemente del repositorio.

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 {
            ws.purgeFolder("/okm:trash/okmAdmin/test");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

setStyle

Descripción:

Método	Valores de retorno	Descripción
setStyle(String fldId, long styleId)	void	Establece el estilo de la carpeta.

Nota

Más información en Folder style.

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 {
            ws.setStyle("/okm:trash/okmAdmin/test", 1);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}

createMissingFolders

Descripción:

Método	Valores de retorno	Descripción
createMissingFolders(String fldPath)	void	Crea las carpetas que falten.

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 {
            ws.createMissingFolders("/okm:root/missingfld1/missingfld2/missingfld3");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}