Package com.axemble.vdoc.sdk.impl

Class PortalLibraryModule

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractTranslaterModule

com.axemble.vdoc.sdk.impl.PortalModule

com.axemble.vdoc.sdk.impl.PortalLibraryModule

All Implemented Interfaces:

IBaseLibraryModule, ILibraryModule, IModule, Remote

public class PortalLibraryModule
extends PortalModule
implements ILibraryModule

Author:

vlygeros

Nested Class Summary

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

IBaseLibraryModule.SubscriptionFrequency

Field Summary

Fields

Modifier and Type	Field	Description
protected static HashMap	nativeClasses
protected static final int	ONE_GIGA_OCTETS
protected static final int	ONE_KILO_OCTETS
protected static final int	ONE_MEGA_OCTETS
protected javax.jdo.PersistenceManager	persistenceManager

Fields inherited from class com.axemble.vdoc.sdk.impl.PortalModule

currentContext, report

Constructor Summary

Constructors

Constructor	Description
PortalLibraryModule()

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)
IReport	beginTransaction()	Starts a new transaction or use the current one.
IReport	beginTransaction(Object currentObject)	Starts a new transaction if required.
IUser	checkedOutBy(IContext context, IFile file)
void	checkIn(IContext context, IFile file)
void	checkOut(IContext context, IFile file)
void	commitTransaction()	Commits the current transaction.
void	commitTransaction(Object currentObject)	Commits the current transaction.
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 parent, 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 inputStream)
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 inputStream)
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)	Creates a library on the default organization
IResourceDefinition	createResourceDefinition(IContext context, String name)
IResourceDefinition	createResourceDefinition(IContext context, String name, String displayName, ILibrary library)
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
Class	findNativeClass(Class interfaceClass)	Allows to retrieve the inner native class.
void	fireDownloadHistoryEvent(IContext context, IFile file, String protocol)	Fire download history event on IFile
IAttachment	getAttachment(IFile file, String fileName)
IAttachment	getAttachment(IResourceHistory.ISnapshot snapshot)
Collection	getAttachments(IFile file)
Collection	getCategories(IContext context, ICategory category, boolean recursive)
Collection	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)
Collection<IElement>	getDeletedNodes(IContext context, ILibrary library)
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)	Retrieves the first ILibrary.
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)
protected static Class	getNativeClass(Class interfaceClass)
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)
javax.jdo.PersistenceManager	getPersistenceManager()
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	getResourceDefinitions(IContext context, ILibrary library)
IFolder	getRootFolder(ILibrary dest)
ISearchController	getSearchController()
ISearchController	getSearchController(IConnectionDefinition connectionDefinition)	Gets a search controller object by specifying a ConnectionDefinition object.
ISearchController	getSearchController(IDataSourceReference reference)
ISearchController	getSearchController(IJdbcReference reference)	Gets a search controller object by specifying a JDBC external reference.
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)
Object	getValue(IContext context, IFile file, String propertyName)
IViewController	getViewController()	Deprecated.
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)	Gets a view controller to search IResource objects through their properties.
IViewController	getViewController(Class natureClass)	Deprecated.
void	initialize(Properties properties)	Initializes the module.
boolean	isCheckedOut(IContext context, IFile file)
boolean	isTransactionActive()	Checks if there is a current transaction.
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	restore(IContext context, ILibrary library, IElement element)
void	rollbackTransaction()	Roll back the current transaction.
void	rollbackTransaction(Object currentObject)	Roll back the current transaction.
void	setSubscriptionFrequency(IContext context, ILibrary library, IBaseLibraryModule.SubscriptionFrequency frequency)	Sets subscription frequency.
void	setSubscriptionRecursive(IContext context, ILibrary library, ILibraryElement element)	toggle subsription recursive flag
void	setTransactionTimeout(int transactionTimeout)	Allows the set the transaction timeout.
void	setValue(IContext context, IFile file, String propertyName, Object value)
void	subscribe(IContext context, ILibrary library, ILibraryElement element)	Subscribe to a ILibraryElement (IFile, IFolder, ICategory)
void	undoCheckOut(IContext context, IFile file)
void	unInitialize()	Releases the module.
void	unsubscribe(IContext context, ILibrary library, ILibraryElement element)	Unsubscribe to a ILibraryElement (IFile, IFolder, ICategory)

