Package com.axemble.vdoc.sdk.modules

Interface ILibraryModule

All Superinterfaces:

IBaseLibraryModule, IModule, Remote

All Known Implementing Classes:

CustomPortalLibraryModule, PortalLibraryModule

public interface ILibraryModule
extends IBaseLibraryModule

The library module interface.

Code sample :

 // creation of a library module object
 ILibraryModule libraryModule = SDKFactory.MODULES.getLibraryModule();
 try
 {
 }
 finally
 {
  // uninitialize the module
        SDKFactory.MODULES.releaseModule(libraryModule);
 }
 

See Also:

• IFile
• IFolder
• ICategory

Nested Class Summary

Nested classes/interfaces inherited from interface com.axemble.vdoc.sdk.modules.IBaseLibraryModule

IBaseLibraryModule.SubscriptionFrequency

Method Summary

Modifier and Type	Method	Description
IAttachment	addAttachment(IFile file, IAttachment attachment)
IAttachment	addAttachment(IFile file, File ioFile)
IAttachment	addAttachment(IFile file, String fileName, InputStream inputStream)
IAttachment	addAttachment(IFile file, String fileName, String fullPath)
void	addCategories(IContext context, IFile file, Collection categories)
void	addCategory(IContext context, IFile file, ICategory category)
IUser	checkedOutBy(IContext context, IFile file)
void	checkIn(IContext context, IFile file)
void	checkOut(IContext context, IFile file)
IFile	copyTo(IContext context, IFile file, IFolder dest, CopyOption... copyOptions)	Allows to copy a specified IFile underneath a destination folder;
IFile	copyTo(IContext context, IFile file, ILibrary dest, CopyOption... copyOptions)	Allows to copy a specified IFile at the root level of a ILibrary object;
IFile	copyTo(IContext context, IFile file, String newName, IFolder dest, CopyOption... copyOptions)	Allows to copy a specified IFile underneath a destination folder;
IFile	copyTo(IContext context, IFile file, String newName, ILibrary dest, CopyOption... copyOptions)	Allows to copy a specified IFile at the root level of a ILibrary object;
IFolder	copyTo(IContext context, IFolder folder, IFolder dest, CopyOption... copyOptions)	Allows to copy a specified IFolder underneath a destination folder;
IFolder	copyTo(IContext context, IFolder folder, ILibrary dest, CopyOption... copyOptions)	Allows to copy a specified IFolder at the root level of a ILibrary object;
IFolder	copyTo(IContext context, IFolder folder, String newName, IFolder dest, CopyOption... copyOptions)	Allows to copy a specified IFolder underneath a destination folder;
IFolder	copyTo(IContext context, IFolder folder, String newName, ILibrary dest, CopyOption... copyOptions)	Allows to copy a specified IFolder at the root level of a ILibrary object;
ICategory	createCategory(IContext context, ICategory category, String name)
ICategory	createCategory(IContext context, ILibrary library, String name)
ICategory	createCategory(IContext context, String name)
IFile	createFile(IContext context, IFolder folder, String description, IAttachment attachment)
IFile	createFile(IContext context, IFolder folder, String name, String description, byte[] content)
IFile	createFile(IContext context, IFolder folder, String name, String description, InputStream content)
IFile	createFile(IContext context, ILibrary library, String description, IAttachment attachment)
IFile	createFile(IContext context, ILibrary library, String name, String description, byte[] content)
IFile	createFile(IContext context, ILibrary library, String name, String description, InputStream content)
IFolder	createFolder(IContext context, IFolder parent, String name)
IFolder	createFolder(IContext context, ILibrary library, String name)
ILibrary	createLibrary(IContext context, IOrganization organization, String name)	Creates a library on a specified organization.
ILibrary	createLibrary(IContext context, String name)	Deprecated. use createLibrary( IContext context, IOrganization organization, String name ) method instead.
IResourceDefinition	createResourceDefinition(IContext context, String name)
void	delete(IContext context, IFile file)	Allow to delete a file.
void	delete(IContext context, IFolder folder)	Allow to delete a folder.
boolean	existSubscriptionByLibraryElement(IContext context, ILibraryElement libraryElement)	check if the ILibraryElement is subscribed by the user
void	fireDownloadHistoryEvent(IContext context, IFile file, String protocol)
IAttachment	getAttachment(IFile file, String fileName)
Collection	getAttachments(IFile file)
Collection	getCategories(IContext context, ICategory category, boolean recursive)
Collection<ICategory>	getCategories(IContext context, ILibrary library, boolean recursive)
ICategory	getCategory(IContext context, ICategory category, String name)
ICategory	getCategory(IContext context, ILibrary library, String name)
ICategory	getCategory(Object object)
IProtocolSupport	getElementByProtocolURI(String protocolURI)	Gets an IElement object which implements IProtocolSupport interface.
IFile	getFile(IContext context, IFolder folder, String name)
IFile	getFile(IContext context, ILibrary library, String name)
IFile	getFile(IContext context, String fileId)
IFile	getFile(Object object)
IFile	getFileByPath(IContext context, ILibrary library, String path)
Collection	getFiles(IContext context, ICategory category)	Retrieves all the files associated with a specified ICategory object.
Collection	getFiles(IContext context, ICategory category, boolean includeDeleted)	Retrieves all the files associated with a specified ICategory object.
Collection	getFiles(IContext context, IFolder parent)
Collection	getFiles(IContext context, ILibrary library)
IFolder	getFolder(IContext context, IFolder parent, String name)
IFolder	getFolder(IContext context, ILibrary library, String name)
IFolder	getFolder(IContext context, String folderId)
IFolder	getFolder(Object object)
IFolder	getFolderByPath(IContext context, ILibrary library, String path)
Collection	getFolders(IContext context, IFolder parent)
Collection	getFolders(IContext context, ILibrary library)
Collection	getLibraries(IContext context)	Retrieves all the libraries.
Collection	getLibraries(IContext context, IOrganization organization)	Retrieves all the libraries within a specified organization.
Collection	getLibraries(IContext context, String right)	Retrieves all the libraries.
ILibrary	getLibrary(IContext context, IFile file)
ILibrary	getLibrary(IContext context, IFolder folder)
ILibrary	getLibrary(IContext context, IOrganization organization, String name)	Retrieves a ILibrary within a specified organization.
ILibrary	getLibrary(IContext context, String name)	Deprecated. use getLibrary( IContext context, IOrganization organization, String name ) method instead.
ILibrary	getLibrary(Object object)
ILibrary	getLibraryByPath(IContext context, IOrganization organization, String path)	Retrieves a library by its path.
IList	getList(IContext context, ILibrary library, String name)
Collection	getLists(IContext context, ILibrary library)
ICategory	getParentCategory(IContext context, ICategory category)
IFolder	getParentFolder(IContext context, IFile file)
IFolder	getParentFolder(IContext context, IFolder folder)
Collection	getParentFolders(IContext context, IFile file)
Collection	getParentFolders(IContext context, IFolder folder)
Collection	getProperties(IContext context, IResourceDefinition resourceDefinition)
IProperty	getProperty(IContext context, IResourceDefinition resourceDefinition, String name)
IResourceDefinition	getResourceDefinition(IContext context, ILibrary library, String name)
IResourceDefinition	getResourceDefinition(Object object)
Collection<IResourceDefinition>	getResourceDefinitions(IContext context, ILibrary library)
ISearchController	getSearchController()
ISearchController	getSearchController(IConnectionDefinition connectionDefinition)	Gets a search controller object by specifying a ConnectionDefinition object.
ISearchController	getSearchController(IDataSourceReference reference)
ISearchController	getSearchController(IJdbcReference reference)	Deprecated. use getSearchController( IConnectionDefinition connectionDefinition ) method instead.
ISecurityController	getSecurityController(ISecuritySupport securitySupport)
IBaseLibraryModule.SubscriptionFrequency	getSubscriptionFrequency(IContext context, ILibrary library)	Gets subscription frequency.
Collection<ILibrarySubscription>	getSubscriptions(IContext context, ILibrary library, boolean showElementInTrash)	get all subscriptions for a user and a library
ITransformer	getTransformer()
IUser	getUser(Object object)
IUser	getUserByLogin(String login)
Object	getValue(IContext context, IFile file, String propertyName)
IViewController	getViewController()	Deprecated. use getViewController( IContext context ) instead.
IViewController	getViewController(IContext context)	Gets a view controller to search IResource objects through their properties.
IViewController	getViewController(IContext context, InputStream inputStream)	Gets a view controller to search IResource objects through their properties.
IViewController	getViewController(IContext context, Class natureClass)	Gets a view controller to search IResource objects through their properties.
IViewController	getViewController(InputStream inputStream)	Deprecated. use getViewController( IContext context, InputStream inputStream ) instead.
IViewController	getViewController(Class natureClass)	Deprecated. use getViewController( IContext context, Class natureClass ) instead.
boolean	isCheckedOut(IContext context, IFile file)
boolean	moveTo(IContext context, IFile file, IFolder destFolder, boolean bOverwrite)	Allows to move a specified IFile underneath a destination folder.
boolean	moveTo(IContext context, IFile file, ILibrary destLibrary, boolean bOverwrite)	Allows to move a specified IFile at the root level of a ILibrary object.
boolean	moveTo(IContext context, IFolder folder, IFolder destFolder)	Allows to move a specified IFolder underneath a destination folder.
boolean	moveTo(IContext context, IFolder folder, ILibrary destLibrary)	Allows to move a specified IFolder at the root level of a ILibrary object.
void	setSubscriptionFrequency(IContext context, ILibrary library, IBaseLibraryModule.SubscriptionFrequency frequency)	Sets subscription frequency.
void	setSubscriptionRecursive(IContext context, ILibrary library, ILibraryElement libraryElement)	toggle subsription recursive flag
void	setValue(IContext context, IFile file, String propertyName, Object value)
void	subscribe(IContext context, ILibrary library, ILibraryElement libraryElement)	Subscribe to a ILibraryElement (IFile, IFolder, ICategory)
void	undoCheckOut(IContext context, IFile file)
void	unsubscribe(IContext context, ILibrary library, ILibraryElement libraryElement)	Unsubscribe to a ILibraryElement (IFile, IFolder, ICategory)

