Package com.openkm.sdk4j.impl

Class FolderImpl

java.lang.Object

com.openkm.sdk4j.impl.ClientImpl

com.openkm.sdk4j.impl.FolderImpl

All Implemented Interfaces:

BaseFolder, Serializable

public class FolderImpl
extends ClientImpl
implements BaseFolder, Serializable

FolderImpl

Author:

sochoa

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FolderImpl(String host)	FolderImpl

Method Summary

Modifier and Type	Method	Description
Folder	copy(String uuid, String dstId, String newName)	Copy folder.
Folder	create(String uuid, String name)	Create folder.
Folder	create(String uuid, String name, long nodeClass)	Create folder.
Folder	createFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, boolean propertyGroups, boolean security, Map<String,String> properties)	Create from template folder.
Folder	createFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, Map<String,String> properties)	Deprecated. As of sdk4j 4.3, replaced by createFromTemplate(String, String, boolean, boolean, boolean, boolean, boolean, Map)
void	createMissingFolders(String fldPath)	Create missing folders.
void	delete(String uuid)	Delete folder.
Folder	extendedCopy(String uuid, String dstId, String newName, boolean categories, boolean keywords, boolean propertyGroups, boolean notes, boolean security)	Extended folder copy folder.
List<Folder>	getChildren(String uuid)	Gets children.
ContentInfo	getContentInfo(String uuid)	Gets content info.
String	getPath(String uuid)	Gets path.
Folder	getProperties(String uuid)	Gets properties.
boolean	isValid(String uuid)	Is valid folder boolean.
void	move(String uuid, String dstId)	Move folder.
void	purge(String uuid)	Purge folder.
Folder	rename(String uuid, String newName)	Rename folder.
protected void	setAuthorizationToken(String authorizationToken)	setAuthenticationToken
void	setDescription(String uuid, String description)	Sets description.

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

getClient, getWebTarget, setAuthorizationHeader, setJsessionIdHeader

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FolderImpl

public FolderImpl(String host)

FolderImpl

Method Details

setAuthorizationToken

protected void setAuthorizationToken(String authorizationToken)

setAuthenticationToken

create

public Folder create(String uuid,
 String name)
              throws AccessDeniedException,
RepositoryException,
PathNotFoundException,
ItemExistsException,
DatabaseException,
ExtensionException,
AutomationException,
PromotedAsRecordLockException,
UnknownException,
WebserviceException

Description copied from interface: BaseFolder

Create folder.

Specified by:

create in interface BaseFolder

Parameters:

uuid - the uuid

name - the name

Returns:

the folder

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

ItemExistsException - the item exists 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

create

public Folder create(String uuid,
 String name,
 long nodeClass)
              throws AccessDeniedException,
RepositoryException,
PathNotFoundException,
ItemExistsException,
DatabaseException,
ExtensionException,
AutomationException,
PromotedAsRecordLockException,
UnknownException,
WebserviceException

Description copied from interface: BaseFolder

Create folder.

Specified by:

create in interface BaseFolder

Parameters:

uuid - the uuid

name - the name

Returns:

the folder

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

PathNotFoundException - the path not found exception

ItemExistsException - the item exists 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

getProperties

public Folder getProperties(String uuid)
                     throws AccessDeniedException,
RepositoryException,
PathNotFoundException,
DatabaseException,
UnknownException,
WebserviceException

Description copied from interface: BaseFolder

Gets properties.

Specified by:

getProperties in interface BaseFolder

Parameters:

uuid - the uuid

Returns:

the folder properties

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

delete

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

Description copied from interface: BaseFolder

Delete folder.

Specified by:

delete in interface BaseFolder

Parameters:

uuid - the uuid

Throws:

AutomationException - the automation exception

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

rename

public Folder rename(String uuid,
 String newName)
              throws PathNotFoundException,
ItemExistsException,
AccessDeniedException,
RepositoryException,
UnknownException,
WebserviceException