Methods inherited from class com.axemble.vdoc.sdk.impl.PortalModule

convertId, generateSystemName, getAnonymous, getAnonymousContext, getContext, getContext, getContext, getContextByLogin, getCurrentContext, getElementFromExternalElement, getExternalElement, getExternalElement, getLanguage, getLoggedOnUser, getLoggedOnUserContext, getLoggedOnUserLanguage, getProtocolPath, getProtocolPath, getProtocolURI, getProtocolURI, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getSysadmin, getSysadminContext, getUser, getUser, getUserByLogin, refreshUser

Methods inherited from class com.axemble.vdoc.sdk.impl.AbstractTranslaterModule

getTranslation, getTranslationForLanguage, getTranslationKey

Methods inherited from class java.lang.Object

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

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

getUserByLogin

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

convertId, 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

Field Details

ONE_KILO_OCTETS

protected static final int ONE_KILO_OCTETS

See Also:

• Constant Field Values

ONE_MEGA_OCTETS

protected static final int ONE_MEGA_OCTETS

See Also:

• Constant Field Values

ONE_GIGA_OCTETS

protected static final int ONE_GIGA_OCTETS

See Also:

• Constant Field Values

nativeClasses

protected static HashMap nativeClasses

persistenceManager

protected javax.jdo.PersistenceManager persistenceManager

Constructor Details

PortalLibraryModule

public PortalLibraryModule()

Method Details

getNativeClass

protected static Class getNativeClass(Class interfaceClass)

initialize

public void initialize(Properties properties)

Description copied from interface: IModule

Initializes the module.

Specified by:

initialize in interface IModule

Parameters:

properties - The custom properties.

unInitialize

public void unInitialize()

Description copied from interface: IModule

Releases the module.

Specified by:

unInitialize in interface IModule

findNativeClass

public Class findNativeClass(Class interfaceClass)

Description copied from interface: IModule

Allows to retrieve the inner native class.

Specified by:

findNativeClass in interface IModule

Parameters:

interfaceClass - A class type.

Returns:

The inner native class.

getPersistenceManager

public javax.jdo.PersistenceManager getPersistenceManager()

Specified by:

getPersistenceManager in class PortalModule

setTransactionTimeout

public void setTransactionTimeout(int transactionTimeout)
                           throws ModuleException

Description copied from interface: IModule

Allows the set the transaction timeout.

Specified by:

setTransactionTimeout in interface IModule

Parameters:

transactionTimeout - The transaction timeout in milliseconds.

Throws:

ModuleException - The default exception.

beginTransaction

public IReport beginTransaction()

Description copied from interface: IModule

Starts a new transaction or use the current one.

Specified by:

beginTransaction in interface IModule

Returns:

The report object.

commitTransaction

public void commitTransaction()

Description copied from interface: IModule

Commits the current transaction.

Specified by:

commitTransaction in interface IModule

rollbackTransaction

public void rollbackTransaction()

Description copied from interface: IModule

Roll back the current transaction.

Specified by:

rollbackTransaction in interface IModule

beginTransaction

public IReport beginTransaction(Object currentObject)

Description copied from interface: IModule

Starts a new transaction if required.

Specified by:

beginTransaction in interface IModule

Parameters:

currentObject - The synchronized object. Not used anymore.

Returns:

The report object.

commitTransaction

public void commitTransaction(Object currentObject)

Description copied from interface: IModule

Commits the current transaction.

Specified by:

commitTransaction in interface IModule

Parameters:

currentObject - The synchronized object. Not used anymore.

rollbackTransaction

public void rollbackTransaction(Object currentObject)

Description copied from interface: IModule

Roll back the current transaction.

Specified by:

rollbackTransaction in interface IModule

Parameters:

currentObject - The synchronized object. Not used anymore.