Methods inherited from interface com.axemble.vdoc.sdk.modules.IModule

beginTransaction, beginTransaction, commitTransaction, commitTransaction, convertId, findNativeClass, generateSystemName, getAnonymous, getAnonymousContext, getContext, getContext, getContextByLogin, getElementFromExternalElement, getExternalElement, getExternalElement, getLoggedOnUser, getLoggedOnUserContext, getLoggedOnUserLanguage, getProtocolPath, getProtocolPath, getProtocolURI, getProtocolURI, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getSysadmin, getSysadminContext, getTranslation, getTranslationForLanguage, getTranslationKey, initialize, isTransactionActive, rollbackTransaction, rollbackTransaction, setTransactionTimeout, unInitialize

Method Details

createLibrary

@Deprecated
ILibrary createLibrary(IContext context,
 String name)
                throws LibraryModuleException

Deprecated.

use createLibrary( IContext context, IOrganization organization, String name ) method instead.

Creates a library on the default organization

Specified by:

createLibrary in interface IBaseLibraryModule

Parameters:

context - The execution context.

name - The name of the library.

Returns:

a ILibrary object.

Throws:

LibraryModuleException - default module exception.

createLibrary

ILibrary createLibrary(IContext context,
 IOrganization organization,
 String name)
                throws LibraryModuleException

