Difference between revisions of "OKMFolder"

From OpenKM Documentation
Jump to: navigation, search
(Created page with '{{TOCright}} __TOC__ Methods related to folder management. Category: Webservices Guide')
 
(→‎boolean isValid(String token, String fldPath))
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
{{TOCright}} __TOC__
+
__TOC__
  
 
Methods related to folder management.
 
Methods related to folder management.
 +
 +
== Folder create(String token, Folder fld) ==
 +
Create a new folder in the repository.
 +
 +
'''Parameters'''
 +
* ''token'' - The session authorization token.
 +
* ''fld'' - A folder object with the new folder properties.
 +
 +
'''Returns'''
 +
* A folder object with the new created folder properties.
 +
 +
'''Throws'''
 +
* ''PathNotFoundException'' - If the parent folder doesn't exist.
 +
* ''ItemExistsException'' - If there is already a folder in the repository with the same name in the same path.
 +
* ''AccessDeniedException'' - If there is any security problem: you can't modify the parent folder because of lack of permissions.
 +
* ''RepositoryException'' - If there is any general repository problem.
 +
 +
== Folder getProperties(String token, String fldPath) ==
 +
Obtains properties from a previously created folder.
 +
 +
'''Parameters'''
 +
* ''token'' -The session authorization token .
 +
* ''fldPath'' - The path that identifies an unique folder.
 +
 +
'''Returns'''
 +
* A folder object with the selected folder properties.
 +
 +
'''Throws'''
 +
* ''ItemNotFoundException'' - If the indicated folder doesn't exist.
 +
* ''RepositoryException'' - If there is any general repository problem.
 +
 +
== void delete(String token, String fldPath) ==
 +
Delete a folder the repository. It is a logical delete, so really is moved to the user trash and can be restored.
 +
 +
'''Parameters'''
 +
* ''token'' - The session authorization token.
 +
* ''fldPath'' - The path that identifies an unique folder.
 +
 +
'''Returns'''
 +
* None.
 +
 +
'''Throws'''
 +
* ''LockException'' - Can't delete a folder with locked documents.
 +
* ''PathNotFoundException'' - If there is no folder in the repository in this path.
 +
* ''AccessDeniedException'' - If there is any security problem: you can't modify the folder because of lack of permissions.
 +
* ''RepositoryException'' - If there is any general repository problem.
 +
 +
== Folder rename(String token, String fldPath, String newName) ==
 +
Rename a folder in the repository.
 +
 +
'''Parameters'''
 +
* ''token'' - The session authorization token.
 +
* ''fldPath'' - The path that identifies an unique folder.
 +
* ''newName'' - The new folder name.
 +
 +
'''Returns'''
 +
* A folder object with the new folder properties.
 +
 +
'''Throws'''
 +
* ''PathNotFoundException'' - If there is no folder in the repository in this path
 +
* ''ItemExistsException'' - If there is already a folder in the repository with the same name in the same path.
 +
* ''AccessDeniedException'' - If there is any security problem: you can't modify the folder because of lack of permissions.
 +
* ''RepositoryException'' - If there is any general repository problem.
 +
 +
== void move(String token, String fldPath, String dstPath) ==
 +
Move a folder to another location in the repository.
 +
 +
'''Parameters'''
 +
* ''token'' - The session authorization token.
 +
* ''fldPath'' - The path that identifies an unique folder.
 +
* ''dstPath'' - The path of the destination folder.
 +
 +
'''Returns'''
 +
* A folder object with the new folder properties.
 +
 +
'''Throws'''
 +
* ''PathNotFoundException'' - If the dstPath does not exists.
 +
* ''ItemExistsException'' - If there is already a folder in the destination folder with the same name.
 +
* ''AccessDeniedException'' - If there is any security problem: you can't modify the parent folder or the destination folder because of lack of permissions.
 +
* ''RepositoryException'' - If there is any general repository problem.
 +
 +
== FolderArray getChilds(String token, String fldPath) ==
 +
Retrieve a list of child folders from an existing one.
 +
 +
'''Parameters'''
 +
* ''token'' - The session authorization token.
 +
* ''fldPath'' - The path that identifies an unique folder.
 +
 +
'''Returns'''
 +
* A Collection with the child folders.
 +
 +
'''Throws'''
 +
* ''PathNotFoundException'' - If there is no folder in the repository in this path.
 +
* ''RepositoryException'' - If there is any general repository problem.
 +
 +
== boolean isValid(String token, String fldPath) ==
 +
Test if a folder path is valid.
 +
 +
'''Parameters'''
 +
* ''token'' - String with user authorization info.
 +
* ''fldPath'' - The path that identifies an unique folder.
 +
 +
'''Returns'''
 +
* True if is a valid folder path, otherwise false.
 +
 +
'''Throws'''
 +
