com.openkm.sdk4j.impl

Class FolderImpl

java.lang.Object

com.openkm.sdk4j.impl.ClientImpl

com.openkm.sdk4j.impl.FolderImpl

All Implemented Interfaces:

BaseFolder, Serializable

public class FolderImpl
extends ClientImpl
implements BaseFolder, Serializable

BaseFolder

Author:

jllort

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FolderImpl(String host) FolderImpl

Method Summary

Modifier and Type	Method and Description
Folder	copyFolder(String uuid, String dstId, String newName) Copy folder folder.
Folder	createFolder(String uuid, String name) Create folder folder.
Folder	createFolderFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, Map<String,String> properties) Create folder from template folder.
Folder	createFolderFromTemplate(String uuid, String dstPath, String language, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki, Map<String,String> properties) Deprecated. As of sdk4j 3.16, replaced by createFolderFromTemplate(String, String, boolean, boolean, boolean, Map)
void	createMissingFolders(String fldPath) Create missing folders.
void	deleteFolder(String uuid) Delete folder.
Folder	extendedFolderCopy(String uuid, String dstId, String newName, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean security) Extended folder copy folder.
Folder	extendedFolderCopy(String uuid, String dstId, String newName, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki, boolean security) Deprecated. As of sdk4j 3.13, replaced by extendedFolderCopy(String, String, String, boolean, boolean, boolean, boolean, boolean)
ContentInfo	getContentInfo(String uuid) Gets content info.
List<Folder>	getFolderChildren(String uuid) Gets folder children.
String	getFolderPath(String uuid) Gets folder path.
Folder	getFolderProperties(String uuid) Gets folder properties.
boolean	isValidFolder(String uuid) Is valid folder boolean.
void	moveFolder(String uuid, String dstId) Move folder.
void	purgeFolder(String uuid) Purge folder.
void	renameFolder(String uuid, String newName) Rename folder.
void	setAuthorizationToken(String authorizationToken) setAuthenticationToken
void	setFolderDescription(String uuid, String description) Sets folder description.
void	setStyle(String uuid, long styleId) Sets style.

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl

getClient, resource, resource, resource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FolderImpl

public FolderImpl(String host)

FolderImpl

Method Detail

setAuthorizationToken

public void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

createFolder

public Folder createFolder(String uuid,
                           String name)
                    throws AccessDeniedException,
                           RepositoryException,
                           PathNotFoundException,
                           ItemExistsException,
                           DatabaseException,
                           ExtensionException,
                           AutomationException,
                           PromotedAsRecordLockException,
                           UnknownException,
                           WebserviceException

Description copied from interface: BaseFolder

Create folder folder.

Specified by:

createFolder in interface BaseFolder

Parameters:

uuid - the uuid

name - the name

Returns:

the folder

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getFolderProperties

public Folder getFolderProperties(String uuid)
                           throws AccessDeniedException,
                                  RepositoryException,
                                  PathNotFoundException,
                                  DatabaseException,
                                  UnknownException,
                                  WebserviceException

Description copied from interface: BaseFolder

Gets folder properties.

Specified by:

getFolderProperties in interface BaseFolder

Parameters:

uuid - the uuid

Returns:

the folder properties

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

deleteFolder

public void deleteFolder(String uuid)
                  throws AutomationException,
                         LockException,
                         PathNotFoundException,
                         AccessDeniedException,
                         RepositoryException,
                         DatabaseException,
                         UnknownException,
                         WebserviceException

Description copied from interface: BaseFolder

Delete folder.

Specified by:

deleteFolder in interface BaseFolder

Parameters:

uuid - the uuid

Throws:

AutomationException - the automation exception

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

renameFolder

public void renameFolder(String uuid,
                         String newName)
                  throws PathNotFoundException,
                         ItemExistsException,
                         AccessDeniedException,
                         RepositoryException,
                         UnknownException,
                         WebserviceException

Description copied from interface: BaseFolder

Rename folder.

Specified by:

renameFolder in interface BaseFolder

Parameters:

uuid - the uuid

newName - the new name

Throws:

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

moveFolder

public void moveFolder(String uuid,
                       String dstId)
                throws PathNotFoundException,
                       ItemExistsException,
                       AccessDeniedException,
                       RepositoryException,
                       DatabaseException,
                       UnknownException,
                       WebserviceException

Description copied from interface: BaseFolder

Move folder.

Specified by:

moveFolder in interface BaseFolder

Parameters:

uuid - the uuid

dstId - the dst id

Throws:

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getFolderChildren

public List<Folder> getFolderChildren(String uuid)
                               throws AccessDeniedException,
                                      PathNotFoundException,
                                      RepositoryException,
                                      DatabaseException,
                                      UnknownException,
                                      WebserviceException

Description copied from interface: BaseFolder

Gets folder children.

