Difference between revisions of "OKMRepository"

From OpenKM Documentation
Jump to: navigation, search
(Created page with '{{TOCright}} __TOC__ Methods related to repository management. Category: Webservices Guide')
 
Line 2: Line 2:
  
 
Methods related to repository management.
 
Methods related to repository management.
 +
 +
== Folder getRootFolder(String token) ==
 +
Obtain the root folder of the repository.
 +
'''Parameters'''
 +
'''Returns'''
 +
'''Throws'''
 +
 +
== Folder getTrashFolder(String token) ==
 +
Obtains the user trash folder.
 +
'''Parameters'''
 +
'''Returns'''
 +
'''Throws'''
 +
 +
== Folder getTemplatesFolder(String token) ==
 +
Obtain the template folder of the repository.
 +
'''Parameters'''
 +
'''Returns'''
 +
'''Throws'''
 +
 +
== Folder getPersonalFolder(String token) ==
 +
Obtain the personal documents folder of the repository.
 +
'''Parameters'''
 +
'''Returns'''
 +
'''Throws'''
 +
 +
== 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'''
 +
'''Returns'''
 +
'''Throws'''
 +
 +
== Folder getCategoriesFolder(String token) ==
 +
Obtain the categories folder of the repository.
 +
'''Parameters'''
 +
'''Returns'''
 +
'''Throws'''
 +
 +
== 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'''
 +
'''Returns'''
 +
'''Throws'''
 +
 +
== 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.
  
 
[[Category: Webservices Guide]]
 
[[Category: Webservices Guide]]

Revision as of 12:15, 8 March 2010

Methods related to repository management.

Folder getRootFolder(String token)

Obtain the root folder of the repository. Parameters Returns Throws

Folder getTrashFolder(String token)

Obtains the user trash folder. Parameters Returns Throws

Folder getTemplatesFolder(String token)

Obtain the template folder of the repository. Parameters Returns Throws

Folder getPersonalFolder(String token)

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

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 Returns Throws

Folder getCategoriesFolder(String token)

Obtain the categories folder of the repository. Parameters Returns Throws

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 Returns Throws

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.