* ''AccessDeniedException'' - If there is any security problem: you can't access this folder because of lack of permissions.
 +
* ''RepositoryException'' - If there is any general repository problem.
 +
* ''PathNotFoundException'' - If there is no folder in the repository with this path.
 +
 +
'''Since'''
 +
* OpenKM 4.0
 +
 +
== String getPath(String token, String uuid) ==
 +
The the folder path from a UUID.
 +
 +
'''Parameters'''
 +
* ''token'' - The session authorization token.
 +
* ''uuid'' - The unique folder identifier.
 +
 +
'''Returns'''
 +
* The folder path or null if this UUID does not correspond to a folder node.
 +
 +
'''Throws'''
 +
* ''AccessDeniedException'' - If there is any security problem: you can't access this folder because of lack of permissions.
 +
* ''RepositoryException'' If there is any general repository problem.
 +
 +
'''Since'''
 +
* OpenKM 5.0
  
 
[[Category: Webservices Guide]]
 
[[Category: Webservices Guide]]

Latest revision as of 11:47, 1 October 2010

Methods related to folder management.

Folder create(String token, Folder fld)

Create a new folder in the repository.

Parameters

  • token - The session authorization token.
  • fld - A folder object with the new folder properties.

Returns

  • A folder object with the new created folder properties.

Throws

  • PathNotFoundException - If the parent folder doesn't exist.
  • ItemExistsException - If there is already a folder in the repository with the same name in the same path.
  • AccessDeniedException - If there is any security problem: you can't modify the parent folder because of lack of permissions.
  • RepositoryException - If there is any general repository problem.

Folder getProperties(String token, String fldPath)

Obtains properties from a previously created folder.

Parameters

  • token -The session authorization token .
  • fldPath - The path that identifies an unique folder.

Returns

  • A folder object with the selected folder properties.

Throws

  • ItemNotFoundException - If the indicated folder doesn't exist.
  • RepositoryException - If there is any general repository problem.

void delete(String token, String fldPath)

Delete a folder the repository. It is a logical delete, so really is moved to the user trash and can be restored.

Parameters

  • token - The session authorization token.
  • fldPath - The path that identifies an unique folder.

Returns

  • None.

Throws

  • LockException - Can't delete a folder with locked documents.
  • PathNotFoundException - If there is no folder in the repository in this path.
  • AccessDeniedException - If there is any security problem: you can't modify the folder because of lack of permissions.
  • RepositoryException - If there is any general repository problem.

Folder rename(String token, String fldPath, String newName)

Rename a folder in the repository.

Parameters

  • token - The session authorization token.
  • fldPath - The path that identifies an unique folder.
  • newName - The new folder name.

Returns

  • A folder object with the new folder properties.

Throws

  • PathNotFoundException - If there is no folder in the repository in this path
  • ItemExistsException - If there is already a folder in the repository with the same name in the same path.
  • AccessDeniedException - If there is any security problem: you can't modify the folder because of lack of permissions.
  • RepositoryException - If there is any general repository problem.

void move(String token, String fldPath, String dstPath)

Move a folder to another location in the repository.

Parameters

  • token - The session authorization token.
  • fldPath - The path that identifies an unique folder.
  • dstPath - The path of the destination folder.

Returns

  • A folder object with the new folder properties.

Throws

  • PathNotFoundException - If the dstPath does not exists.
  • ItemExistsException - If there is already a folder in the destination folder with the same name.
  • AccessDeniedException - If there is any security problem: you can't modify the parent folder or the destination folder because of lack of permissions.
  • RepositoryException - If there is any general repository problem.

FolderArray getChilds(String token, String fldPath)

Retrieve a list of child folders from an existing one.

Parameters

  • token - The session authorization token.
  • fldPath - The path that identifies an unique folder.

Returns

  • A Collection with the child folders.

Throws

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

boolean isValid(String token, String fldPath)

Test if a folder path is valid.

Parameters

  • token - String with user authorization info.
  • fldPath - The path that identifies an unique folder.

Returns

  • True if is a valid folder path, otherwise false.

Throws

  • AccessDeniedException - If there is any security problem: you can't access this folder because of lack of permissions.
  • RepositoryException - If there is any general repository problem.
  • PathNotFoundException - If there is no folder in the repository with this path.

Since

  • OpenKM 4.0

String getPath(String token, String uuid)

The the folder path from a UUID.

Parameters

  • token - The session authorization token.
  • uuid - The unique folder identifier.

Returns

  • The folder path or null if this UUID does not correspond to a folder node.

Throws

  • AccessDeniedException - If there is any security problem: you can't access this folder because of lack of permissions.
  • RepositoryException If there is any general repository problem.

Since

  • OpenKM 5.0
Retrieved from "https://www.openkm.com/wiki/index.php?title=OKMFolder&oldid=2469"