isTransactionActive

public boolean isTransactionActive()

Description copied from interface: IModule

Checks if there is a current transaction.

Specified by:

isTransactionActive in interface IModule

Returns:

true if a transaction has been started, false otherwise.

createLibrary

public ILibrary createLibrary(IContext context,
 String name)
                       throws LibraryModuleException

Description copied from interface: IBaseLibraryModule

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

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

Description copied from interface: IBaseLibraryModule

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

public ILibrary getLibrary(IContext context,
 String name)
                    throws LibraryModuleException

Description copied from interface: IBaseLibraryModule

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

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

Description copied from interface: IBaseLibraryModule

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

public Collection getLibraries(IContext context)
                        throws LibraryModuleException

Description copied from interface: IBaseLibraryModule

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

public Collection getLibraries(IContext context,
 String right)
                        throws LibraryModuleException

Description copied from interface: IBaseLibraryModule

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

public Collection getLibraries(IContext context,
 IOrganization organization)
                        throws LibraryModuleException

Description copied from interface: IBaseLibraryModule

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.

createFolder

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

Specified by:

createFolder in interface IBaseLibraryModule

Throws:

LibraryModuleException

createFolder

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

Specified by:

createFolder in interface IBaseLibraryModule

Throws:

LibraryModuleException

delete

public void delete(IContext context,
 IFolder folder)
            throws LibraryModuleException

Description copied from interface: IBaseLibraryModule

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:

LibraryModuleException - thrown on any internal error

getFolder

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

Specified by:

getFolder in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFolder

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

Specified by:

getFolder in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFolders

public Collection getFolders(IContext context,
 IFolder parent)
                      throws LibraryModuleException

Specified by:

getFolders in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFolders

public Collection getFolders(IContext context,
 ILibrary library)
                      throws LibraryModuleException

Specified by:

getFolders in interface IBaseLibraryModule

Throws:

LibraryModuleException

getDeletedNodes

public Collection<IElement> getDeletedNodes(IContext context,
 ILibrary library)
                                     throws LibraryModuleException

Throws:

LibraryModuleException

getSubscriptions

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

Description copied from interface: IBaseLibraryModule

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

setSubscriptionRecursive

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

Description copied from interface: IBaseLibraryModule

toggle subsription recursive flag

Specified by:

setSubscriptionRecursive in interface IBaseLibraryModule

Parameters:

context - user context

library - library scope

element - folder or category to set recursive flag to

Throws:

LibraryModuleException - default module exception

subscribe

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

Description copied from interface: IBaseLibraryModule

Subscribe to a ILibraryElement (IFile, IFolder, ICategory)

Specified by:

subscribe in interface IBaseLibraryModule

Parameters:

context - user context

library - library scope

element - library element to subscribe

Throws:

LibraryModuleException - default module exception

existSubscriptionByLibraryElement

public boolean existSubscriptionByLibraryElement(IContext context,
 ILibraryElement libraryElement)

Description copied from interface: IBaseLibraryModule

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

getSubscriptionFrequency

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

Description copied from interface: IBaseLibraryModule

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

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

Description copied from interface: IBaseLibraryModule

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

unsubscribe

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

Description copied from interface: IBaseLibraryModule

Unsubscribe to a ILibraryElement (IFile, IFolder, ICategory)

Specified by:

unsubscribe in interface IBaseLibraryModule

Parameters:

context - user context

library - library scope

element - library element to unsubscribe

Throws:

LibraryModuleException - default module exception

restore

public void restore(IContext context,
 ILibrary library,
 IElement element)
             throws LibraryModuleException

Throws:

LibraryModuleException

createFile

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

Specified by:

createFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

createFile

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

Specified by:

createFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

createFile

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

Specified by:

createFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

createFile

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

Specified by:

createFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

createFile

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

Specified by:

createFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

createFile

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

Specified by:

createFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

delete

public void delete(IContext context,
 IFile file)
            throws LibraryModuleException

Description copied from interface: IBaseLibraryModule

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:

LibraryModuleException - thrown on any internal error

