public class NodeImpl extends ClientImpl implements BaseNode, Serializable
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)
Deprecated.
As of sdk4j 3.17, replaced by
exportZip(List, boolean, boolean) |
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)
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.
|
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 |
setAuthorizationToken(String authorizationToken)
setAuthenticationToken
|
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.
|
getClient, resource, resource
public NodeImpl(String host)
public void setAuthorizationToken(String authorizationToken)
public Node getNodeByUuid(String uuid) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException, UnknownException, WebserviceException
BaseNode
getNodeByUuid
in interface BaseNode
uuid
- the uuidAccessDeniedException
- the access denied exceptionPathNotFoundException
- the path not found exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic List<Version> getVersionHistory(String uuid) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException, UnknownException, WebserviceException
BaseNode
getVersionHistory
in interface BaseNode
uuid
- the uuidAccessDeniedException
- the access denied exceptionPathNotFoundException
- the path not found exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic void restoreVersion(String uuid, String versionName) throws AccessDeniedException, PathNotFoundException, LockException, RepositoryException, DatabaseException, ExtensionException, AutomationException, UnknownException, WebserviceException
BaseNode
restoreVersion
in interface BaseNode
uuid
- the uuidversionName
- the version nameAccessDeniedException
- the access denied exceptionPathNotFoundException
- the path not found exceptionLockException
- the lock exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionExtensionException
- the extension exceptionAutomationException
- the automation exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic void purgeVersionHistory(String uuid) throws AccessDeniedException, PathNotFoundException, LockException, RepositoryException, DatabaseException, ExtensionException, UnknownException, WebserviceException
BaseNode
purgeVersionHistory
in interface BaseNode
uuid
- the uuidAccessDeniedException
- the access denied exceptionPathNotFoundException
- the path not found exceptionLockException
- the lock exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionExtensionException
- the extension exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic PromoteAsRecordEvaluation mayBePromotedAsRecord(String uuid, boolean fullEvaluation) throws AccessDeniedException, PathNotFoundException, DatabaseException, FilePlanRecordManagerException, UnknownException, WebserviceException
BaseNode
mayBePromotedAsRecord
in interface BaseNode
uuid
- the uuidfullEvaluation
- the full evaluationAccessDeniedException
- the access denied exceptionPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionFilePlanRecordManagerException
- the file plan record manager exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic void promoteAsRecord(String uuid) throws PathNotFoundException, DatabaseException, FilePlanRecordManagerException, UnknownException, WebserviceException, PromoteAsRecordException
BaseNode
promoteAsRecord
in interface BaseNode
uuid
- the uuidPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionFilePlanRecordManagerException
- the file plan record manager exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionPromoteAsRecordException
- the promote as record exceptionpublic void degradeRecord(String uuid) throws PathNotFoundException, DatabaseException, AccessDeniedException, LockException, UnknownException, WebserviceException
BaseNode
degradeRecord
in interface BaseNode
uuid
- the uuidPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionAccessDeniedException
- the access denied exceptionLockException
- the lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic boolean isElectronicRecordPath(String uuid) throws PathNotFoundException, DatabaseException, AccessDeniedException, WebserviceException, UnknownException
BaseNode
isElectronicRecordPath
in interface BaseNode
uuid
- the uuidPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionAccessDeniedException
- the access denied exceptionWebserviceException
- the webservice exceptionUnknownException
- the unknown exceptionpublic Record getElectronicRecordInPath(String uuid) throws PathNotFoundException, DatabaseException, AccessDeniedException, RepositoryException, WebserviceException, UnknownException
BaseNode
getElectronicRecordInPath
in interface BaseNode
uuid
- the uuidPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionWebserviceException
- the webservice exceptionUnknownException
- the unknown exceptionpublic SimpleNodeBaseList getChildrenNodesPaginated(String uuid, int offset, int limit, String filter, String orderByField, boolean orderAsc, List<Integer> filteredTypes) throws AccessDeniedException, RepositoryException, PathNotFoundException, DatabaseException, UnknownException, WebserviceException
BaseNode
getChildrenNodesPaginated
in interface BaseNode
uuid
- the uuidoffset
- the offsetlimit
- the limitfilter
- the filterorderByField
- the order by fieldorderAsc
- the order ascfilteredTypes
- the filtered typesAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic 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
BaseNode
getChildrenNodesPaginated
in interface BaseNode
uuid
- the uuidoffset
- the offsetlimit
- the limitfilter
- the filterorderByField
- the order by fieldorderAsc
- the order ascfilteredTypes
- the filtered typespluginName
- the plugin nameAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic SimpleNodeBaseList getChildrenNodesByCategoryPaginated(String uuid, int offset, int limit, String filter, String orderByField, boolean orderAsc, List<Integer> filteredTypes) throws AccessDeniedException, RepositoryException, PathNotFoundException, DatabaseException, UnknownException, WebserviceException
BaseNode
getChildrenNodesByCategoryPaginated
in interface BaseNode
uuid
- the uuidoffset
- the offsetlimit
- the limitfilter
- the filterorderByField
- the order by fieldorderAsc
- the order ascfilteredTypes
- the filtered typesAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic 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
BaseNode
getChildrenNodesByCategoryPaginated
in interface BaseNode
uuid
- the uuidoffset
- the offsetlimit
- the limitfilter
- the filterorderByField
- the order by fieldorderAsc
- the order ascfilteredTypes
- the filtered typespluginName
- the plugin nameAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic List<BreadCrumbItem> getBreadcrumb(String uuid) throws PathNotFoundException, DatabaseException, AccessDeniedException, RepositoryException, WebserviceException, UnknownException
BaseNode
getBreadcrumb
in interface BaseNode
uuid
- the uuidPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionWebserviceException
- the webservice exceptionUnknownException
- the unknown exceptionpublic void subscribe(String uuid) throws PathNotFoundException, DatabaseException, AccessDeniedException, WebserviceException, UnknownException, LockException
BaseNode
subscribe
in interface BaseNode
uuid
- the uuidPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionAccessDeniedException
- the access denied exceptionWebserviceException
- the webservice exceptionUnknownException
- the unknown exceptionLockException
- the lock exceptionpublic void unsubscribe(String uuid) throws PathNotFoundException, DatabaseException, AccessDeniedException, WebserviceException, UnknownException, LockException
BaseNode
unsubscribe
in interface BaseNode
uuid
- the uuidPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionAccessDeniedException
- the access denied exceptionWebserviceException
- the webservice exceptionUnknownException
- the unknown exceptionLockException
- the lock exceptionpublic void importZip(String uuid, InputStream is) throws UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
BaseNode
importZip
in interface BaseNode
uuid
- the uuidis
- the isUnsupportedMimeTypeException
- the unsupported mime type exceptionFileSizeExceededException
- the file size exceeded exceptionUserQuotaExceededException
- the user quota exceeded exceptionVirusDetectedException
- the virus detected exceptionItemExistsException
- the item exists exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionExtensionException
- the extension exceptionAutomationException
- the automation exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic void unZip(String uuid, String dstId) throws UnsupportedMimeTypeException, FileSizeExceededException, UserQuotaExceededException, VirusDetectedException, ItemExistsException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, ExtensionException, AutomationException, PromotedAsRecordLockException, UnknownException, WebserviceException
BaseNode
unZip
in interface BaseNode
uuid
- the uuiddstId
- the dst idUnsupportedMimeTypeException
- the unsupported mime type exceptionFileSizeExceededException
- the file size exceeded exceptionUserQuotaExceededException
- the user quota exceeded exceptionVirusDetectedException
- the virus detected exceptionItemExistsException
- the item exists exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionExtensionException
- the extension exceptionAutomationException
- the automation exceptionPromotedAsRecordLockException
- the promoted as record lock exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exception@Deprecated public InputStream exportZip(List<String> uuids, boolean background) throws WebserviceException, UnknownException, ConversionException
exportZip(List, boolean, boolean)
exportZip
in interface BaseNode
uuids
- the uuidsbackground
- the backgroundWebserviceException
- the webservice exceptionUnknownException
- the unknown exceptionConversionException
- the conversion exceptionexportZip(List, boolean, boolean)
public InputStream exportZip(List<String> uuids, boolean withPath, boolean background) throws WebserviceException, UnknownException, ConversionException
BaseNode
exportZip
in interface BaseNode
uuids
- the uuidswithPath
- the withPathbackground
- the backgroundWebserviceException
- the webservice exceptionUnknownException
- the unknown exceptionConversionException
- the conversion exceptionpublic List<Node> getNodesFiltered(List<String> uuids) throws WebserviceException, UnsupportedEncodingException, UnknownException
BaseNode
getNodesFiltered
in interface BaseNode
uuids
- the uuidsWebserviceException
- the webservice exceptionUnsupportedEncodingException
- the unsupported encoding exceptionUnknownException
- the unknown exceptionpublic ZipDownloadEvaluationResult evaluateDownloadZip(List<String> uuids) throws WebserviceException, UnknownException
BaseNode
evaluateDownloadZip
in interface BaseNode
uuids
- the uuidsWebserviceException
- the webservice exceptionUnknownException
- the unknown exceptionpublic String generateDownloadToken(String uuid, boolean preview) throws PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, UnknownException, WebserviceException
BaseNode
generateDownloadToken
in interface BaseNode
uuid
- the uuidpreview
- the previewPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic Node restore(String uuid) throws AccessDeniedException, PathNotFoundException, RepositoryException, DatabaseException, UnknownException, WebserviceException
BaseNode
restore
in interface BaseNode
uuid
- the uuidAccessDeniedException
- the access denied exceptionPathNotFoundException
- the path not found exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic boolean hasNodesLockedByOtherUser(String uuid) throws WebserviceException, PathNotFoundException, DatabaseException, AccessDeniedException, UnknownException
BaseNode
hasNodesLockedByOtherUser
in interface BaseNode
uuid
- the uuidWebserviceException
- the webservice exceptionPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionAccessDeniedException
- the access denied exceptionUnknownException
- the unknown exceptionpublic LockInfo lockNode(String uuid) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, UnknownException, WebserviceException
BaseNode
lockNode
in interface BaseNode
uuid
- the uuidLockException
- the lock exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic LockInfo forceLockNode(String uuid) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, UnknownException, WebserviceException
BaseNode
forceLockNode
in interface BaseNode
uuid
- the uuidLockException
- the lock exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic void unlockNode(String uuid) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, UnknownException, WebserviceException
BaseNode
unlockNode
in interface BaseNode
uuid
- the uuidLockException
- the lock exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic void forceUnlockNode(String uuid) throws LockException, PathNotFoundException, AccessDeniedException, RepositoryException, DatabaseException, UnknownException, WebserviceException
BaseNode
forceUnlockNode
in interface BaseNode
uuid
- the uuidLockException
- the lock exceptionPathNotFoundException
- the path not found exceptionAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic boolean isLocked(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, DatabaseException, UnknownException, WebserviceException
BaseNode
isLocked
in interface BaseNode
uuid
- the uuidAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic LockInfo getLockInfo(String uuid) throws AccessDeniedException, RepositoryException, PathNotFoundException, LockException, DatabaseException, UnknownException, WebserviceException
BaseNode
getLockInfo
in interface BaseNode
uuid
- the uuidAccessDeniedException
- the access denied exceptionRepositoryException
- the repository exceptionPathNotFoundException
- the path not found exceptionLockException
- the lock exceptionDatabaseException
- the database exceptionUnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionpublic void setComment(String uuid, String versionName, String comment) throws VersionException, DatabaseException, AccessDeniedException, WebserviceException, UnknownException, PathNotFoundException
BaseNode
setComment
in interface BaseNode
uuid
- the uuidversionName
- the version namecomment
- the commentVersionException
- the version exceptionDatabaseException
- the database exceptionAccessDeniedException
- the access denied exceptionWebserviceException
- the webservice exceptionUnknownException
- the unknown exceptionPathNotFoundException
- the path not found exceptionpublic PaginatorPluginList getPaginatorPlugins() throws UnknownException, WebserviceException
BaseNode
getPaginatorPlugins
in interface BaseNode
UnknownException
- the unknown exceptionWebserviceException
- the webservice exceptionCopyright © 2021 Open Knowledge Management System S.L.. All Rights Reserved.