Description copied from interface: BaseFolder

Rename folder.

Specified by:

rename in interface BaseFolder

Parameters:

uuid - the uuid

newName - the new name

Throws:

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

move

public void move(String uuid,
 String dstId)
          throws PathNotFoundException,
ItemExistsException,
AccessDeniedException,
RepositoryException,
DatabaseException,
UnknownException,
WebserviceException

Description copied from interface: BaseFolder

Move folder.

Specified by:

move in interface BaseFolder

Parameters:

uuid - the uuid

dstId - the dst id

Throws:

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getChildren

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

Description copied from interface: BaseFolder

Gets children.

Specified by:

getChildren in interface BaseFolder

Parameters:

uuid - the uuid

Returns:

the folder children

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

isValid

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

Description copied from interface: BaseFolder

Is valid folder boolean.

Specified by:

isValid in interface BaseFolder

Parameters:

uuid - the uuid

Returns:

the boolean

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

getPath

public String getPath(String uuid)
               throws AccessDeniedException,
RepositoryException,
DatabaseException,
UnknownException,
WebserviceException

Description copied from interface: BaseFolder

Gets path.

Specified by:

getPath in interface BaseFolder

Parameters:

uuid - the uuid

Returns:

the folder path

Throws:

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

copy

public Folder copy(String uuid,
 String dstId,
 String newName)
            throws PathNotFoundException,
ItemExistsException,
AccessDeniedException,
RepositoryException,
AutomationException,
DatabaseException,
UserQuotaExceededException,
PromotedAsRecordLockException,
UnknownException,
WebserviceException

Description copied from interface: BaseFolder

Copy folder.

Specified by:

copy in interface BaseFolder

Parameters:

uuid - the uuid

dstId - the dst id

newName - the new name

Returns:

the folder

Throws:

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

AutomationException - the automation exception

DatabaseException - the database exception

UserQuotaExceededException - the user quota exceeded exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

extendedCopy

public Folder extendedCopy(String uuid,
 String dstId,
 String newName,
 boolean categories,
 boolean keywords,
 boolean propertyGroups,
 boolean notes,
 boolean security)
                    throws ItemExistsException,
PathNotFoundException,
AccessDeniedException,
RepositoryException,
DatabaseException,
UserQuotaExceededException,
AutomationException,
PromotedAsRecordLockException,
UnknownException,
WebserviceException

Description copied from interface: BaseFolder

Extended folder copy folder.

Specified by:

extendedCopy in interface BaseFolder

Parameters:

uuid - the uuid

dstId - the dst id

newName - the new name

categories - the categories

keywords - the keywords

propertyGroups - the property groups

notes - the notes

security - the security

Returns:

the folder

Throws:

ItemExistsException - the item exists exception

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

UserQuotaExceededException - the user quota exceeded exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

getContentInfo

public ContentInfo getContentInfo(String uuid)
                           throws AccessDeniedException,
RepositoryException,
PathNotFoundException,
DatabaseException,
UnknownException,
WebserviceException

Description copied from interface: BaseFolder

Gets content info.

Specified by:

getContentInfo in interface BaseFolder

Parameters:

uuid - the uuid

Returns:

the content info

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

purge

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

Description copied from interface: BaseFolder

Purge folder.

Specified by:

purge in interface BaseFolder

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

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

createMissingFolders

public void createMissingFolders(String fldPath)
                          throws RepositoryException,
DatabaseException,
PathNotFoundException,
ItemExistsException,
AccessDeniedException,
AutomationException,
PromotedAsRecordLockException,
UnknownException,
WebserviceException

Description copied from interface: BaseFolder

Create missing folders.

Specified by:

createMissingFolders in interface BaseFolder

Parameters:

fldPath - the fld path

Throws:

RepositoryException - the repository exception

DatabaseException - the database exception

PathNotFoundException - the path not found exception