getFile

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

Specified by:

getFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFile

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

Specified by:

getFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFile

public IFile getFile(IContext context,
 String fileId)
              throws LibraryModuleException

Specified by:

getFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFolder

public IFolder getFolder(IContext context,
 String folderId)
                  throws LibraryModuleException

Specified by:

getFolder in interface IBaseLibraryModule

Throws:

LibraryModuleException

createResourceDefinition

public IResourceDefinition createResourceDefinition(IContext context,
 String name,
 String displayName,
 ILibrary library)
                                             throws LibraryModuleException

Throws:

LibraryModuleException

createResourceDefinition

public IResourceDefinition createResourceDefinition(IContext context,
 String name)
                                             throws LibraryModuleException

Specified by:

createResourceDefinition in interface IBaseLibraryModule

Throws:

LibraryModuleException

getResourceDefinition

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

Specified by:

getResourceDefinition in interface IBaseLibraryModule

Throws:

LibraryModuleException

getResourceDefinitions

public Collection getResourceDefinitions(IContext context,
 ILibrary library)
                                  throws LibraryModuleException

Specified by:

getResourceDefinitions in interface IBaseLibraryModule

Throws:

LibraryModuleException

createCategory

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

Specified by:

createCategory in interface IBaseLibraryModule

Throws:

LibraryModuleException

createCategory

public ICategory createCategory(IContext context,
 ICategory parent,
 String name)
                         throws LibraryModuleException

Specified by:

createCategory in interface IBaseLibraryModule

Throws:

LibraryModuleException

createCategory

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

Specified by:

createCategory in interface IBaseLibraryModule

Throws:

LibraryModuleException

getCategory

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

Specified by:

getCategory in interface IBaseLibraryModule

Throws:

LibraryModuleException

getCategory

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

Specified by:

getCategory in interface IBaseLibraryModule

Throws:

LibraryModuleException

getParentCategory

public ICategory getParentCategory(IContext context,
 ICategory category)
                            throws LibraryModuleException

Specified by:

getParentCategory in interface IBaseLibraryModule

Throws:

LibraryModuleException

getCategories

public Collection getCategories(IContext context,
 ILibrary library,
 boolean recursive)
                         throws LibraryModuleException

Specified by:

getCategories in interface IBaseLibraryModule

Throws:

LibraryModuleException

getCategories

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

Specified by:

getCategories in interface IBaseLibraryModule

Throws:

LibraryModuleException

addCategory

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

Specified by:

addCategory in interface IBaseLibraryModule

Throws:

LibraryModuleException

addCategories

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

Specified by:

addCategories in interface IBaseLibraryModule

Throws:

LibraryModuleException

setValue

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

Specified by:

setValue in interface IBaseLibraryModule

Throws:

LibraryModuleException

getValue

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

Specified by:

getValue in interface IBaseLibraryModule

Throws:

LibraryModuleException

getList

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

Specified by:

getList in interface IBaseLibraryModule

Throws:

LibraryModuleException

getLists

public Collection getLists(IContext context,
 ILibrary library)
                    throws LibraryModuleException

Specified by:

getLists in interface IBaseLibraryModule

Throws:

LibraryModuleException

getProperties

public Collection getProperties(IContext context,
 IResourceDefinition resourceDefinition)
                         throws LibraryModuleException

Specified by:

getProperties in interface IBaseLibraryModule

Throws:

LibraryModuleException

getProperty

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

Specified by:

getProperty in interface IBaseLibraryModule

Throws:

LibraryModuleException

getUser

public IUser getUser(Object object)
              throws LibraryModuleException

Specified by:

getUser in interface IBaseLibraryModule

Throws:

LibraryModuleException

addAttachment

public IAttachment addAttachment(IFile file,
 File ioFile)
                          throws LibraryModuleException

Specified by:

addAttachment in interface IBaseLibraryModule

Throws:

LibraryModuleException

addAttachment

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

Specified by:

addAttachment in interface IBaseLibraryModule

Throws:

LibraryModuleException

addAttachment

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

Specified by:

addAttachment in interface IBaseLibraryModule

Throws:

LibraryModuleException

addAttachment

public IAttachment addAttachment(IFile file,
 IAttachment attachment)
                          throws LibraryModuleException

Specified by:

addAttachment in interface IBaseLibraryModule

Throws:

LibraryModuleException

getAttachment

public IAttachment getAttachment(IFile file,
 String fileName)
                          throws LibraryModuleException

Specified by:

getAttachment in interface IBaseLibraryModule

Throws:

LibraryModuleException

getAttachment

public IAttachment getAttachment(IResourceHistory.ISnapshot snapshot)
                          throws LibraryModuleException

Throws:

LibraryModuleException

getAttachments

public Collection getAttachments(IFile file)
                          throws LibraryModuleException

Specified by:

getAttachments in interface IBaseLibraryModule

Throws:

LibraryModuleException

fireDownloadHistoryEvent

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

Fire download history event on IFile

Specified by:

fireDownloadHistoryEvent in interface IBaseLibraryModule

Parameters:

context - The current context

file - The downloaded IFile

protocol - The origin protocol

Throws:

LibraryModuleException

getSecurityController

public ISecurityController getSecurityController(ISecuritySupport securitySupport)
                                          throws LibraryModuleException

Specified by:

getSecurityController in interface IBaseLibraryModule

Throws:

LibraryModuleException

getSearchController

public ISearchController getSearchController(IDataSourceReference reference)
                                      throws LibraryModuleException

Specified by:

getSearchController in interface IBaseLibraryModule

Throws:

LibraryModuleException

getSearchController

public ISearchController getSearchController(IJdbcReference reference)
                                      throws LibraryModuleException

Description copied from interface: IBaseLibraryModule

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

public ISearchController getSearchController(IConnectionDefinition connectionDefinition)
                                      throws LibraryModuleException

Description copied from interface: IBaseLibraryModule

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

public ISearchController getSearchController()
                                      throws LibraryModuleException

Specified by:

getSearchController in interface IBaseLibraryModule

Throws:

LibraryModuleException

getResourceDefinition

public IResourceDefinition getResourceDefinition(Object object)
                                          throws LibraryModuleException

Specified by:

getResourceDefinition in interface IBaseLibraryModule

Throws:

LibraryModuleException

getLibrary

public ILibrary getLibrary(Object object)
                    throws LibraryModuleException

Specified by:

getLibrary in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFolder

public IFolder getFolder(Object object)
                  throws LibraryModuleException

Specified by:

getFolder in interface IBaseLibraryModule

Throws:

LibraryModuleException

getCategory

public ICategory getCategory(Object object)
                      throws LibraryModuleException

Specified by:

getCategory in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFile

public IFile getFile(Object object)
              throws LibraryModuleException

Specified by:

getFile in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFileByPath

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

Specified by:

getFileByPath in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFolderByPath

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

Specified by:

getFolderByPath in interface IBaseLibraryModule

Throws:

LibraryModuleException

getLibraryByPath

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

Description copied from interface: IBaseLibraryModule

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.

getTransformer

public ITransformer getTransformer()
                            throws LibraryModuleException

Specified by:

getTransformer in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFiles

public Collection getFiles(IContext context,
 ICategory category)
                    throws LibraryModuleException

Description copied from interface: IBaseLibraryModule

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

getFiles

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

Description copied from interface: IBaseLibraryModule

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

getFiles

public Collection getFiles(IContext context,
 IFolder parent)
                    throws LibraryModuleException

Specified by:

getFiles in interface IBaseLibraryModule

Throws:

LibraryModuleException

getFiles

public Collection getFiles(IContext context,
 ILibrary library)
                    throws LibraryModuleException

Specified by:

getFiles in interface IBaseLibraryModule

Throws:

LibraryModuleException

checkOut

public void checkOut(IContext context,
 IFile file)
              throws LibraryModuleException

Specified by:

checkOut in interface IBaseLibraryModule

Throws:

LibraryModuleException

undoCheckOut

public void undoCheckOut(IContext context,
 IFile file)
                  throws LibraryModuleException