Specified by:

getFolderChildren in interface BaseFolder

Parameters:

uuid - the uuid

Returns:

the folder children

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

isValidFolder

public boolean isValidFolder(String uuid)
                      throws PathNotFoundException,
                             AccessDeniedException,
                             RepositoryException,
                             DatabaseException,
                             UnknownException,
                             WebserviceException

Description copied from interface: BaseFolder

Is valid folder boolean.

Specified by:

isValidFolder in interface BaseFolder

Parameters:

uuid - the uuid

Returns:

the boolean

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getFolderPath

public String getFolderPath(String uuid)
                     throws AccessDeniedException,
                            RepositoryException,
                            DatabaseException,
                            UnknownException,
                            WebserviceException

Description copied from interface: BaseFolder

Gets folder path.

Specified by:

getFolderPath in interface BaseFolder

Parameters:

uuid - the uuid

Returns:

the folder path

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

copyFolder

public Folder copyFolder(String uuid,
                         String dstId,
                         String newName)
                  throws PathNotFoundException,
                         ItemExistsException,
                         AccessDeniedException,
                         RepositoryException,
                         AutomationException,
                         DatabaseException,
                         UserQuotaExceededException,
                         PromotedAsRecordLockException,
                         UnknownException,
                         WebserviceException

Description copied from interface: BaseFolder

Copy folder folder.

Specified by:

copyFolder in interface BaseFolder

Parameters:

uuid - the uuid

dstId - the dst id

newName - the new name

Returns:

the folder

Throws:

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

AutomationException - the automation exception

DatabaseException - the database exception

UserQuotaExceededException - the user quota exceeded exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

extendedFolderCopy

public Folder extendedFolderCopy(String uuid,
                                 String dstId,
                                 String newName,
                                 boolean categories,
                                 boolean keywords,
                                 boolean propertyGroups,
                                 boolean notes,
                                 boolean security)
                          throws ItemExistsException,
                                 PathNotFoundException,
                                 AccessDeniedException,
                                 RepositoryException,
                                 DatabaseException,
                                 UserQuotaExceededException,
                                 AutomationException,
                                 PromotedAsRecordLockException,
                                 UnknownException,
                                 WebserviceException

Description copied from interface: BaseFolder

Extended folder copy folder.

Specified by:

extendedFolderCopy in interface BaseFolder

Parameters:

uuid - the uuid

dstId - the dst id

newName - the new name

categories - the categories

keywords - the keywords

propertyGroups - the property groups

notes - the notes

security - the security

Returns:

the folder

Throws:

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UserQuotaExceededException - the user quota exceeded exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

extendedFolderCopy

@Deprecated
public Folder extendedFolderCopy(String uuid,
                                             String dstId,
                                             String newName,
                                             boolean categories,
                                             boolean keywords,
                                             boolean propertyGroups,
                                             boolean notes,
                                             boolean wiki,
                                             boolean security)
                                      throws ItemExistsException,
                                             PathNotFoundException,
                                             AccessDeniedException,
                                             RepositoryException,
                                             DatabaseException,
                                             UserQuotaExceededException,
                                             AutomationException,
                                             PromotedAsRecordLockException,
                                             UnknownException,
                                             WebserviceException

Deprecated. As of sdk4j 3.13, replaced by extendedFolderCopy(String, String, String, boolean, boolean, boolean, boolean, boolean)

extendedFolderCopy

Specified by:

extendedFolderCopy in interface BaseFolder

Parameters:

uuid - the uuid

dstId - the dst id

newName - the new name

categories - the categories

keywords - the keywords

propertyGroups - the property groups

notes - the notes

wiki - the wiki

security - the security

Returns:

the folder

Throws:

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UserQuotaExceededException - the user quota exceeded exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

See Also:

extendedFolderCopy(String, String, String, boolean, boolean, boolean, boolean, boolean)

getContentInfo

public ContentInfo getContentInfo(String uuid)
                           throws AccessDeniedException,
                                  RepositoryException,
                                  PathNotFoundException,
                                  DatabaseException,
                                  UnknownException,
                                  WebserviceException

Description copied from interface: BaseFolder

Gets content info.

Specified by:

getContentInfo in interface BaseFolder

Parameters:

uuid - the uuid

Returns:

the content info

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

purgeFolder

public void purgeFolder(String uuid)
                 throws LockException,
                        PathNotFoundException,
                        AccessDeniedException,
                        RepositoryException,
                        DatabaseException,
                        PromotedAsRecordLockException,
                        UnknownException,
                        WebserviceException

Description copied from interface: BaseFolder

Purge folder.

Specified by:

purgeFolder in interface BaseFolder

Parameters:

uuid - the uuid

Throws:

LockException - the lock exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setStyle

