NodeImpl (OpenKM SDK for Java 3.12 API)

java.lang.Object
- com.openkm.sdk4j.impl.ClientImpl
- - com.openkm.sdk4j.impl.NodeImpl

All Implemented Interfaces:

BaseNode, Serializable
```
public class NodeImpl
extends ClientImpl
implements BaseNode, Serializable
```
NodeImpl

Author:

jllort

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

NodeImpl(String host)
BaseNodeImpl

Constructors
Constructor and Description
`NodeImpl(String host)` BaseNodeImpl

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`degradeRecord(String uuid)`
`ZipDownloadEvaluationResult`	`evaluateDownloadZip(List<String> uuids)`
`InputStream`	`exportZip(List<String> uuids, boolean background)`
`LockInfo`	`forceLockNode(String uuid)`
`void`	`forceUnlockNode(String uuid)`
`String`	`generateDownloadToken(String uuid, boolean preview)`
`List<BreadCrumbItem>`	`getBreadcrumb(String uuid)`
`SimpleNodeBaseList`	`getChildrenNodesByCategoryPaginated(String uuid, int offset, int limit, String filter, String orderByField, boolean orderAsc, List<Integer> filteredTypes)`
`SimpleNodeBaseList`	`getChildrenNodesPaginated(String uuid, int offset, int limit, String filter, String orderByField, boolean orderAsc, List<Integer> filteredTypes, String pluginName)`
`Record`	`getElectronicRecordInPath(String uuid)`
`LockInfo`	`getLockInfo(String uuid)`
`Node`	`getNodeByUuid(String uuid)`
`List<Node>`	`getNodesFiltered(List<String> uuids)`
`List<Version>`	`getVersionHistory(String uuid)`
`boolean`	`hasNodesLockedByOtherUser(String uuid)`
`void`	`importZip(String uuid, InputStream is)`
`boolean`	`isElectronicRecordPath(String uuid)`
`boolean`	`isLocked(String uuid)`
`LockInfo`	`lockNode(String uuid)`
`PromoteAsRecordEvaluation`	`mayBePromotedAsRecord(String uuid, boolean fullEvaluation)`
`void`	`promoteAsRecord(String uuid)`
`void`	`purgeVersionHistory(String uuid)`
`Node`	`restore(String uuid)`
`void`	`restoreVersion(String uuid, String versionName)`
`void`	`setAuthorizationToken(String authorizationToken)` setAuthenticationToken
`void`	`setComment(String uuid, String versionName, String comment)`
`void`	`subscribe(String uuid)`
`void`	`unlockNode(String uuid)`
`void`	`unsubscribe(String uuid)`
`void`	`unZip(String uuid, String dstId)`

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl
getClient, resource, resource

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- NodeImpl
```
public NodeImpl(String host)
```
  BaseNodeImpl

Method Detail

setAuthorizationToken

public void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

getNodeByUuid

public Node getNodeByUuid(String uuid)
                   throws AccessDeniedException,
                          PathNotFoundException,
                          RepositoryException,
                          DatabaseException,
                          UnknownException,
                          WebserviceException

Specified by:: getNodeByUuid in interface BaseNode
Throws:: AccessDeniedException; PathNotFoundException; RepositoryException; DatabaseException; UnknownException; WebserviceException

getVersionHistory

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

Specified by:: getVersionHistory in interface BaseNode
Throws:: AccessDeniedException; PathNotFoundException; RepositoryException; DatabaseException; UnknownException; WebserviceException

restoreVersion

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

Specified by:: restoreVersion in interface BaseNode
Throws:: AccessDeniedException; PathNotFoundException; LockException; RepositoryException; DatabaseException; ExtensionException; AutomationException; UnknownException; WebserviceException

purgeVersionHistory

public void purgeVersionHistory(String uuid)
                         throws AccessDeniedException,
                                PathNotFoundException,
                                LockException,
                                RepositoryException,
                                DatabaseException,
                                ExtensionException,
                                UnknownException,
                                WebserviceException

Specified by:: purgeVersionHistory in interface BaseNode
Throws:: AccessDeniedException; PathNotFoundException; LockException; RepositoryException; DatabaseException; ExtensionException; UnknownException; WebserviceException

mayBePromotedAsRecord

public PromoteAsRecordEvaluation mayBePromotedAsRecord(String uuid,
                                                       boolean fullEvaluation)
                                                throws AccessDeniedException,
                                                       PathNotFoundException,
                                                       DatabaseException,
                                                       FilePlanRecordManagerException,
                                                       UnknownException,
                                                       WebserviceException