Creates a library on a specified organization.

Specified by:

createLibrary in interface IBaseLibraryModule

Parameters:

context - The execution context.

organization - The IOrganization object.

name - The name of the library.

Returns:

a ILibrary object.

Throws:

LibraryModuleException - default module exception.

getLibrary

@Deprecated
ILibrary getLibrary(IContext context,
 String name)
             throws LibraryModuleException

Deprecated.

use getLibrary( IContext context, IOrganization organization, String name ) method instead.

Retrieves the first ILibrary.

Specified by:

getLibrary in interface IBaseLibraryModule

Parameters:

context - The execution context.

name - The name of the library.

Returns:

a ILibrary object.

Throws:

LibraryModuleException - default module exception.

getLibrary

ILibrary getLibrary(IContext context,
 IOrganization organization,
 String name)
             throws LibraryModuleException

Retrieves a ILibrary within a specified organization.

Specified by:

getLibrary in interface IBaseLibraryModule

Parameters:

context - The execution context.

organization - The IOrganization object.

name - The name of the library.

Returns:

A ILibrary object.

Throws:

LibraryModuleException - default module exception.

getLibraries

Collection getLibraries(IContext context)
                 throws LibraryModuleException

Retrieves all the libraries.

Specified by:

getLibraries in interface IBaseLibraryModule

Parameters:

context - The execution context.

Returns:

A java.util.Collection of ILibrary objects.

Throws:

LibraryModuleException - default module exception.

getLibraries

Collection getLibraries(IContext context,
 String right)
                 throws LibraryModuleException

Retrieves all the libraries.

Specified by:

getLibraries in interface IBaseLibraryModule

Parameters:

context - The execution context.

right - The right required.

Returns:

A java.util.Collection of ILibrary objects.

Throws:

LibraryModuleException - default module exception.

getLibraries

Collection getLibraries(IContext context,
 IOrganization organization)
                 throws LibraryModuleException

Retrieves all the libraries within a specified organization.

Specified by:

getLibraries in interface IBaseLibraryModule

Parameters:

context - The execution context.

organization - The IOrganization object.

Returns:

A java.util.Collection of ILibrary objects.

Throws:

LibraryModuleException - default module exception.

getLibraryByPath

ILibrary getLibraryByPath(IContext context,
 IOrganization organization,
 String path)
                   throws LibraryModuleException

Retrieves a library by its path.

Specified by:

getLibraryByPath in interface IBaseLibraryModule

Parameters:

context - The execution context.

organization - The IOrganization object.

path - The path to retrieve the organization from.

Returns:

A ILibrary object.

Throws:

LibraryModuleException - default module exception.

createResourceDefinition

IResourceDefinition createResourceDefinition(IContext context,
 String name)
                                      throws LibraryModuleException

Specified by:

createResourceDefinition in interface IBaseLibraryModule

Throws:

LibraryModuleException

getResourceDefinition

IResourceDefinition getResourceDefinition(IContext context,
 ILibrary library,
 String name)
                                   throws LibraryModuleException

Specified by:

getResourceDefinition in interface IBaseLibraryModule

Throws:

LibraryModuleException

getResourceDefinitions

Collection<IResourceDefinition> getResourceDefinitions(IContext context,
 ILibrary library)
                                                throws LibraryModuleException

Specified by:

getResourceDefinitions in interface IBaseLibraryModule

Throws:

LibraryModuleException

getProperties

Collection getProperties(IContext context,
 IResourceDefinition resourceDefinition)
                  throws LibraryModuleException

Specified by:

getProperties in interface IBaseLibraryModule

Throws:

LibraryModuleException

getProperty

IProperty getProperty(IContext context,
 IResourceDefinition resourceDefinition,
 String name)
               throws LibraryModuleException

Specified by:

getProperty in interface IBaseLibraryModule

Throws:

LibraryModuleException

getLists

Collection getLists(IContext context,
 ILibrary library)
             throws LibraryModuleException

Specified by:

getLists in interface IBaseLibraryModule

Throws:

LibraryModuleException

getList

IList getList(IContext context,
 ILibrary library,
 String name)
       throws LibraryModuleException

Specified by:

getList in interface IBaseLibraryModule

Throws:

LibraryModuleException

getParentCategory

ICategory getParentCategory(IContext context,
 ICategory category)
                     throws LibraryModuleException

Specified by:

getParentCategory in interface IBaseLibraryModule

Throws:

LibraryModuleException

createCategory

ICategory createCategory(IContext context,
 String name)
                  throws LibraryModuleException

Specified by:

createCategory in interface IBaseLibraryModule

Throws:

LibraryModuleException

createCategory

ICategory createCategory(IContext context,
 ILibrary library,
 String name)
                  throws LibraryModuleException

Specified by:

createCategory in interface IBaseLibraryModule

Throws:

LibraryModuleException

createCategory

ICategory createCategory(IContext context,
 ICategory category,
 String name)
                  throws LibraryModuleException

Specified by:

createCategory in interface IBaseLibraryModule

Throws:

LibraryModuleException

getCategory

ICategory getCategory(IContext context,
 ILibrary library,
 String name)
               throws LibraryModuleException

Specified by:

getCategory in interface IBaseLibraryModule

Throws:

LibraryModuleException

getCategory

ICategory getCategory(IContext context,
 ICategory category,
 String name)
               throws LibraryModuleException

Specified by:

getCategory in interface IBaseLibraryModule

Throws:

LibraryModuleException

getCategories

Collection<ICategory> getCategories(IContext context,
 ILibrary library,
 boolean recursive)
                             throws LibraryModuleException

Specified by:

getCategories in interface IBaseLibraryModule

Throws:

LibraryModuleException

getCategories

Collection getCategories(IContext context,
 ICategory category,
 boolean recursive)
                  throws LibraryModuleException

Specified by:

getCategories in interface IBaseLibraryModule

Throws:

LibraryModuleException

createFolder

IFolder createFolder(IContext context,
 ILibrary library,
 String name)
              throws LibraryModuleException

Specified by:

createFolder in interface IBaseLibraryModule

Throws:

LibraryModuleException

createFolder

IFolder createFolder(IContext context,
 IFolder parent,
 String name)
              throws LibraryModuleException

Specified by:

createFolder in interface IBaseLibraryModule

Throws:

LibraryModuleException

delete

void delete(IContext context,
 IFolder folder)
     throws LibraryModuleException

Allow to delete a folder. If used on a folder in the trash this will delete it from trash.

Specified by:

delete in interface IBaseLibraryModule

Parameters:

context - The execution context.

folder - The folder to delete

Throws:

LibrarySecurityException - thrown when context has no writing rights

LibraryModuleException - thrown on any internal error

getFolder

IFolder getFolder(IContext context,
 ILibrary library,
 String name)
           throws LibraryModuleException

Specified by:

getFolder in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFolder

IFolder getFolder(IContext context,
 IFolder parent,
 String name)
           throws LibraryModuleException

Specified by:

getFolder in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFolders

Collection getFolders(IContext context,
 IFolder parent)
               throws LibraryModuleException

Specified by:

getFolders in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFolders

Collection getFolders(IContext context,
 ILibrary library)
               throws LibraryModuleException

Specified by:

getFolders in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFolderByPath

IFolder getFolderByPath(IContext context,
 ILibrary library,
 String path)
                 throws LibraryModuleException

Specified by:

getFolderByPath in interface IBaseLibraryModule

Throws:

LibraryModuleException

getLibrary

ILibrary getLibrary(IContext context,
 IFolder folder)
             throws LibraryModuleException

Specified by:

getLibrary in interface IBaseLibraryModule

Throws:

LibraryModuleException

getParentFolder

IFolder getParentFolder(IContext context,
 IFolder folder)
                 throws LibraryModuleException

Specified by:

getParentFolder in interface IBaseLibraryModule

Throws:

LibraryModuleException

getParentFolders

Collection getParentFolders(IContext context,
 IFolder folder)
                     throws LibraryModuleException

Specified by:

getParentFolders in interface IBaseLibraryModule

Throws:

LibraryModuleException

createFile

IFile createFile(IContext context,
 ILibrary library,
 String name,
 String description,
 byte[] content)
          throws LibraryModuleException

Specified by:

createFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

createFile

IFile createFile(IContext context,
 ILibrary library,
 String name,
 String description,
 InputStream content)
          throws LibraryModuleException

Specified by:

createFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

createFile

IFile createFile(IContext context,
 ILibrary library,
 String description,
 IAttachment attachment)
          throws LibraryModuleException

Specified by:

createFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

createFile

IFile createFile(IContext context,
 IFolder folder,
 String name,
 String description,
 byte[] content)
          throws LibraryModuleException

Specified by:

createFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

createFile

IFile createFile(IContext context,
 IFolder folder,
 String name,
 String description,
 InputStream content)
          throws LibraryModuleException

