BaseNode (OpenKM SDK for Java 3.11 API)

All Known Implementing Classes:

NodeImpl, OKMWebservices
```
public interface BaseNode
```
BaseNode

Author:

jllort

Method Summary

All Methods Instance Methods Abstract 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 orderByFiled, boolean orderAsc, List<Integer> filteredTypes)`
`SimpleNodeBaseList`	`getChildrenNodesPaginated(String uuid, int offset, int limit, String filter, String orderByFiled, boolean orderAsc, List<Integer> filteredTypes)`
`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`	`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)`

Method Detail

getNodeByUuid

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

Throws:: AccessDeniedException; PathNotFoundException; RepositoryException; DatabaseException; UnknownException; WebserviceException

getVersionHistory

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

Throws:: AccessDeniedException; PathNotFoundException; RepositoryException; DatabaseException; UnknownException; WebserviceException

restoreVersion

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

Throws:: AccessDeniedException; PathNotFoundException; LockException; RepositoryException; DatabaseException; ExtensionException; AutomationException; UnknownException; WebserviceException

purgeVersionHistory

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

Throws:: AccessDeniedException; PathNotFoundException; LockException; RepositoryException; DatabaseException; ExtensionException; UnknownException; WebserviceException

mayBePromotedAsRecord

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

Throws:: AccessDeniedException; PathNotFoundException; DatabaseException; FilePlanRecordManagerException; UnknownException; WebserviceException

promoteAsRecord

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

Throws:: PathNotFoundException; DatabaseException; FilePlanRecordManagerException; PromoteAsRecordException; UnknownException; WebserviceException

degradeRecord

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

Throws:: PathNotFoundException; DatabaseException; AccessDeniedException; LockException; UnknownException; WebserviceException

isElectronicRecordPath

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

Throws:: PathNotFoundException; DatabaseException; AccessDeniedException; WebserviceException; UnknownException

getElectronicRecordInPath

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

Throws:: PathNotFoundException; DatabaseException; AccessDeniedException; RepositoryException; WebserviceException; UnknownException

getChildrenNodesPaginated

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

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknownException; WebserviceException

getChildrenNodesByCategoryPaginated

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

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknownException; WebserviceException

getBreadcrumb

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

Throws:: PathNotFoundException; DatabaseException; AccessDeniedException; RepositoryException; WebserviceException; UnknownException

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

Throws:: PathNotFoundException; DatabaseException; AccessDeniedException; RepositoryException; WebserviceException; UnknownException; LockException

unsubscribe

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

Throws:: PathNotFoundException; DatabaseException; AccessDeniedException; RepositoryException; WebserviceException; UnknownException; LockException

importZip

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

Throws:: UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

unZip

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

Throws:: UnsupportedMimeTypeException; FileSizeExceededException; UserQuotaExceededException; VirusDetectedException; ItemExistsException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; ExtensionException; AutomationException; PromotedAsRecordLockException; UnknownException; WebserviceException

exportZip

InputStream exportZip(List<String> uuids,
                      boolean background)
               throws PathNotFoundException,
                      DatabaseException,
                      AccessDeniedException,
                      RepositoryException,
                      WebserviceException,
                      UnknownException,
                      LockException,
                      ConversionException

Throws:: PathNotFoundException; DatabaseException; AccessDeniedException; RepositoryException; WebserviceException; UnknownException; LockException; ConversionException

getNodesFiltered

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

Throws:: WebserviceException; UnsupportedEncodingException; UnknownException

evaluateDownloadZip

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

Throws:: WebserviceException; UnsupportedEncodingException; UnknownException

generateDownloadToken

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

Throws:: PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

restore

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

Throws:: AccessDeniedException; PathNotFoundException; RepositoryException; DatabaseException; UnknownException; WebserviceException

hasNodesLockedByOtherUser

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

Throws:: WebserviceException; PathNotFoundException; DatabaseException; AccessDeniedException; UnknownException

lockNode

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

Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

forceLockNode

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

Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

unlockNode

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

Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

forceUnlockNode

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

Throws:: LockException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

isLocked

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

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; DatabaseException; UnknownException; WebserviceException

getLockInfo

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

Throws:: AccessDeniedException; RepositoryException; PathNotFoundException; LockException; DatabaseException; UnknownException; WebserviceException

setComment

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

Throws:: VersionException; DatabaseException; AccessDeniedException; WebserviceException; UnknownException; PathNotFoundException

Interface BaseNode

Method Summary

Method Detail

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