Specified by:: mayBePromotedAsRecord in interface BaseNode
Throws:: AccessDeniedException; PathNotFoundException; DatabaseException; FilePlanRecordManagerException; UnknownException; WebserviceException

promoteAsRecord

public void promoteAsRecord(String uuid)
                     throws PathNotFoundException,
                            DatabaseException,
                            FilePlanRecordManagerException,
                            UnknownException,
                            WebserviceException,
                            PromoteAsRecordException

Specified by:: promoteAsRecord in interface BaseNode
Throws:: PathNotFoundException; DatabaseException; FilePlanRecordManagerException; UnknownException; WebserviceException; PromoteAsRecordException

degradeRecord

public void degradeRecord(String uuid)
                   throws PathNotFoundException,
                          DatabaseException,
                          AccessDeniedException,
                          LockException,
                          UnknownException,
                          WebserviceException

Specified by:: degradeRecord in interface BaseNode
Throws:: PathNotFoundException; DatabaseException; AccessDeniedException; LockException; UnknownException; WebserviceException

isElectronicRecordPath

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

Specified by:: isElectronicRecordPath in interface BaseNode
Throws:: PathNotFoundException; DatabaseException; AccessDeniedException; WebserviceException; UnknownException

getElectronicRecordInPath

public Record getElectronicRecordInPath(String uuid)
                                 throws PathNotFoundException,
                                        DatabaseException,
                                        AccessDeniedException,
                                        RepositoryException,
                                        WebserviceException,
                                        UnknownException

Specified by:: getElectronicRecordInPath in interface BaseNode
Throws:: PathNotFoundException; DatabaseException; AccessDeniedException; RepositoryException; WebserviceException; UnknownException

getChildrenNodesPaginated

public SimpleNodeBaseList getChildrenNodesPaginated(String uuid,
                                                    int offset,
                                                    int limit,
                                                    String filter,
                                                    String orderByField,
                                                    boolean orderAsc,
                                                    List<Integer> filteredTypes,
                                                    String pluginName)
                                             throws AccessDeniedException,
                                                    RepositoryException,
                                                    PathNotFoundException,
                                                    DatabaseException,
                                                    UnknownException,
                                                    WebserviceException

Specified by:: getChildrenNodesPaginated in interface BaseNode
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknownException; WebserviceException

getChildrenNodesByCategoryPaginated

public SimpleNodeBaseList getChildrenNodesByCategoryPaginated(String uuid,
                                                              int offset,
                                                              int limit,
                                                              String filter,
                                                              String orderByField,
                                                              boolean orderAsc,
                                                              List<Integer> filteredTypes)
                                                       throws AccessDeniedException,
                                                              RepositoryException,
                                                              PathNotFoundException,
                                                              DatabaseException,
                                                              UnknownException,
                                                              WebserviceException

Specified by:: getChildrenNodesByCategoryPaginated in interface BaseNode
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknownException; WebserviceException

getBreadcrumb

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

Specified by:: getBreadcrumb in interface BaseNode
Throws:: PathNotFoundException; DatabaseException; AccessDeniedException; RepositoryException; WebserviceException; UnknownException

public void subscribe(String uuid)
               throws PathNotFoundException,
                      DatabaseException,
                      AccessDeniedException,
                      WebserviceException,
                      UnknownException,
                      LockException

Specified by:: subscribe in interface BaseNode
Throws:: PathNotFoundException; DatabaseException; AccessDeniedException; WebserviceException; UnknownException; LockException

unsubscribe

public void unsubscribe(String uuid)
                 throws PathNotFoundException,
                        DatabaseException,
                        AccessDeniedException,
                        WebserviceException,
                        UnknownException,
                        LockException

Specified by:: unsubscribe in interface BaseNode
Throws:: PathNotFoundException; DatabaseException; AccessDeniedException; WebserviceException; UnknownException; LockException

importZip

public void importZip(String uuid,
                      InputStream is)
               throws UnsupportedMimeTypeException,
                      FileSizeExceededException,
                      UserQuotaExceededException,
                      VirusDetectedException,
                      ItemExistsException,
                      PathNotFoundException,
                      AccessDeniedException,
                      RepositoryException,
                      DatabaseException,
                      ExtensionException,
                      AutomationException,
                      PromotedAsRecordLockException,
                      UnknownException,
                      WebserviceException