public void setStyle(String uuid,
                     long styleId)
              throws VersionException,
                     PathNotFoundException,
                     AccessDeniedException,
                     RepositoryException,
                     DatabaseException,
                     UnknownException,
                     WebserviceException

Description copied from interface: BaseFolder

Sets style.

Specified by:

setStyle in interface BaseFolder

Parameters:

uuid - the uuid

styleId - the style id

Throws:

VersionException - the version exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

createMissingFolders

public void createMissingFolders(String fldPath)
                          throws RepositoryException,
                                 DatabaseException,
                                 PathNotFoundException,
                                 ItemExistsException,
                                 AccessDeniedException,
                                 AutomationException,
                                 PromotedAsRecordLockException,
                                 UnknownException,
                                 WebserviceException

Description copied from interface: BaseFolder

Create missing folders.

Specified by:

createMissingFolders in interface BaseFolder

Parameters:

fldPath - the fld path

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

AccessDeniedException - the access denied exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setFolderDescription

public void setFolderDescription(String uuid,
                                 String description)
                          throws AccessDeniedException,
                                 PathNotFoundException,
                                 DatabaseException,
                                 LockException,
                                 PromotedAsRecordLockException,
                                 UnknownException,
                                 WebserviceException

Description copied from interface: BaseFolder

Sets folder description.

Specified by:

setFolderDescription in interface BaseFolder

Parameters:

uuid - the uuid

description - the description

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

LockException - the lock exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

createFolderFromTemplate

public Folder createFolderFromTemplate(String uuid,
                                       String dstPath,
                                       boolean categories,
                                       boolean keywords,
                                       boolean notes,
                                       Map<String,String> properties)
                                throws PathNotFoundException,
                                       AccessDeniedException,
                                       RepositoryException,
                                       DatabaseException,
                                       TemplateException,
                                       DocumentTemplateException,
                                       ItemExistsException,
                                       AutomationException,
                                       FilePlanException,
                                       PromotedAsRecordLockException,
                                       ParseException,
                                       NoSuchGroupException,
                                       NoSuchPropertyException,
                                       LockException,
                                       ValidationFormException,
                                       ClassNotFoundException,
                                       UnknownException,
                                       WebserviceException

Description copied from interface: BaseFolder

Create folder from template folder.

Specified by:

createFolderFromTemplate in interface BaseFolder

Parameters:

uuid - the uuid

dstPath - the dst path

categories - the categories

keywords - the keywords

notes - the notes

properties - the properties

Returns:

the folder

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

TemplateException - the template exception

DocumentTemplateException - the document template exception

ItemExistsException - the item exists exception

AutomationException - the automation exception

FilePlanException - the file plan exception

PromotedAsRecordLockException - the promoted as record lock exception

ParseException - the parse exception

NoSuchGroupException - the no such group exception

NoSuchPropertyException - the no such property exception

LockException - the lock exception

ValidationFormException - the validation form exception

ClassNotFoundException - the class not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

createFolderFromTemplate

@Deprecated
public Folder createFolderFromTemplate(String uuid,
                                                   String dstPath,
                                                   String language,
                                                   boolean categories,
                                                   boolean keywords,
                                                   boolean propertyGroups,
                                                   boolean notes,
                                                   boolean wiki,
                                                   Map<String,String> properties)
                                            throws PathNotFoundException,
                                                   AccessDeniedException,
                                                   RepositoryException,
                                                   DatabaseException,
                                                   TemplateException,
                                                   DocumentTemplateException,
                                                   ItemExistsException,
                                                   AutomationException,
                                                   FilePlanException,
                                                   PromotedAsRecordLockException,
                                                   ParseException,
                                                   NoSuchGroupException,
                                                   NoSuchPropertyException,
                                                   LockException,
                                                   ValidationFormException,
                                                   ClassNotFoundException,
                                                   UnknownException,
                                                   WebserviceException

Deprecated. As of sdk4j 3.16, replaced by createFolderFromTemplate(String, String, boolean, boolean, boolean, Map)

createFolderFromTemplate

Specified by:

createFolderFromTemplate in interface BaseFolder

Parameters:

uuid - the uuid

dstPath - the dst path

language - the language

categories - the categories

keywords - the keywords

propertyGroups - the property groups

notes - the notes

wiki - the wiki

properties - the properties

Returns:

the folder

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

TemplateException - the template exception

DocumentTemplateException - the document template exception

ItemExistsException - the item exists exception

AutomationException - the automation exception

FilePlanException - the file plan exception

PromotedAsRecordLockException - the promoted as record lock exception

ParseException - the parse exception

NoSuchGroupException - the no such group exception

NoSuchPropertyException - the no such property exception

LockException - the lock exception

ValidationFormException - the validation form exception

ClassNotFoundException - the class not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

See Also:

createFolderFromTemplate(String, String, boolean, boolean, boolean, Map)