FolderImpl (OpenKM SDK for Java 3.9 API)

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

Constructors
Constructor and Description
`FolderImpl(String host)` FolderImpl

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Folder`	`copyFolder(String uuid, String dstId, String newName)`
`Folder`	`createFolder(String uuid, String name)`
`Folder`	`createFolderFromTemplate(String uuid, String dstPath, String language, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki, Map<String,String> properties)`
`void`	`createMissingFolders(String fldPath)`
`void`	`deleteFolder(String uuid)`
`Folder`	`extendedFolderCopy(String uuid, String dstId, String newName, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean wiki)`
`ContentInfo`	`getContentInfo(String uuid)`
`List<Folder>`	`getFolderChildren(String uuid)`
`String`	`getFolderPath(String uuid)`
`Folder`	`getFolderProperties(String uuid)`
`boolean`	`isValidFolder(String uuid)`
`void`	`moveFolder(String uuid, String dstId)`
`void`	`purgeFolder(String uuid)`
`void`	`renameFolder(String uuid, String newName)`
`void`	`setAuthorizationToken(String authorizationToken)` setAuthenticationToken
`void`	`setFolderDescription(String uuid, String description)`
`void`	`setStyle(String uuid, long styleId)`

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl
getClient, getClient, 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

Specified by:: createFolder in interface BaseFolder
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; ItemExistsException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

getFolderProperties

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

Specified by:: getFolderProperties in interface BaseFolder
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknownException; WebserviceException

deleteFolder

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

Specified by:: deleteFolder in interface BaseFolder
Throws:: AutomationException; LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

renameFolder

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

Specified by:: renameFolder in interface BaseFolder
Throws:: PathNotFoundException; ItemExistsException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

moveFolder

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

Specified by:: moveFolder in interface BaseFolder
Throws:: PathNotFoundException; ItemExistsException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

getFolderChildren

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

Specified by:: getFolderChildren in interface BaseFolder
Throws:: AccessDeniedException; PathNotFoundException; RepositoryException; DatabaseException; UnknownException; WebserviceException

isValidFolder

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

Specified by:: isValidFolder in interface BaseFolder
Throws:: PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

getFolderPath

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

Specified by:: getFolderPath in interface BaseFolder
Throws:: AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

copyFolder

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

Specified by:: copyFolder in interface BaseFolder
Throws:: PathNotFoundException; ItemExistsException; AccessDeniedException; RepositoryException; AutomationException; DatabaseException; UserQuotaExceededException; PromotedAsRecordLockException; UnknownException; WebserviceException

extendedFolderCopy

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

Specified by:: extendedFolderCopy in interface BaseFolder
Throws:: ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UserQuotaExceededException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

getContentInfo

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

Specified by:: getContentInfo in interface BaseFolder
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknownException; WebserviceException

purgeFolder

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

Specified by:: purgeFolder in interface BaseFolder
Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; PromotedAsRecordLockException; UnknownException; WebserviceException

setStyle

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

Specified by:: setStyle in interface BaseFolder
Throws:: VersionException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

createMissingFolders

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

Specified by:: createMissingFolders in interface BaseFolder
Throws:: RepositoryException; DatabaseException; PathNotFoundException; ItemExistsException; AccessDeniedException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

setFolderDescription

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

Specified by:: setFolderDescription in interface BaseFolder
Throws:: AccessDeniedException; PathNotFoundException; DatabaseException; LockException; PromotedAsRecordLockException; UnknownException; WebserviceException

createFolderFromTemplate

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

Specified by:: createFolderFromTemplate in interface BaseFolder
Throws:: PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; TemplateException; DocumentTemplateException; ItemExistsException; AutomationException; FilePlanException; PromotedAsRecordLockException; ParseException; NoSuchGroupException; NoSuchPropertyException; LockException; ValidationFormException; ClassNotFoundException; UnknownException; WebserviceException

Class FolderImpl

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

FolderImpl

Method Detail

setAuthorizationToken

createFolder

getFolderProperties

deleteFolder

renameFolder

moveFolder

getFolderChildren

isValidFolder

getFolderPath

copyFolder

extendedFolderCopy

getContentInfo

purgeFolder

setStyle

createMissingFolders

setFolderDescription

createFolderFromTemplate