Specified by:: importZip in interface BaseNode
Throws:: UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

unZip

public void unZip(String uuid,
                  String dstId)
           throws UnsupportedMimeTypeException,
                  FileSizeExceededException,
                  UserQuotaExceededException,
                  VirusDetectedException,
                  ItemExistsException,
                  PathNotFoundException,
                  AccessDeniedException,
                  RepositoryException,
                  DatabaseException,
                  ExtensionException,
                  AutomationException,
                  PromotedAsRecordLockException,
                  UnknownException,
                  WebserviceException

Specified by:: unZip in interface BaseNode
Throws:: UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

exportZip

public InputStream exportZip(List<String> uuids,
                             boolean background)
                      throws WebserviceException,
                             UnknownException,
                             ConversionException

Specified by:: exportZip in interface BaseNode
Throws:: WebserviceException; UnknownException; ConversionException

getNodesFiltered

public List<Node> getNodesFiltered(List<String> uuids)
                            throws WebserviceException,
                                   UnsupportedEncodingException,
                                   UnknownException

Specified by:: getNodesFiltered in interface BaseNode
Throws:: WebserviceException; UnsupportedEncodingException; UnknownException

evaluateDownloadZip

public ZipDownloadEvaluationResult evaluateDownloadZip(List<String> uuids)
                                                throws WebserviceException,
                                                       UnknownException

Specified by:: evaluateDownloadZip in interface BaseNode
Throws:: WebserviceException; UnknownException

generateDownloadToken

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

Specified by:: generateDownloadToken in interface BaseNode
Throws:: PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

restore

public Node restore(String uuid)
             throws AccessDeniedException,
                    PathNotFoundException,
                    RepositoryException,
                    DatabaseException,
                    UnknownException,
                    WebserviceException

Specified by:: restore in interface BaseNode
Throws:: AccessDeniedException; PathNotFoundException; RepositoryException; DatabaseException; UnknownException; WebserviceException

hasNodesLockedByOtherUser

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

Specified by:: hasNodesLockedByOtherUser in interface BaseNode
Throws:: WebserviceException; PathNotFoundException; DatabaseException; AccessDeniedException; UnknownException

lockNode

public LockInfo lockNode(String uuid)
                  throws LockException,
                         PathNotFoundException,
                         AccessDeniedException,
                         RepositoryException,
                         DatabaseException,
                         UnknownException,
                         WebserviceException

Specified by:: lockNode in interface BaseNode
Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

forceLockNode

public LockInfo forceLockNode(String uuid)
                       throws LockException,
                              PathNotFoundException,
                              AccessDeniedException,
                              RepositoryException,
                              DatabaseException,
                              UnknownException,
                              WebserviceException

Specified by:: forceLockNode in interface BaseNode
Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

unlockNode

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

Specified by:: unlockNode in interface BaseNode
Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

forceUnlockNode

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

Specified by:: forceUnlockNode in interface BaseNode
Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

isLocked

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

Specified by:: isLocked in interface BaseNode
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknownException; WebserviceException

getLockInfo

public LockInfo getLockInfo(String uuid)
                     throws AccessDeniedException,
                            RepositoryException,
                            PathNotFoundException,
                            LockException,
                            DatabaseException,
                            UnknownException,
                            WebserviceException

Specified by:: getLockInfo in interface BaseNode
Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; LockException; DatabaseException; UnknownException; WebserviceException

setComment

public void setComment(String uuid,
                       String versionName,
                       String comment)
                throws VersionException,
                       DatabaseException,
                       AccessDeniedException,
                       WebserviceException,
                       UnknownException,
                       PathNotFoundException

Specified by:: setComment in interface BaseNode
Throws:: VersionException; DatabaseException; AccessDeniedException; WebserviceException; UnknownException; PathNotFoundException

Class NodeImpl

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

NodeImpl

Method Detail

setAuthorizationToken

getNodeByUuid

getVersionHistory

restoreVersion

purgeVersionHistory

mayBePromotedAsRecord

promoteAsRecord

degradeRecord

isElectronicRecordPath

getElectronicRecordInPath

getChildrenNodesPaginated

getChildrenNodesByCategoryPaginated

getBreadcrumb

subscribe

unsubscribe

importZip

unZip

exportZip

getNodesFiltered

evaluateDownloadZip

generateDownloadToken

restore

hasNodesLockedByOtherUser

lockNode

forceLockNode

unlockNode

forceUnlockNode

isLocked

getLockInfo

setComment