ItemExistsException - the item exists exception

AccessDeniedException - the access denied exception

AutomationException - the automation exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

setDescription

public void setDescription(String uuid,
 String description)
                    throws AccessDeniedException,
PathNotFoundException,
DatabaseException,
LockException,
PromotedAsRecordLockException,
UnknownException,
WebserviceException

Description copied from interface: BaseFolder

Sets description.

Specified by:

setDescription in interface BaseFolder

Parameters:

uuid - the uuid

description - the description

Throws:

AccessDeniedException - the access denied exception

PathNotFoundException - the path not found exception

DatabaseException - the database exception

LockException - the lock exception

PromotedAsRecordLockException - the promoted as record lock exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

createFromTemplate

public Folder createFromTemplate(String uuid,
 String dstPath,
 boolean categories,
 boolean keywords,
 boolean notes,
 boolean propertyGroups,
 boolean security,
 Map<String,String> properties)
                          throws PathNotFoundException,
AccessDeniedException,
RepositoryException,
DatabaseException,
TemplateException,
DocumentTemplateException,
ItemExistsException,
AutomationException,
FilePlanException,
PromotedAsRecordLockException,
ParseException,
NoSuchGroupException,
NoSuchPropertyException,
LockException,
ValidationFormException,
ClassNotFoundException,
UnknownException,
WebserviceException

Description copied from interface: BaseFolder

Create from template folder.

Specified by:

createFromTemplate in interface BaseFolder

Parameters:

uuid - the uuid

dstPath - the dst path

categories - the categories

keywords - the keywords

notes - the notes

propertyGroups - the property groups

security - the security

properties - the properties

Returns:

the folder

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

TemplateException - the template exception

DocumentTemplateException - the document template exception

ItemExistsException - the item exists exception

AutomationException - the automation exception

FilePlanException - the file plan exception

PromotedAsRecordLockException - the promoted as record lock exception

ParseException - the parse exception

NoSuchGroupException - the no such group exception

NoSuchPropertyException - the no such property exception

LockException - the lock exception

ValidationFormException - the validation form exception

ClassNotFoundException - the class not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

createFromTemplate

@Deprecated
public Folder createFromTemplate(String uuid,
 String dstPath,
 boolean categories,
 boolean keywords,
 boolean notes,
 Map<String,String> properties)
                          throws PathNotFoundException,
AccessDeniedException,
RepositoryException,
DatabaseException,
TemplateException,
DocumentTemplateException,
ItemExistsException,
AutomationException,
FilePlanException,
PromotedAsRecordLockException,
ParseException,
NoSuchGroupException,
NoSuchPropertyException,
LockException,
ValidationFormException,
ClassNotFoundException,
UnknownException,
WebserviceException

Deprecated.

As of sdk4j 4.3, replaced by createFromTemplate(String, String, boolean, boolean, boolean, boolean, boolean, Map)

createFromTemplate

Specified by:

createFromTemplate in interface BaseFolder

Parameters:

uuid - the uuid

dstPath - the dst path

categories - the categories

keywords - the keywords

notes - the notes

properties - the properties

Returns:

the folder

Throws:

PathNotFoundException - the path not found exception

AccessDeniedException - the access denied exception

RepositoryException - the repository exception

DatabaseException - the database exception

TemplateException - the template exception

DocumentTemplateException - the document template exception

ItemExistsException - the item exists exception

AutomationException - the automation exception

FilePlanException - the file plan exception

PromotedAsRecordLockException - the promoted as record lock exception

ParseException - the parse exception

NoSuchGroupException - the no such group exception

NoSuchPropertyException - the no such property exception

LockException - the lock exception

ValidationFormException - the validation form exception

ClassNotFoundException - the class not found exception

UnknownException - the unknown exception

WebserviceException - the webservice exception

See Also:

• createFromTemplate(String, String, boolean, boolean, boolean, boolean, boolean, Map)