Specified by:

createFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

createFile

IFile createFile(IContext context,
 IFolder folder,
 String description,
 IAttachment attachment)
          throws LibraryModuleException

Specified by:

createFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

delete

void delete(IContext context,
 IFile file)
     throws LibraryModuleException

Allow to delete a file. If used on a file in the trash this will delete it from trash.

Specified by:

delete in interface IBaseLibraryModule

Parameters:

context - The execution context.

file - The file to delete

Throws:

LibraryLockException - thrown when file is checked out by another user.

LibrarySecurityException - thrown when context has no writing rights

LibraryModuleException - thrown on any internal error

getFile

IFile getFile(IContext context,
 ILibrary library,
 String name)
       throws LibraryModuleException

Specified by:

getFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFile

IFile getFile(IContext context,
 IFolder folder,
 String name)
       throws LibraryModuleException

Specified by:

getFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFileByPath

IFile getFileByPath(IContext context,
 ILibrary library,
 String path)
             throws LibraryModuleException

Specified by:

getFileByPath in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFiles

Collection getFiles(IContext context,
 IFolder parent)
             throws LibraryModuleException

Specified by:

getFiles in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFiles

Collection getFiles(IContext context,
 ILibrary library)
             throws LibraryModuleException

Specified by:

getFiles in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFiles

Collection getFiles(IContext context,
 ICategory category)
             throws LibraryModuleException

Retrieves all the files associated with a specified ICategory object.

Specified by:

getFiles in interface IBaseLibraryModule

Parameters:

context - The execution context.

category - The ICategory object.

Returns:

a collection of IFile objects.

Throws:

LibraryModuleException - default module exception.

getFiles

Collection getFiles(IContext context,
 ICategory category,
 boolean includeDeleted)
             throws LibraryModuleException

Retrieves all the files associated with a specified ICategory object. It allows to specify if the deleted files should be included

Specified by:

getFiles in interface IBaseLibraryModule

Parameters:

context - The execution context.

category - The ICategory object.

includeDeleted - The flag to include or not deleted IFile objects.

Returns:

a collection of IFile objects.

Throws:

LibraryModuleException - default module exception.

copyTo

IFolder copyTo(IContext context,
 IFolder folder,
 ILibrary dest,
 CopyOption... copyOptions)
        throws LibraryModuleException

Allows to copy a specified IFolder at the root level of a ILibrary object;

Specified by:

copyTo in interface IBaseLibraryModule

Parameters:

context - The execution context.

folder - The IFolder to copy.

dest - The destination ILibrary object.

Returns:

the newly created folder

Throws:

LibraryModuleException - default module exception.

copyTo

IFolder copyTo(IContext context,
 IFolder folder,
 String newName,
 ILibrary dest,
 CopyOption... copyOptions)
        throws LibraryModuleException

Allows to copy a specified IFolder at the root level of a ILibrary object;

Specified by:

copyTo in interface IBaseLibraryModule

Parameters:

context - The execution context.

folder - The IFolder to copy.

newName - The new IFolder name.

dest - The destination ILibrary object.

Returns:

the newly created folder

Throws:

LibraryModuleException - default module exception.

copyTo

IFolder copyTo(IContext context,
 IFolder folder,
 IFolder dest,
 CopyOption... copyOptions)
        throws LibraryModuleException

Allows to copy a specified IFolder underneath a destination folder;

Specified by:

copyTo in interface IBaseLibraryModule

Parameters:

context - The execution context.

folder - The IFolder to copy.

dest - The destination IFolder object.

Returns:

the newly created folder

Throws:

LibraryModuleException - default module exception.

copyTo

IFolder copyTo(IContext context,
 IFolder folder,
 String newName,
 IFolder dest,
 CopyOption... copyOptions)
        throws LibraryModuleException

Allows to copy a specified IFolder underneath a destination folder;

Specified by:

copyTo in interface IBaseLibraryModule

Parameters:

context - The execution context.

folder - The IFolder to copy.

newName - The new IFolder name.

dest - The destination IFolder object.

Returns:

the newly created folder

Throws:

LibraryModuleException - default module exception.

copyTo

IFile copyTo(IContext context,
 IFile file,
 ILibrary dest,
 CopyOption... copyOptions)
      throws LibraryModuleException

Allows to copy a specified IFile at the root level of a ILibrary object;

Specified by:

copyTo in interface IBaseLibraryModule

Parameters:

context - The execution context.

file - The IFile to copy.

dest - The destination ILibrary object.

Returns:

the newly created file

Throws:

LibraryModuleException - default module exception.

copyTo

IFile copyTo(IContext context,
 IFile file,
 String newName,
 ILibrary dest,
 CopyOption... copyOptions)
      throws LibraryModuleException

Allows to copy a specified IFile at the root level of a ILibrary object;

Specified by:

copyTo in interface IBaseLibraryModule

Parameters:

context - The execution context.

file - The IFile to copy.

newName - The new IFile name.

dest - The destination ILibrary object.

Returns:

the newly created file

Throws:

LibraryModuleException - default module exception.

copyTo

