BaseNode (OpenKM SDK for Java 3.7 API)

All Known Subinterfaces:

OKMWebservices

All Known Implementing Classes:

NodeImpl, OKMWebservice30
```
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)`
`String`	`generateDownloadToken(String uuid, boolean preview)`
`List<BreadCrumbItem>`	`getBreadcrumb(String uuid)`
`ChildNodeList`	`getChildrenNodesByCategoryPaginated(String uuid, int offset, int limit, String filter, String orderByFiled, boolean orderAsc, List<Integer> filteredTypes)`
`ChildNodeList`	`getChildrenNodesPaginated(String uuid, int offset, int limit, String filter, String orderByFiled, boolean orderAsc, List<Integer> filteredTypes)`
`Record`	`getElectronicRecordInPath(String uuid)`
`Node`	`getNodeByUuid(String uuid)`
`List<Node>`	`getNodesFiltered(List<String> uuids)`
`List<Version>`	`getVersionHistory(String uuid)`
`void`	`importZip(String uuid, InputStream is)`
`boolean`	`isElectronicRecordPath(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`	`subscribe(String uuid)`
`void`	`unsubscribe(String uuid)`
`void`	`unZip(String uuid, String dstId)`

Method Detail

getNodeByUuid

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

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

getVersionHistory

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

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

restoreVersion

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

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

purgeVersionHistory

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

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

mayBePromotedAsRecord

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

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

promoteAsRecord

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

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

degradeRecord

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

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

isElectronicRecordPath

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

Throws:: PathNotFoundException; DatabaseException; AccessDeniedException; WebserviceException; UnknowException

getElectronicRecordInPath

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

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

getChildrenNodesPaginated

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

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

getChildrenNodesByCategoryPaginated

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

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

getBreadcrumb

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

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

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

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

unsubscribe

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

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

importZip

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

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

unZip

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

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

exportZip

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

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

getNodesFiltered

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

Throws:: WebserviceException; UnsupportedEncodingException; UnknowException

evaluateDownloadZip

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

Throws:: WebserviceException; UnsupportedEncodingException; UnknowException

generateDownloadToken

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

Throws:: IOException; PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknowException; WebserviceException

restore

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

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

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