com.openkm.sdk4j.definition

Interface BaseNode

All Known Implementing Classes:

NodeImpl, OKMWebservices

public interface BaseNode

BaseNode

Author:

jllort

Method Summary

Modifier and Type	Method and Description
void	degradeRecord(String uuid) Degrade record.
ZipDownloadEvaluationResult	evaluateDownloadZip(List<String> uuids) Evaluate download zip zip download evaluation result.
InputStream	exportZip(List<String> uuids, boolean background) Export zip input stream.
InputStream	exportZip(List<String> uuids, boolean withPath, boolean background) Export zip input stream.
LockInfo	forceLockNode(String uuid) Force lock node lock info.
void	forceUnlockNode(String uuid) Force unlock node.
String	generateDownloadToken(String uuid, boolean preview) Deprecated.
String	generateDownloadToken(String uuid, boolean preview, boolean oneTimeUse, Calendar validUntil) Generate download token string.
List<BreadCrumbItem>	getBreadcrumb(String uuid) Gets breadcrumb.
SimpleNodeBaseList	getChildrenNodesByCategoryPaginated(String uuid, int offset, int limit, String filter, String orderByField, boolean orderAsc, List<Integer> filteredTypes) Gets children nodes by category paginated.
SimpleNodeBaseList	getChildrenNodesByCategoryPaginated(String uuid, int offset, int limit, String filter, String orderByField, boolean orderAsc, List<Integer> filteredTypes, String pluginName) Gets children nodes by category paginated.
SimpleNodeBaseList	getChildrenNodesPaginated(String uuid, int offset, int limit, String filter, String orderByField, boolean orderAsc, List<Integer> filteredTypes) Gets children nodes paginated.
SimpleNodeBaseList	getChildrenNodesPaginated(String uuid, int offset, int limit, String filter, String orderByField, boolean orderAsc, List<Integer> filteredTypes, String pluginName) Gets children nodes paginated.
Record	getElectronicRecordInPath(String uuid) Gets electronic record in path.
LockInfo	getLockInfo(String uuid) Gets lock info.
Node	getNodeByUuid(String uuid) Gets node by uuid.
List<Node>	getNodesFiltered(List<String> uuids) Gets nodes filtered.
NodePaginatorConfig	getPaginatorConfig(String pluginName) Gets paginator config.
PaginatorPluginList	getPaginatorPlugins() Gets paginator plugins.
List<Version>	getVersionHistory(String uuid) Gets version history.
boolean	hasNodesLockedByOtherUser(String uuid) Has nodes locked by other user boolean.
void	importZip(String uuid, InputStream is) Import zip.
boolean	isElectronicRecordPath(String uuid) Is electronic record path boolean.
boolean	isLocked(String uuid) Is locked boolean.
LockInfo	lockNode(String uuid) Lock node lock info.
PromoteAsRecordEvaluation	mayBePromotedAsRecord(String uuid, boolean fullEvaluation) May be promoted as record promote as record evaluation.
void	promoteAsRecord(String uuid) Promote as record.
void	purgeVersionHistory(String uuid) Purge version history.
Node	restore(String uuid) Restore node.
void	restoreVersion(String uuid, String versionName) Restore version.
void	setComment(String uuid, String versionName, String comment) Sets comment.
void	subscribe(String uuid) Subscribe.
void	unlockNode(String uuid) Unlock node.
void	unsubscribe(String uuid) Unsubscribe.
void	unZip(String uuid, String dstId) Un zip.

Method Detail

getNodeByUuid

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

Gets node by uuid.

Parameters:

uuid - the uuid

Returns:

the node by uuid

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

getVersionHistory

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

Gets version history.

Parameters:

uuid - the uuid

Returns:

the version history

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

restoreVersion

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

Restore version.

Parameters:

uuid - the uuid

versionName - the version name

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

LockException - the lock exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

AutomationException - the automation exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

purgeVersionHistory

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

Purge version history.

Parameters:

uuid - the uuid

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

LockException - the lock exception

RepositoryException - the repository exception

DatabaseException - the database exception

ExtensionException - the extension exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

mayBePromotedAsRecord

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

May be promoted as record promote as record evaluation.

Parameters:

uuid - the uuid

fullEvaluation - the full evaluation

Returns:

the promote as record evaluation

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

FilePlanRecordManagerException - the file plan record manager exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

promoteAsRecord

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

Promote as record.

Parameters:

uuid - the uuid

Throws:

PathNotFoundException - the path not found exception

DatabaseException - the database exception

FilePlanRecordManagerException - the file plan record manager exception

PromoteAsRecordException - the promote as record exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

degradeRecord

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

Degrade record.

Parameters:

uuid - the uuid

Throws:

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

LockException - the lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

isElectronicRecordPath

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

Is electronic record path boolean.

Parameters:

uuid - the uuid

Returns:

the boolean

Throws:

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getElectronicRecordInPath

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

Gets electronic record in path.

Parameters:

uuid - the uuid

Returns:

the electronic record in path

Throws:

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

getChildrenNodesPaginated

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

Gets children nodes paginated.

Parameters:

uuid - the uuid

offset - the offset

limit - the limit

filter - the filter

orderByField - the order by field

orderAsc - the order asc

filteredTypes - the filtered types

Returns:

the children nodes paginated

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

getChildrenNodesPaginated

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

Gets children nodes paginated.

Parameters:

uuid - the uuid

offset - the offset

limit - the limit

filter - the filter

orderByField - the order by field

orderAsc - the order asc

filteredTypes - the filtered types

pluginName - the plugin name

Returns:

the children nodes paginated

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

getChildrenNodesByCategoryPaginated

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

Gets children nodes by category paginated.

Parameters:

uuid - the uuid

offset - the offset

limit - the limit

filter - the filter

orderByField - the order by field

orderAsc - the order asc

filteredTypes - the filtered types

Returns:

the children nodes by category paginated

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

getChildrenNodesByCategoryPaginated

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

Gets children nodes by category paginated.

Parameters:

uuid - the uuid

offset - the offset

limit - the limit

filter - the filter

orderByField - the order by field

orderAsc - the order asc

filteredTypes - the filtered types

pluginName - the plugin name

Returns:

the children nodes by category paginated

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

getBreadcrumb

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

Gets breadcrumb.

Parameters:

uuid - the uuid

Returns:

the breadcrumb

Throws:

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

subscribe

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

Subscribe.

Parameters:

uuid - the uuid

Throws:

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

LockException - the lock exception

unsubscribe

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

Unsubscribe.

Parameters:

uuid - the uuid

Throws:

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

LockException - the lock exception

importZip

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

Import zip.

Parameters:

uuid - the uuid

is - the is

Throws:

UnsupportedMimeTypeException - the unsupported mime type exception

FileSizeExceededException - the file size exceeded exception

UserQuotaExceededException - the user quota exceeded exception

VirusDetectedException - the virus detected exception

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository 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

unZip

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

Un zip.

Parameters:

uuid - the uuid

dstId - the dst id

Throws:

UnsupportedMimeTypeException - the unsupported mime type exception

FileSizeExceededException - the file size exceeded exception

UserQuotaExceededException - the user quota exceeded exception

VirusDetectedException - the virus detected exception

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository 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

exportZip

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

Export zip input stream.

Parameters:

uuids - the uuids

background - the background

Returns:

the input stream

Throws:

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

LockException - the lock exception

ConversionException - the conversion exception

exportZip

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

Export zip input stream.

Parameters:

uuids - the uuids

withPath - the withPath

background - the background

Returns:

the input stream

Throws:

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

LockException - the lock exception

ConversionException - the conversion exception

getNodesFiltered

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

Gets nodes filtered.

Parameters:

uuids - the uuids

Returns:

the nodes filtered

Throws:

WebserviceException - the webservice exception

UnsupportedEncodingException - the unsupported encoding exception

UnknownException - the unknown exception

evaluateDownloadZip

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

Evaluate download zip zip download evaluation result.

Parameters:

uuids - the uuids

Returns:

the zip download evaluation result

Throws:

WebserviceException - the webservice exception

UnsupportedEncodingException - the unsupported encoding exception

UnknownException - the unknown exception

generateDownloadToken

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

Deprecated.

Generate download token string.

Parameters:

uuid - the uuid

preview - the preview

Returns:

the string

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

generateDownloadToken

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

Generate download token string.

Parameters:

uuid - the uuid

preview - the preview

oneTimeUse - when true the token can only be used one time

validUntil - when set the token will be valid until this date

Returns:

the string

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

restore

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

Restore node.

Parameters:

uuid - the uuid

Returns:

the node

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

hasNodesLockedByOtherUser

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

Has nodes locked by other user boolean.

Parameters:

uuid - the uuid

Returns:

the boolean

Throws:

WebserviceException - the webservice exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

UnknownException - the unknown exception

lockNode

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

Lock node lock info.

Parameters:

uuid - the uuid

Returns:

the lock info

Throws:

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

forceLockNode

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

Force lock node lock info.

Parameters:

uuid - the uuid

Returns:

the lock info

Throws:

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

unlockNode

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

Unlock node.

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

UnknownException - the unknown exception

WebserviceException - the webservice exception

forceUnlockNode

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

Force unlock node.

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

UnknownException - the unknown exception

WebserviceException - the webservice exception

isLocked

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

Is locked boolean.

Parameters:

uuid - the uuid

Returns:

the boolean

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

getLockInfo

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

Gets lock info.

Parameters:

uuid - the uuid

Returns:

the lock info

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

LockException - the lock exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setComment

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

Sets comment.

Parameters:

uuid - the uuid

versionName - the version name

comment - the comment

Throws:

VersionException - the version exception

DatabaseException - the database exception

AccessDeniedException - the access denied exception

WebserviceException - the webservice exception

UnknownException - the unknown exception

PathNotFoundException - the path not found exception

getPaginatorConfig

NodePaginatorConfig getPaginatorConfig(String pluginName)
                                throws UnknownException,
                                       WebserviceException

Gets paginator config.

Parameters:

pluginName - the plugin name

Returns:

the paginator config

Throws:

UnknownException - the unknown exception

WebserviceException - the webservice exception

getPaginatorPlugins

PaginatorPluginList getPaginatorPlugins()
                                 throws UnknownException,
                                        WebserviceException

Gets paginator plugins.

Returns:

the paginator plugins

Throws:

UnknownException - the unknown exception

WebserviceException - the webservice exception