IFile copyTo(IContext context,
 IFile file,
 IFolder dest,
 CopyOption... copyOptions)
      throws LibraryModuleException

Allows to copy a specified IFile underneath a destination folder;

Specified by:

copyTo in interface IBaseLibraryModule

Parameters:

context - The execution context.

file - file The IFile to copy.

dest - The destination IFolder object.

Returns:

the newly created file

Throws:

LibraryModuleException - default module exception.

copyTo

IFile copyTo(IContext context,
 IFile file,
 String newName,
 IFolder dest,
 CopyOption... copyOptions)
      throws LibraryModuleException

Allows to copy a specified IFile underneath a destination folder;

Specified by:

copyTo in interface IBaseLibraryModule

Parameters:

context - The execution context.

file - file The IFile to copy.

dest - The destination IFolder object.

Returns:

the newly created file

Throws:

LibraryModuleException - default module exception.

moveTo

boolean moveTo(IContext context,
 IFolder folder,
 ILibrary destLibrary)
        throws LibraryModuleException

Allows to move a specified IFolder at the root level of a ILibrary object.

Specified by:

moveTo in interface IBaseLibraryModule

Parameters:

context - The execution context.

folder - The IFolder to move.

destLibrary - The destination ILibrary object.

Returns:

true if the folder has been moved, false otherwise.

Throws:

LibraryModuleException - The default exception.

moveTo

boolean moveTo(IContext context,
 IFolder folder,
 IFolder destFolder)
        throws LibraryModuleException

Allows to move a specified IFolder underneath a destination folder.

Specified by:

moveTo in interface IBaseLibraryModule

Parameters:

context - The execution context.

folder - The IFolder to move.

destFolder - The destination IFolder object.

Returns:

true if the folder has been moved, false otherwise.

Throws:

LibraryModuleException - The default exception.

moveTo

boolean moveTo(IContext context,
 IFile file,
 ILibrary destLibrary,
 boolean bOverwrite)
        throws LibraryModuleException

Allows to move a specified IFile at the root level of a ILibrary object.

Specified by:

moveTo in interface IBaseLibraryModule

Parameters:

context - The execution context.

file - The IFile to move.

destLibrary - The destination ILibrary object.

Returns:

true if the file has been moved, false otherwise.

Throws:

LibraryModuleException - The default exception.

moveTo

boolean moveTo(IContext context,
 IFile file,
 IFolder destFolder,
 boolean bOverwrite)
        throws LibraryModuleException

Allows to move a specified IFile underneath a destination folder.

Specified by:

moveTo in interface IBaseLibraryModule

Parameters:

context - The execution context.

file - The IFile to move.

destFolder - The destination IFolder object.

Returns:

true if the file has been moved, false otherwise.

Throws:

LibraryModuleException - The default exception.

getLibrary

ILibrary getLibrary(IContext context,
 IFile file)
             throws LibraryModuleException

Specified by:

getLibrary in interface IBaseLibraryModule

Throws:

LibraryModuleException

getParentFolder

IFolder getParentFolder(IContext context,
 IFile file)
                 throws LibraryModuleException

Specified by:

getParentFolder in interface IBaseLibraryModule

Throws:

LibraryModuleException

getParentFolders

Collection getParentFolders(IContext context,
 IFile file)
                     throws LibraryModuleException

Specified by:

getParentFolders in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFile

IFile getFile(IContext context,
 String fileId)
       throws LibraryModuleException

Specified by:

getFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFolder

IFolder getFolder(IContext context,
 String folderId)
           throws LibraryModuleException

Specified by:

getFolder in interface IBaseLibraryModule

Throws:

LibraryModuleException

getAttachments

Collection getAttachments(IFile file)
                   throws LibraryModuleException

Specified by:

getAttachments in interface IBaseLibraryModule

Throws:

LibraryModuleException

getAttachment

IAttachment getAttachment(IFile file,
 String fileName)
                   throws LibraryModuleException

Specified by:

getAttachment in interface IBaseLibraryModule

Throws:

LibraryModuleException

addAttachment

IAttachment addAttachment(IFile file,
 File ioFile)
                   throws LibraryModuleException

Specified by:

addAttachment in interface IBaseLibraryModule

Throws:

LibraryModuleException

addAttachment

IAttachment addAttachment(IFile file,
 String fileName,
 InputStream inputStream)
                   throws LibraryModuleException

Specified by:

addAttachment in interface IBaseLibraryModule

Throws:

LibraryModuleException

addAttachment

IAttachment addAttachment(IFile file,
 String fileName,
 String fullPath)
                   throws LibraryModuleException

Specified by:

addAttachment in interface IBaseLibraryModule

Throws:

LibraryModuleException

addAttachment

IAttachment addAttachment(IFile file,
 IAttachment attachment)
                   throws LibraryModuleException

Specified by:

addAttachment in interface IBaseLibraryModule

Throws:

LibraryModuleException

fireDownloadHistoryEvent

void fireDownloadHistoryEvent(IContext context,
 IFile file,
 String protocol)
                       throws LibraryModuleException

Specified by:

fireDownloadHistoryEvent in interface IBaseLibraryModule

Throws:

LibraryModuleException

setValue