Specified by:

undoCheckOut in interface IBaseLibraryModule

Throws:

LibraryModuleException

isCheckedOut

public boolean isCheckedOut(IContext context,
 IFile file)
                     throws LibraryModuleException

Specified by:

isCheckedOut in interface IBaseLibraryModule

Throws:

LibraryModuleException

checkedOutBy

public IUser checkedOutBy(IContext context,
 IFile file)
                   throws LibraryModuleException

Specified by:

checkedOutBy in interface IBaseLibraryModule

Throws:

LibraryModuleException

checkIn

public void checkIn(IContext context,
 IFile file)
             throws LibraryModuleException

Specified by:

checkIn in interface IBaseLibraryModule

Throws:

LibraryModuleException

getLibrary

public ILibrary getLibrary(IContext context,
 IFolder folder)
                    throws LibraryModuleException

Specified by:

getLibrary in interface IBaseLibraryModule

Throws:

LibraryModuleException

getLibrary

public ILibrary getLibrary(IContext context,
 IFile file)
                    throws LibraryModuleException

Specified by:

getLibrary in interface IBaseLibraryModule

Throws:

LibraryModuleException

getParentFolder

public IFolder getParentFolder(IContext context,
 IFolder folder)
                        throws LibraryModuleException

Specified by:

getParentFolder in interface IBaseLibraryModule

Throws:

LibraryModuleException

getParentFolder

public IFolder getParentFolder(IContext context,
 IFile file)
                        throws LibraryModuleException

Specified by:

getParentFolder in interface IBaseLibraryModule

Throws:

LibraryModuleException

getParentFolders

public Collection getParentFolders(IContext context,
 IFolder folder)
                            throws LibraryModuleException

Specified by:

getParentFolders in interface IBaseLibraryModule

Throws:

LibraryModuleException

getParentFolders

public Collection getParentFolders(IContext context,
 IFile file)
                            throws LibraryModuleException

Specified by:

getParentFolders in interface IBaseLibraryModule

Throws:

LibraryModuleException

copyTo

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

Description copied from interface: IBaseLibraryModule

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

copyTo

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

Description copied from interface: IBaseLibraryModule

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

copyTo

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

Description copied from interface: IBaseLibraryModule

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

copyTo

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

Description copied from interface: IBaseLibraryModule

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

copyTo

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

Description copied from interface: IBaseLibraryModule

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

copyTo

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

Description copied from interface: IBaseLibraryModule

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

copyTo

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

Description copied from interface: IBaseLibraryModule

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

copyTo

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

Description copied from interface: IBaseLibraryModule

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

moveTo

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

Description copied from interface: IBaseLibraryModule

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

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

Description copied from interface: IBaseLibraryModule

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

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

Description copied from interface: IBaseLibraryModule

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

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

Description copied from interface: IBaseLibraryModule

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.

getElementByProtocolURI

public IProtocolSupport getElementByProtocolURI(String protocolURI)
                                         throws ModuleException

Description copied from interface: IBaseLibraryModule

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.

getViewController

@Deprecated
public IViewController getViewController()
                                  throws LibraryModuleException

Deprecated.

Description copied from interface: IBaseLibraryModule

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

public IViewController getViewController(IContext context)
                                  throws LibraryModuleException

Description copied from interface: IBaseLibraryModule

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.

getRootFolder

public IFolder getRootFolder(ILibrary dest)

getViewController

@Deprecated
public IViewController getViewController(Class natureClass)
                                  throws LibraryModuleException

Deprecated.

Description copied from interface: IBaseLibraryModule

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

public IViewController getViewController(IContext context,
 Class natureClass)
                                  throws LibraryModuleException

Description copied from interface: IBaseLibraryModule

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

public IViewController getViewController(InputStream inputStream)
                                  throws LibraryModuleException

Description copied from interface: IBaseLibraryModule

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

public IViewController getViewController(IContext context,
 InputStream inputStream)
                                  throws LibraryModuleException

Description copied from interface: IBaseLibraryModule

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.