OKMRepository

Methods related to repository management.

Folder getRootFolder(String token)

Obtain the root folder of the repository.

Parameters

• token - The session authorization token.

Returns

• A folder object with the repository root node properties.

Throws

• PathNotFoundException - If there is no root folder node in the repository.
• RepositoryException - If there is any general repository problem.

Folder getTrashFolder(String token)

Obtains the user trash folder.

Parameters

• token - The session authorization token.

Returns

• A folder object with the user trash node properties.

Throws

• PathNotFoundException - If there is no user trash folder node in the repository.
• RepositoryException - If there is any general repository problem.

Folder getTemplatesFolder(String token)

Obtain the template folder of the repository.

Parameters

• token - The session authorization token.

Returns

• A folder object with the templates node properties.

Throws

• PathNotFoundException - If there is no templates folder node in the repository.
• RepositoryException - If there is any general repository problem.

Folder getPersonalFolder(String token)

Obtain the personal documents folder of the repository.

Parameters

• token - The session authorization token.

Returns

• A folder object with the user documents folder node properties.

Throws

• PathNotFoundException - If there is no user documents folder node in the repository.
• RepositoryException - If there is any general repository problem.

Folder getMailFolder(String token)

Obtain the personal mails folder of the repository. Parameters Returns Throws

Folder getThesaurusFolder(String token)

Obtain the thesaurus folder of the repository.

Parameters

• token - The session authorization token.

Returns

• A folder object with the thesaurus folder node properties.

Throws

• PathNotFoundException - If there is no user documents folder node in the repository.
• RepositoryException - If there is any general repository problem.

Since

• OpenKM 5.0

Folder getCategoriesFolder(String token)

Obtain the categories folder of the repository.

Parameters

• token - The session authorization token.

Returns

• A folder object with the categories folder node properties.

Throws

• PathNotFoundException - If there is no user documents folder node in the repository.
• RepositoryException - If there is any general repository problem.

Since

• OpenKM 5.0

void purgeTrash(String token)

Remove all the items in the user trash folder for ever. You can't recover this items any more. Parameters Returns Throws

boolean hasNode(String token, String path)

Test if a node path exists

Parameters

• token - The session authorization token.
• path - The node path to test.

Returns

• True if the node exist or false if not.

Throws

• RepositoryException - If there is any general repository problem.

Since

• OpenKM 4.0

String getNodePath(String token, String uuid)

Obtain the node path with a given uuid.

Parameters

• token - The session authorization token.
• uuid - An unique node identifier.

Returns

• The path of the node with the given uuid.

Throws

• PathNotFoundException - If there is no user node in the repository with this uuid.
• RepositoryException - If there is any general repository problem.