void setValue(IContext context,
 IFile file,
 String propertyName,
 Object value)
       throws LibraryModuleException

Specified by:

setValue in interface IBaseLibraryModule

Throws:

LibraryModuleException

getValue

Object getValue(IContext context,
 IFile file,
 String propertyName)
         throws LibraryModuleException

Specified by:

getValue in interface IBaseLibraryModule

Throws:

LibraryModuleException

addCategory

void addCategory(IContext context,
 IFile file,
 ICategory category)
          throws LibraryModuleException

Specified by:

addCategory in interface IBaseLibraryModule

Throws:

LibraryModuleException

addCategories

void addCategories(IContext context,
 IFile file,
 Collection categories)
            throws LibraryModuleException

Specified by:

addCategories in interface IBaseLibraryModule

Throws:

LibraryModuleException

checkOut

void checkOut(IContext context,
 IFile file)
       throws LibraryModuleException

Specified by:

checkOut in interface IBaseLibraryModule

Throws:

LibraryModuleException

undoCheckOut

void undoCheckOut(IContext context,
 IFile file)
           throws LibraryModuleException

Specified by:

undoCheckOut in interface IBaseLibraryModule

Throws:

LibraryModuleException

checkIn

void checkIn(IContext context,
 IFile file)
      throws LibraryModuleException

Specified by:

checkIn in interface IBaseLibraryModule

Throws:

LibraryModuleException

checkedOutBy

IUser checkedOutBy(IContext context,
 IFile file)
            throws LibraryModuleException

Specified by:

checkedOutBy in interface IBaseLibraryModule

Throws:

LibraryModuleException

isCheckedOut

boolean isCheckedOut(IContext context,
 IFile file)
              throws LibraryModuleException

Specified by:

isCheckedOut in interface IBaseLibraryModule

Throws:

LibraryModuleException

getUserByLogin

IUser getUserByLogin(String login)

Specified by:

getUserByLogin in interface IBaseLibraryModule

getUser

IUser getUser(Object object)
       throws LibraryModuleException

Specified by:

getUser in interface IBaseLibraryModule

Throws:

LibraryModuleException

getLibrary

ILibrary getLibrary(Object object)
             throws LibraryModuleException

Specified by:

getLibrary in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFolder

IFolder getFolder(Object object)
           throws LibraryModuleException

Specified by:

getFolder in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFile

IFile getFile(Object object)
       throws LibraryModuleException

Specified by:

getFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

getCategory

ICategory getCategory(Object object)
               throws LibraryModuleException

Specified by:

getCategory in interface IBaseLibraryModule

Throws:

LibraryModuleException

getResourceDefinition

IResourceDefinition getResourceDefinition(Object object)
                                   throws LibraryModuleException

Specified by:

getResourceDefinition in interface IBaseLibraryModule

Throws:

LibraryModuleException

getElementByProtocolURI

IProtocolSupport getElementByProtocolURI(String protocolURI)
                                  throws ModuleException

Gets an IElement object which implements IProtocolSupport interface.

Specified by:

getElementByProtocolURI in interface IBaseLibraryModule

Parameters:

protocolURI - The protocol URI as a java.lang.String.

Returns:

A IProtocolSupport object.

Throws:

ModuleException - default module exception.

getSearchController

ISearchController getSearchController()
                               throws LibraryModuleException

Specified by:

getSearchController in interface IBaseLibraryModule

Throws:

LibraryModuleException

getSearchController

@Deprecated
ISearchController getSearchController(IJdbcReference reference)
                               throws LibraryModuleException

Deprecated.

use getSearchController( IConnectionDefinition connectionDefinition ) method instead.

Gets a search controller object by specifying a JDBC external reference.

Specified by:

getSearchController in interface IBaseLibraryModule

Parameters:

reference - The IJdbcReference object.

Returns:

The ISearchController object.

Throws:

LibraryModuleException - default module exception.

getSearchController

ISearchController getSearchController(IConnectionDefinition connectionDefinition)
                               throws LibraryModuleException

Gets a search controller object by specifying a ConnectionDefinition object.

Specified by:

getSearchController in interface IBaseLibraryModule

Parameters:

connectionDefinition - The IConnectionDefinition object.

Returns:

The ISearchController object.

Throws:

LibraryModuleException - default module exception.

getSearchController

ISearchController getSearchController(IDataSourceReference reference)
                               throws LibraryModuleException

Specified by:

getSearchController in interface IBaseLibraryModule

Throws:

LibraryModuleException

getSecurityController

ISecurityController getSecurityController(ISecuritySupport securitySupport)
                                   throws LibraryModuleException

Specified by:

getSecurityController in interface IBaseLibraryModule

Throws:

LibraryModuleException

getTransformer

ITransformer getTransformer()
                     throws LibraryModuleException

Specified by:

getTransformer in interface IBaseLibraryModule

Throws:

LibraryModuleException

getViewController

@Deprecated
IViewController getViewController()
                           throws LibraryModuleException

Deprecated.

use getViewController( IContext context ) instead.

Gets a view controller to search IResource objects through their properties.

Specified by:

getViewController in interface IBaseLibraryModule

Returns:

A IViewController object.

Throws:

LibraryModuleException - default module exception.

getViewController

IViewController getViewController(IContext context)
                           throws LibraryModuleException

Gets a view controller to search IResource objects through their properties.

Specified by:

getViewController in interface IBaseLibraryModule

Parameters:

context - The execution context.

Returns:

A IViewController object.

Throws:

LibraryModuleException - default module exception.

getViewController

@Deprecated
IViewController getViewController(Class natureClass)
                           throws LibraryModuleException

Deprecated.

use getViewController( IContext context, Class natureClass ) instead.

Gets a view controller to search IResource objects through their properties.

Specified by:

getViewController in interface IBaseLibraryModule

Parameters:

natureClass - : The class of the searched objects IWorkflowInstance, ITaskInstance, IResource}

Returns:

A IViewController object.

Throws:

LibraryModuleException - default module exception.

getViewController

IViewController getViewController(IContext context,
 Class natureClass)
                           throws LibraryModuleException

Gets a view controller to search IResource objects through their properties.

Specified by:

getViewController in interface IBaseLibraryModule

Parameters:

context - The execution context.

natureClass - : The class of the searched objects IWorkflowInstance, ITaskInstance, IResource}

Returns:

A IViewController object.

Throws:

LibraryModuleException - default module exception.

getViewController

@Deprecated
IViewController getViewController(InputStream inputStream)
                           throws LibraryModuleException

Deprecated.

use getViewController( IContext context, InputStream inputStream ) instead.

Gets a view controller to search IResource objects through their properties.

Specified by:

getViewController in interface IBaseLibraryModule

Parameters:

inputStream - The java.io.InputStream XML entry.

Returns:

A IViewController object.

Throws:

LibraryModuleException - default module exception.

getViewController

IViewController getViewController(IContext context,
 InputStream inputStream)
                           throws LibraryModuleException

Gets a view controller to search IResource objects through their properties.

Specified by:

getViewController in interface IBaseLibraryModule

Parameters:

context - The execution context.

inputStream - The java.io.InputStream XML entry.

Returns:

A IViewController object.

Throws:

LibraryModuleException - default module exception.

getSubscriptions

Collection<ILibrarySubscription> getSubscriptions(IContext context,
 ILibrary library,
 boolean showElementInTrash)
                                           throws LibraryModuleException

get all subscriptions for a user and a library

Specified by:

getSubscriptions in interface IBaseLibraryModule

Parameters:

context - user context

library - library scope

showElementInTrash - include subscribed elements that are in trash

Returns:

Collectioninvalid input: '<'{ @ link ILibrarySubscription }> subscriptions

Throws:

LibraryModuleException - default module exception

subscribe

void subscribe(IContext context,
 ILibrary library,
 ILibraryElement libraryElement)
        throws LibraryModuleException

Subscribe to a ILibraryElement (IFile, IFolder, ICategory)

Specified by:

subscribe in interface IBaseLibraryModule

Parameters:

context - user context

library - library scope

libraryElement - library element to subscribe

Throws:

LibraryModuleException - default module exception

unsubscribe

void unsubscribe(IContext context,
 ILibrary library,
 ILibraryElement libraryElement)
          throws LibraryModuleException

Unsubscribe to a ILibraryElement (IFile, IFolder, ICategory)

Specified by:

unsubscribe in interface IBaseLibraryModule

Parameters:

context - user context

library - library scope

libraryElement - library element to unsubscribe

Throws:

LibraryModuleException - default module exception

setSubscriptionRecursive

void setSubscriptionRecursive(IContext context,
 ILibrary library,
 ILibraryElement libraryElement)
                       throws LibraryModuleException

toggle subsription recursive flag

Specified by:

setSubscriptionRecursive in interface IBaseLibraryModule

Parameters:

context - user context

library - library scope

libraryElement - folder or category to set recursive flag to

Throws:

LibraryModuleException - default module exception

existSubscriptionByLibraryElement

boolean existSubscriptionByLibraryElement(IContext context,
 ILibraryElement libraryElement)
                                   throws LibraryModuleException

check if the ILibraryElement is subscribed by the user

Specified by:

existSubscriptionByLibraryElement in interface IBaseLibraryModule

Parameters:

context - user context

libraryElement - library element to check

Returns:

true if the user has subscribed to the ILibraryElement

Throws:

LibraryModuleException - default module exception

getSubscriptionFrequency

IBaseLibraryModule.SubscriptionFrequency getSubscriptionFrequency(IContext context,
 ILibrary library)
                                                           throws LibraryModuleException

Gets subscription frequency.

Specified by:

getSubscriptionFrequency in interface IBaseLibraryModule

Parameters:

context - the context

library - the library

Returns:

the subscription frequency

Throws:

LibraryModuleException - the library module exception

setSubscriptionFrequency

void setSubscriptionFrequency(IContext context,
 ILibrary library,
 IBaseLibraryModule.SubscriptionFrequency frequency)
                       throws LibraryModuleException

Sets subscription frequency.

Specified by:

setSubscriptionFrequency in interface IBaseLibraryModule

Parameters:

context - the context

library - the library

frequency - the frequency

Throws:

LibraryModuleException - the library module exception