Package com.openkm.sdk4j.definition

Interface BaseFolder

All Known Implementing Classes:

FolderImpl

public interface BaseFolder

BaseFolder

Author:

jllort

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	createFromTemplate(String uuid, String dstPath, boolean categories, boolean keywords, boolean notes, Map<String,String> properties)	Create from template folder.
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.
void	setDescription(String uuid, String description)	Sets description.
void	setStyle(String uuid, long styleId)	Sets style.

Method Detail

create

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

Create folder.

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

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

Gets properties.

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

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

Delete folder.

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

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

Rename folder.

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

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

Move folder.

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

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

Gets children.

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

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

Is valid folder boolean.

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

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

Gets path.

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

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

Copy folder.

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

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

Extended folder copy folder.

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

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

Gets content info.

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

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

Purge folder.

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

setStyle

void setStyle(String uuid,
              long styleId)
       throws VersionException,
              PathNotFoundException,
              AccessDeniedException,
              RepositoryException,
              DatabaseException,
              UnknownException,
              WebserviceException

Sets style.

Parameters:

uuid - the uuid

styleId - the style id

Throws:

VersionException - the version 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

createMissingFolders

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

Create missing folders.

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

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

Sets description.

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

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

Create from template folder.

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