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
- Direct Known Subclasses:
CustomPortalLibraryModule
- Author:
- vlygeros
-
Nested Class Summary
Nested classes/interfaces inherited from interface com.axemble.vdoc.sdk.modules.IBaseLibraryModule
IBaseLibraryModule.SubscriptionFrequency -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringprotected static HashMapprotected static final intprotected static final intprotected static final intprotected javax.jdo.PersistenceManagerstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final Stringstatic final StringFields inherited from class com.axemble.vdoc.sdk.impl.PortalModule
currentContext, report -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaddAttachment(IFile file, IAttachment attachment) addAttachment(IFile file, File ioFile) addAttachment(IFile file, String fileName, InputStream inputStream) addAttachment(IFile file, String fileName, String fullPath) voidaddCategories(IContext context, IFile file, Collection categories) voidaddCategory(IContext context, IFile file, ICategory category) Starts a new transaction or use the current one.beginTransaction(Object currentObject) Starts a new transaction if required.checkedOutBy(IContext context, IFile file) voidvoidvoidCommits the current transaction.voidcommitTransaction(Object currentObject) Commits the current transaction.copyTo(IContext context, IFile file, IFolder dest, CopyOption... copyOptions) Allows to copy a specifiedIFileunderneath a destination folder;copyTo(IContext context, IFile file, ILibrary dest, CopyOption... copyOptions) Allows to copy a specifiedIFileunderneath a destination folder;copyTo(IContext context, IFolder folder, IFolder dest, CopyOption... copyOptions) Allows to copy a specifiedIFolderunderneath a destination folder;copyTo(IContext context, IFolder folder, ILibrary dest, CopyOption... copyOptions) Allows to copy a specifiedIFolderunderneath a destination folder;createCategory(IContext context, ICategory parent, String name) createCategory(IContext context, ILibrary library, String name) createCategory(IContext context, String name) createFile(IContext context, IFolder folder, String description, IAttachment attachment) createFile(IContext context, IFolder folder, String name, String description, byte[] content) createFile(IContext context, IFolder folder, String name, String description, InputStream inputStream) createFile(IContext context, ILibrary library, String description, IAttachment attachment) createFile(IContext context, ILibrary library, String name, String description, byte[] content) createFile(IContext context, ILibrary library, String name, String description, InputStream inputStream) createFolder(IContext context, IFolder parent, String name) createFolder(IContext context, ILibrary library, String name) createLibrary(IContext context, IOrganization organization, String name) Creates a library on a specified organization.createLibrary(IContext context, String name) Creates a library on the default organizationcreateResourceDefinition(IContext context, String name) createResourceDefinition(IContext context, String name, String displayName, ILibrary library) voidAllow to delete a file.voidAllow to delete a folder.booleanexistSubscriptionByLibraryElement(IContext context, ILibraryElement libraryElement) check if theILibraryElementis subscribed by the userfindNativeClass(Class interfaceClass) Allows to retrieve the inner native class.voidfireDownloadHistoryEvent(IContext context, IFile file, String protocol) Fire download history event on IFilegetAttachment(IFile file, String fileName) getAttachment(IResourceHistory.ISnapshot snapshot) getAttachments(IFile file) getCategories(IContext context, ICategory category, boolean recursive) getCategories(IContext context, ILibrary library, boolean recursive) getCategory(IContext context, ICategory category, String name) getCategory(IContext context, ILibrary library, String name) getCategory(Object object) getDeletedNodes(IContext context, ILibrary library) getElementByProtocolURI(String protocolURI) Gets anIElementobject which implementsIProtocolSupportinterface.getFileByPath(IContext context, ILibrary library, String path) Retrieves all the files associated with a specifiedICategoryobject.Retrieves all the files associated with a specifiedICategoryobject.getFolderByPath(IContext context, ILibrary library, String path) getFolders(IContext context, IFolder parent) getFolders(IContext context, ILibrary library) getLibraries(IContext context) Retrieves all the libraries.getLibraries(IContext context, IOrganization organization) Retrieves all the libraries within a specified organization.getLibraries(IContext context, String right) Retrieves all the libraries.getLibrary(IContext context, IFile file) getLibrary(IContext context, IFolder folder) getLibrary(IContext context, IOrganization organization, String name) Retrieves aILibrarywithin a specified organization.getLibrary(IContext context, String name) Retrieves the firstILibrary.getLibrary(Object object) getLibraryByPath(IContext context, IOrganization organization, String path) Retrieves a library by its path.protected static ClassgetNativeClass(Class interfaceClass) getParentCategory(IContext context, ICategory category) getParentFolder(IContext context, IFile file) getParentFolder(IContext context, IFolder folder) getParentFolders(IContext context, IFile file) getParentFolders(IContext context, IFolder folder) javax.jdo.PersistenceManagergetProperties(IContext context, IResourceDefinition resourceDefinition) getProperty(IContext context, IResourceDefinition resourceDefinition, String name) getResourceDefinition(IContext context, ILibrary library, String name) getResourceDefinition(Object object) getResourceDefinitions(IContext context, ILibrary library) getRootFolder(ILibrary dest) getSearchController(IConnectionDefinition connectionDefinition) Gets a search controller object by specifying a ConnectionDefinition object.getSearchController(IDataSourceReference reference) getSearchController(IJdbcReference reference) Gets a search controller object by specifying a JDBC external reference.getSecurityController(ISecuritySupport securitySupport) getSubscriptionFrequency(IContext context, ILibrary library) Gets subscription frequency.getSubscriptions(IContext context, ILibrary library, boolean showElementInTrash) get all subscriptions for a user and a libraryDeprecated.getViewController(IContext context) Gets a view controller to searchIResourceobjects through their properties.getViewController(IContext context, InputStream inputStream) Gets a view controller to searchIResourceobjects through their properties.getViewController(IContext context, Class natureClass) Gets a view controller to searchIResourceobjects through their properties.getViewController(InputStream inputStream) Gets a view controller to searchIResourceobjects through their properties.getViewController(Class natureClass) Deprecated.voidinitialize(Properties properties) Initializes the module.booleanisCheckedOut(IContext context, IFile file) booleanChecks if there is a current transaction.booleanAllows to move a specifiedIFileunderneath a destination folder.booleanbooleanAllows to move a specifiedIFolderunderneath a destination folder.booleanvoidvoidRoll back the current transaction.voidrollbackTransaction(Object currentObject) Roll back the current transaction.voidsetSubscriptionFrequency(IContext context, ILibrary library, IBaseLibraryModule.SubscriptionFrequency frequency) Sets subscription frequency.voidsetSubscriptionRecursive(IContext context, ILibrary library, ILibraryElement element) toggle subsription recursive flagvoidsetTransactionTimeout(int transactionTimeout) Allows the set the transaction timeout.voidvoidsubscribe(IContext context, ILibrary library, ILibraryElement element) Subscribe to aILibraryElement(IFile, IFolder, ICategory)voidundoCheckOut(IContext context, IFile file) voidReleases the module.voidunsubscribe(IContext context, ILibrary library, ILibraryElement element) Unsubscribe to aILibraryElement(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, refreshUserMethods inherited from class com.axemble.vdoc.sdk.impl.AbstractTranslaterModule
getTranslation, getTranslationForLanguage, getTranslationKeyMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.axemble.vdoc.sdk.modules.ILibraryModule
getUserByLoginMethods 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:
-
ONE_MEGA_OCTETS
protected static final int ONE_MEGA_OCTETS- See Also:
-
ONE_GIGA_OCTETS
protected static final int ONE_GIGA_OCTETS- See Also:
-
THE_FOLDER_IS_NULL
- See Also:
-
THE_CONTEXT_IS_NULL
- See Also:
-
THE_FILE_IS_NULL
- See Also:
-
THE_LIBRARY_IS_NULL
- See Also:
-
THE_TARGET_FOLDER_IS_NULL
- See Also:
-
NAME_ASCENDING
- See Also:
-
WRITE
- See Also:
-
nativeClasses
-
persistenceManager
protected javax.jdo.PersistenceManager persistenceManager
-
-
Constructor Details
-
PortalLibraryModule
public PortalLibraryModule()
-
-
Method Details
-
getNativeClass
-
initialize
Description copied from interface:IModuleInitializes the module.- Specified by:
initializein interfaceIModule- Parameters:
properties- The custom properties.
-
unInitialize
public void unInitialize()Description copied from interface:IModuleReleases the module.- Specified by:
unInitializein interfaceIModule
-
findNativeClass
Description copied from interface:IModuleAllows to retrieve the inner native class.- Specified by:
findNativeClassin interfaceIModule- Parameters:
interfaceClass- A class type.- Returns:
- The inner native class.
-
getPersistenceManager
public javax.jdo.PersistenceManager getPersistenceManager()- Specified by:
getPersistenceManagerin classPortalModule
-
setTransactionTimeout
Description copied from interface:IModuleAllows the set the transaction timeout.- Specified by:
setTransactionTimeoutin interfaceIModule- Parameters:
transactionTimeout- The transaction timeout in milliseconds.- Throws:
ModuleException- The default exception.
-
beginTransaction
Description copied from interface:IModuleStarts a new transaction or use the current one.- Specified by:
beginTransactionin interfaceIModule- Returns:
- The report object.
-
commitTransaction
public void commitTransaction()Description copied from interface:IModuleCommits the current transaction.- Specified by:
commitTransactionin interfaceIModule
-
rollbackTransaction
public void rollbackTransaction()Description copied from interface:IModuleRoll back the current transaction.- Specified by:
rollbackTransactionin interfaceIModule
-
beginTransaction
Description copied from interface:IModuleStarts a new transaction if required.- Specified by:
beginTransactionin interfaceIModule- Parameters:
currentObject- The synchronized object. Not used anymore.- Returns:
- The report object.
-
commitTransaction
Description copied from interface:IModuleCommits the current transaction.- Specified by:
commitTransactionin interfaceIModule- Parameters:
currentObject- The synchronized object. Not used anymore.
-
rollbackTransaction
Description copied from interface:IModuleRoll back the current transaction.- Specified by:
rollbackTransactionin interfaceIModule- Parameters:
currentObject- The synchronized object. Not used anymore.
-
isTransactionActive
public boolean isTransactionActive()Description copied from interface:IModuleChecks if there is a current transaction.- Specified by:
isTransactionActivein interfaceIModule- Returns:
- true if a transaction has been started, false otherwise.
-
createLibrary
Description copied from interface:ILibraryModuleCreates a library on the default organization- Specified by:
createLibraryin interfaceIBaseLibraryModule- Specified by:
createLibraryin interfaceILibraryModule- Parameters:
context- The execution context.name- The name of the library.- Returns:
- a
ILibraryobject. - Throws:
LibraryModuleException- default module exception.
-
createLibrary
public ILibrary createLibrary(IContext context, IOrganization organization, String name) throws LibraryModuleException Description copied from interface:ILibraryModuleCreates a library on a specified organization.- Specified by:
createLibraryin interfaceIBaseLibraryModule- Specified by:
createLibraryin interfaceILibraryModule- Parameters:
context- The execution context.organization- TheIOrganizationobject.name- The name of the library.- Returns:
- a
ILibraryobject. - Throws:
LibraryModuleException- default module exception.
-
getLibrary
Description copied from interface:ILibraryModuleRetrieves the firstILibrary.- Specified by:
getLibraryin interfaceIBaseLibraryModule- Specified by:
getLibraryin interfaceILibraryModule- Parameters:
context- The execution context.name- The name of the library.- Returns:
- a
ILibraryobject. - Throws:
LibraryModuleException- default module exception.
-
getLibrary
public ILibrary getLibrary(IContext context, IOrganization organization, String name) throws LibraryModuleException Description copied from interface:ILibraryModuleRetrieves aILibrarywithin a specified organization.- Specified by:
getLibraryin interfaceIBaseLibraryModule- Specified by:
getLibraryin interfaceILibraryModule- Parameters:
context- The execution context.organization- TheIOrganizationobject.name- The name of the library.- Returns:
- A
ILibraryobject. - Throws:
LibraryModuleException- default module exception.
-
getLibraries
Description copied from interface:ILibraryModuleRetrieves all the libraries.- Specified by:
getLibrariesin interfaceIBaseLibraryModule- Specified by:
getLibrariesin interfaceILibraryModule- Parameters:
context- The execution context.- Returns:
- A java.util.Collection of
ILibraryobjects. - Throws:
LibraryModuleException- default module exception.
-
getLibraries
Description copied from interface:ILibraryModuleRetrieves all the libraries.- Specified by:
getLibrariesin interfaceIBaseLibraryModule- Specified by:
getLibrariesin interfaceILibraryModule- Parameters:
context- The execution context.right- The right required.- Returns:
- A java.util.Collection of
ILibraryobjects. - Throws:
LibraryModuleException- default module exception.
-
getLibraries
public Collection getLibraries(IContext context, IOrganization organization) throws LibraryModuleException Description copied from interface:ILibraryModuleRetrieves all the libraries within a specified organization.- Specified by:
getLibrariesin interfaceIBaseLibraryModule- Specified by:
getLibrariesin interfaceILibraryModule- Parameters:
context- The execution context.organization- TheIOrganizationobject.- Returns:
- A java.util.Collection of
ILibraryobjects. - Throws:
LibraryModuleException- default module exception.
-
createFolder
public IFolder createFolder(IContext context, IFolder parent, String name) throws LibraryModuleException - Specified by:
createFolderin interfaceIBaseLibraryModule- Specified by:
createFolderin interfaceILibraryModule- Throws:
LibraryModuleException
-
createFolder
public IFolder createFolder(IContext context, ILibrary library, String name) throws LibraryModuleException - Specified by:
createFolderin interfaceIBaseLibraryModule- Specified by:
createFolderin interfaceILibraryModule- Throws:
LibraryModuleException
-
delete
Description copied from interface:ILibraryModuleAllow to delete a folder. If used on a folder in the trash this will delete it from trash.- Specified by:
deletein interfaceIBaseLibraryModule- Specified by:
deletein interfaceILibraryModule- 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:
getFolderin interfaceIBaseLibraryModule- Specified by:
getFolderin interfaceILibraryModule- Throws:
LibraryModuleException
-
getFolder
public IFolder getFolder(IContext context, IFolder parent, String name) throws LibraryModuleException - Specified by:
getFolderin interfaceIBaseLibraryModule- Specified by:
getFolderin interfaceILibraryModule- Throws:
LibraryModuleException
-
getFolders
- Specified by:
getFoldersin interfaceIBaseLibraryModule- Specified by:
getFoldersin interfaceILibraryModule- Throws:
LibraryModuleException
-
getFolders
- Specified by:
getFoldersin interfaceIBaseLibraryModule- Specified by:
getFoldersin interfaceILibraryModule- 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:ILibraryModuleget all subscriptions for a user and a library- Specified by:
getSubscriptionsin interfaceIBaseLibraryModule- Specified by:
getSubscriptionsin interfaceILibraryModule- Parameters:
context- user contextlibrary- library scopeshowElementInTrash- 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:ILibraryModuletoggle subsription recursive flag- Specified by:
setSubscriptionRecursivein interfaceIBaseLibraryModule- Specified by:
setSubscriptionRecursivein interfaceILibraryModule- Parameters:
context- user contextlibrary- library scopeelement- 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:ILibraryModuleSubscribe to aILibraryElement(IFile, IFolder, ICategory)- Specified by:
subscribein interfaceIBaseLibraryModule- Specified by:
subscribein interfaceILibraryModule- Parameters:
context- user contextlibrary- library scopeelement- library element to subscribe- Throws:
LibraryModuleException- default module exception
-
existSubscriptionByLibraryElement
Description copied from interface:ILibraryModulecheck if theILibraryElementis subscribed by the user- Specified by:
existSubscriptionByLibraryElementin interfaceIBaseLibraryModule- Specified by:
existSubscriptionByLibraryElementin interfaceILibraryModule- Parameters:
context- user contextlibraryElement- 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:ILibraryModuleGets subscription frequency.- Specified by:
getSubscriptionFrequencyin interfaceIBaseLibraryModule- Specified by:
getSubscriptionFrequencyin interfaceILibraryModule- Parameters:
context- the contextlibrary- 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:ILibraryModuleSets subscription frequency.- Specified by:
setSubscriptionFrequencyin interfaceIBaseLibraryModule- Specified by:
setSubscriptionFrequencyin interfaceILibraryModule- Parameters:
context- the contextlibrary- the libraryfrequency- the frequency- Throws:
LibraryModuleException- the library module exception
-
unsubscribe
public void unsubscribe(IContext context, ILibrary library, ILibraryElement element) throws LibraryModuleException Description copied from interface:ILibraryModuleUnsubscribe to aILibraryElement(IFile, IFolder, ICategory)- Specified by:
unsubscribein interfaceIBaseLibraryModule- Specified by:
unsubscribein interfaceILibraryModule- Parameters:
context- user contextlibrary- library scopeelement- 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:
createFilein interfaceIBaseLibraryModule- Specified by:
createFilein interfaceILibraryModule- Throws:
LibraryModuleException
-
createFile
public IFile createFile(IContext context, IFolder folder, String name, String description, InputStream inputStream) throws LibraryModuleException - Specified by:
createFilein interfaceIBaseLibraryModule- Specified by:
createFilein interfaceILibraryModule- Throws:
LibraryModuleException
-
createFile
public IFile createFile(IContext context, IFolder folder, String name, String description, byte[] content) throws LibraryModuleException - Specified by:
createFilein interfaceIBaseLibraryModule- Specified by:
createFilein interfaceILibraryModule- Throws:
LibraryModuleException
-
createFile
public IFile createFile(IContext context, IFolder folder, String description, IAttachment attachment) throws LibraryModuleException - Specified by:
createFilein interfaceIBaseLibraryModule- Specified by:
createFilein interfaceILibraryModule- Throws:
LibraryModuleException
-
createFile
public IFile createFile(IContext context, ILibrary library, String description, IAttachment attachment) throws LibraryModuleException - Specified by:
createFilein interfaceIBaseLibraryModule- Specified by:
createFilein interfaceILibraryModule- Throws:
LibraryModuleException
-
createFile
public IFile createFile(IContext context, ILibrary library, String name, String description, byte[] content) throws LibraryModuleException - Specified by:
createFilein interfaceIBaseLibraryModule- Specified by:
createFilein interfaceILibraryModule- Throws:
LibraryModuleException
-
delete
Description copied from interface:ILibraryModuleAllow to delete a file. If used on a file in the trash this will delete it from trash.- Specified by:
deletein interfaceIBaseLibraryModule- Specified by:
deletein interfaceILibraryModule- Parameters:
context- The execution context.file- The file to delete- Throws:
LibraryModuleException- thrown on any internal error
-
getFile
- Specified by:
getFilein interfaceIBaseLibraryModule- Specified by:
getFilein interfaceILibraryModule- Throws:
LibraryModuleException
-
getFile
- Specified by:
getFilein interfaceIBaseLibraryModule- Specified by:
getFilein interfaceILibraryModule- Throws:
LibraryModuleException
-
getFile
- Specified by:
getFilein interfaceIBaseLibraryModule- Specified by:
getFilein interfaceILibraryModule- Throws:
LibraryModuleException
-
getFolder
- Specified by:
getFolderin interfaceIBaseLibraryModule- Specified by:
getFolderin interfaceILibraryModule- 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:
createResourceDefinitionin interfaceIBaseLibraryModule- Specified by:
createResourceDefinitionin interfaceILibraryModule- Throws:
LibraryModuleException
-
getResourceDefinition
public IResourceDefinition getResourceDefinition(IContext context, ILibrary library, String name) throws LibraryModuleException - Specified by:
getResourceDefinitionin interfaceIBaseLibraryModule- Specified by:
getResourceDefinitionin interfaceILibraryModule- Throws:
LibraryModuleException
-
getResourceDefinitions
public Collection getResourceDefinitions(IContext context, ILibrary library) throws LibraryModuleException - Specified by:
getResourceDefinitionsin interfaceIBaseLibraryModule- Specified by:
getResourceDefinitionsin interfaceILibraryModule- Throws:
LibraryModuleException
-
createCategory
- Specified by:
createCategoryin interfaceIBaseLibraryModule- Specified by:
createCategoryin interfaceILibraryModule- Throws:
LibraryModuleException
-
createCategory
public ICategory createCategory(IContext context, ICategory parent, String name) throws LibraryModuleException - Specified by:
createCategoryin interfaceIBaseLibraryModule- Specified by:
createCategoryin interfaceILibraryModule- Throws:
LibraryModuleException
-
createCategory
public ICategory createCategory(IContext context, ILibrary library, String name) throws LibraryModuleException - Specified by:
createCategoryin interfaceIBaseLibraryModule- Specified by:
createCategoryin interfaceILibraryModule- Throws:
LibraryModuleException
-
getCategory
public ICategory getCategory(IContext context, ILibrary library, String name) throws LibraryModuleException - Specified by:
getCategoryin interfaceIBaseLibraryModule- Specified by:
getCategoryin interfaceILibraryModule- Throws:
LibraryModuleException
-
getCategory
public ICategory getCategory(IContext context, ICategory category, String name) throws LibraryModuleException - Specified by:
getCategoryin interfaceIBaseLibraryModule- Specified by:
getCategoryin interfaceILibraryModule- Throws:
LibraryModuleException
-
getParentCategory
public ICategory getParentCategory(IContext context, ICategory category) throws LibraryModuleException - Specified by:
getParentCategoryin interfaceIBaseLibraryModule- Specified by:
getParentCategoryin interfaceILibraryModule- Throws:
LibraryModuleException
-
getCategories
public Collection getCategories(IContext context, ILibrary library, boolean recursive) throws LibraryModuleException - Specified by:
getCategoriesin interfaceIBaseLibraryModule- Specified by:
getCategoriesin interfaceILibraryModule- Throws:
LibraryModuleException
-
getCategories
public Collection getCategories(IContext context, ICategory category, boolean recursive) throws LibraryModuleException - Specified by:
getCategoriesin interfaceIBaseLibraryModule- Specified by:
getCategoriesin interfaceILibraryModule- Throws:
LibraryModuleException
-
addCategory
public void addCategory(IContext context, IFile file, ICategory category) throws LibraryModuleException - Specified by:
addCategoryin interfaceIBaseLibraryModule- Specified by:
addCategoryin interfaceILibraryModule- Throws:
LibraryModuleException
-
addCategories
public void addCategories(IContext context, IFile file, Collection categories) throws LibraryModuleException - Specified by:
addCategoriesin interfaceIBaseLibraryModule- Specified by:
addCategoriesin interfaceILibraryModule- Throws:
LibraryModuleException
-
setValue
public void setValue(IContext context, IFile file, String propertyName, Object value) throws LibraryModuleException - Specified by:
setValuein interfaceIBaseLibraryModule- Specified by:
setValuein interfaceILibraryModule- Throws:
LibraryModuleException
-
getValue
public Object getValue(IContext context, IFile file, String propertyName) throws LibraryModuleException - Specified by:
getValuein interfaceIBaseLibraryModule- Specified by:
getValuein interfaceILibraryModule- Throws:
LibraryModuleException
-
getList
- Specified by:
getListin interfaceIBaseLibraryModule- Specified by:
getListin interfaceILibraryModule- Throws:
LibraryModuleException
-
getLists
- Specified by:
getListsin interfaceIBaseLibraryModule- Specified by:
getListsin interfaceILibraryModule- Throws:
LibraryModuleException
-
getProperties
public Collection getProperties(IContext context, IResourceDefinition resourceDefinition) throws LibraryModuleException - Specified by:
getPropertiesin interfaceIBaseLibraryModule- Specified by:
getPropertiesin interfaceILibraryModule- Throws:
LibraryModuleException
-
getProperty
public IProperty getProperty(IContext context, IResourceDefinition resourceDefinition, String name) throws LibraryModuleException - Specified by:
getPropertyin interfaceIBaseLibraryModule- Specified by:
getPropertyin interfaceILibraryModule- Throws:
LibraryModuleException
-
getUser
- Specified by:
getUserin interfaceIBaseLibraryModule- Specified by:
getUserin interfaceILibraryModule- Throws:
LibraryModuleException
-
addAttachment
- Specified by:
addAttachmentin interfaceIBaseLibraryModule- Specified by:
addAttachmentin interfaceILibraryModule- Throws:
LibraryModuleException
-
addAttachment
public IAttachment addAttachment(IFile file, String fileName, InputStream inputStream) throws LibraryModuleException - Specified by:
addAttachmentin interfaceIBaseLibraryModule- Specified by:
addAttachmentin interfaceILibraryModule- Throws:
LibraryModuleException
-
addAttachment
public IAttachment addAttachment(IFile file, String fileName, String fullPath) throws LibraryModuleException - Specified by:
addAttachmentin interfaceIBaseLibraryModule- Specified by:
addAttachmentin interfaceILibraryModule- Throws:
LibraryModuleException
-
addAttachment
- Specified by:
addAttachmentin interfaceIBaseLibraryModule- Specified by:
addAttachmentin interfaceILibraryModule- Throws:
LibraryModuleException
-
getAttachment
- Specified by:
getAttachmentin interfaceIBaseLibraryModule- Specified by:
getAttachmentin interfaceILibraryModule- Throws:
LibraryModuleException
-
getAttachment
- Throws:
LibraryModuleException
-
getAttachments
- Specified by:
getAttachmentsin interfaceIBaseLibraryModule- Specified by:
getAttachmentsin interfaceILibraryModule- Throws:
LibraryModuleException
-
fireDownloadHistoryEvent
public void fireDownloadHistoryEvent(IContext context, IFile file, String protocol) throws LibraryModuleException Fire download history event on IFile- Specified by:
fireDownloadHistoryEventin interfaceIBaseLibraryModule- Specified by:
fireDownloadHistoryEventin interfaceILibraryModule- Parameters:
context- The current contextfile- The downloaded IFileprotocol- The origin protocol- Throws:
LibraryModuleException
-
getSecurityController
public ISecurityController getSecurityController(ISecuritySupport securitySupport) throws LibraryModuleException - Specified by:
getSecurityControllerin interfaceIBaseLibraryModule- Specified by:
getSecurityControllerin interfaceILibraryModule- Throws:
LibraryModuleException
-
getSearchController
public ISearchController getSearchController(IDataSourceReference reference) throws LibraryModuleException - Specified by:
getSearchControllerin interfaceIBaseLibraryModule- Specified by:
getSearchControllerin interfaceILibraryModule- Throws:
LibraryModuleException
-
getSearchController
public ISearchController getSearchController(IJdbcReference reference) throws LibraryModuleException Description copied from interface:ILibraryModuleGets a search controller object by specifying a JDBC external reference.- Specified by:
getSearchControllerin interfaceIBaseLibraryModule- Specified by:
getSearchControllerin interfaceILibraryModule- Parameters:
reference- TheIJdbcReferenceobject.- Returns:
- The
ISearchControllerobject. - Throws:
LibraryModuleException- default module exception.
-
getSearchController
public ISearchController getSearchController(IConnectionDefinition connectionDefinition) throws LibraryModuleException Description copied from interface:ILibraryModuleGets a search controller object by specifying a ConnectionDefinition object.- Specified by:
getSearchControllerin interfaceIBaseLibraryModule- Specified by:
getSearchControllerin interfaceILibraryModule- Parameters:
connectionDefinition- TheIConnectionDefinitionobject.- Returns:
- The
ISearchControllerobject. - Throws:
LibraryModuleException- default module exception.
-
getSearchController
- Specified by:
getSearchControllerin interfaceIBaseLibraryModule- Specified by:
getSearchControllerin interfaceILibraryModule- Throws:
LibraryModuleException
-
getResourceDefinition
- Specified by:
getResourceDefinitionin interfaceIBaseLibraryModule- Specified by:
getResourceDefinitionin interfaceILibraryModule- Throws:
LibraryModuleException
-
getLibrary
- Specified by:
getLibraryin interfaceIBaseLibraryModule- Specified by:
getLibraryin interfaceILibraryModule- Throws:
LibraryModuleException
-
getFolder
- Specified by:
getFolderin interfaceIBaseLibraryModule- Specified by:
getFolderin interfaceILibraryModule- Throws:
LibraryModuleException
-
getCategory
- Specified by:
getCategoryin interfaceIBaseLibraryModule- Specified by:
getCategoryin interfaceILibraryModule- Throws:
LibraryModuleException
-
getFile
- Specified by:
getFilein interfaceIBaseLibraryModule- Specified by:
getFilein interfaceILibraryModule- Throws:
LibraryModuleException
-
getFileByPath
public IFile getFileByPath(IContext context, ILibrary library, String path) throws LibraryModuleException - Specified by:
getFileByPathin interfaceIBaseLibraryModule- Specified by:
getFileByPathin interfaceILibraryModule- Throws:
LibraryModuleException
-
getFolderByPath
public IFolder getFolderByPath(IContext context, ILibrary library, String path) throws LibraryModuleException - Specified by:
getFolderByPathin interfaceIBaseLibraryModule- Specified by:
getFolderByPathin interfaceILibraryModule- Throws:
LibraryModuleException
-
getLibraryByPath
public ILibrary getLibraryByPath(IContext context, IOrganization organization, String path) throws LibraryModuleException Description copied from interface:ILibraryModuleRetrieves a library by its path.- Specified by:
getLibraryByPathin interfaceIBaseLibraryModule- Specified by:
getLibraryByPathin interfaceILibraryModule- Parameters:
context- The execution context.organization- TheIOrganizationobject.path- The path to retrieve the organization from.- Returns:
- A
ILibraryobject. - Throws:
LibraryModuleException- default module exception.
-
getTransformer
- Specified by:
getTransformerin interfaceIBaseLibraryModule- Specified by:
getTransformerin interfaceILibraryModule- Throws:
LibraryModuleException
-
getFiles
Description copied from interface:ILibraryModuleRetrieves all the files associated with a specifiedICategoryobject.- Specified by:
getFilesin interfaceIBaseLibraryModule- Specified by:
getFilesin interfaceILibraryModule- Parameters:
context- The execution context.category- TheICategoryobject.- Returns:
- a collection of
IFileobjects. - Throws:
LibraryModuleException- default module exception.
-
getFiles
public Collection getFiles(IContext context, ICategory category, boolean includeDeleted) throws LibraryModuleException Description copied from interface:ILibraryModuleRetrieves all the files associated with a specifiedICategoryobject. It allows to specify if the deleted files should be included- Specified by:
getFilesin interfaceIBaseLibraryModule- Specified by:
getFilesin interfaceILibraryModule- Parameters:
context- The execution context.category- TheICategoryobject.includeDeleted- The flag to include or not deletedIFileobjects.- Returns:
- a collection of
IFileobjects. - Throws:
LibraryModuleException- default module exception.
-
getFiles
- Specified by:
getFilesin interfaceIBaseLibraryModule- Specified by:
getFilesin interfaceILibraryModule- Throws:
LibraryModuleException
-
getFiles
- Specified by:
getFilesin interfaceIBaseLibraryModule- Specified by:
getFilesin interfaceILibraryModule- Throws:
LibraryModuleException
-
checkOut
- Specified by:
checkOutin interfaceIBaseLibraryModule- Specified by:
checkOutin interfaceILibraryModule- Throws:
LibraryModuleException
-
undoCheckOut
- Specified by:
undoCheckOutin interfaceIBaseLibraryModule- Specified by:
undoCheckOutin interfaceILibraryModule- Throws:
LibraryModuleException
-
isCheckedOut
- Specified by:
isCheckedOutin interfaceIBaseLibraryModule- Specified by:
isCheckedOutin interfaceILibraryModule- Throws:
LibraryModuleException
-
checkedOutBy
- Specified by:
checkedOutByin interfaceIBaseLibraryModule- Specified by:
checkedOutByin interfaceILibraryModule- Throws:
LibraryModuleException
-
checkIn
- Specified by:
checkInin interfaceIBaseLibraryModule- Specified by:
checkInin interfaceILibraryModule- Throws:
LibraryModuleException
-
getLibrary
- Specified by:
getLibraryin interfaceIBaseLibraryModule- Specified by:
getLibraryin interfaceILibraryModule- Throws:
LibraryModuleException
-
getLibrary
- Specified by:
getLibraryin interfaceIBaseLibraryModule- Specified by:
getLibraryin interfaceILibraryModule- Throws:
LibraryModuleException
-
getParentFolder
- Specified by:
getParentFolderin interfaceIBaseLibraryModule- Specified by:
getParentFolderin interfaceILibraryModule- Throws:
LibraryModuleException
-
getParentFolder
- Specified by:
getParentFolderin interfaceIBaseLibraryModule- Specified by:
getParentFolderin interfaceILibraryModule- Throws:
LibraryModuleException
-
getParentFolders
- Specified by:
getParentFoldersin interfaceIBaseLibraryModule- Specified by:
getParentFoldersin interfaceILibraryModule- Throws:
LibraryModuleException
-
getParentFolders
- Specified by:
getParentFoldersin interfaceIBaseLibraryModule- Specified by:
getParentFoldersin interfaceILibraryModule- Throws:
LibraryModuleException
-
copyTo
public IFolder copyTo(IContext context, IFolder folder, ILibrary dest, CopyOption... copyOptions) throws LibraryModuleException Description copied from interface:ILibraryModule- Specified by:
copyToin interfaceIBaseLibraryModule- Specified by:
copyToin interfaceILibraryModule- Parameters:
context- The execution context.folder- TheIFolderto copy.dest- The destinationILibraryobject.- Returns:
- the newly created folder
- Throws:
LibraryModuleException- default module exception.
-
copyTo
public IFolder copyTo(IContext context, IFolder folder, String newName, ILibrary dest, CopyOption... copyOptions) throws LibraryModuleException Description copied from interface:ILibraryModule- Specified by:
copyToin interfaceIBaseLibraryModule- Specified by:
copyToin interfaceILibraryModule- Parameters:
context- The execution context.folder- TheIFolderto copy.newName- The newIFoldername.dest- The destinationILibraryobject.- Returns:
- the newly created folder
- Throws:
LibraryModuleException- default module exception.
-
copyTo
public IFolder copyTo(IContext context, IFolder folder, IFolder dest, CopyOption... copyOptions) throws LibraryModuleException Description copied from interface:ILibraryModuleAllows to copy a specifiedIFolderunderneath a destination folder;- Specified by:
copyToin interfaceIBaseLibraryModule- Specified by:
copyToin interfaceILibraryModule- Parameters:
context- The execution context.folder- TheIFolderto copy.dest- The destinationIFolderobject.- Returns:
- the newly created folder
- Throws:
LibraryModuleException- default module exception.
-
copyTo
public IFolder copyTo(IContext context, IFolder folder, String newName, IFolder dest, CopyOption... copyOptions) throws LibraryModuleException Description copied from interface:ILibraryModuleAllows to copy a specifiedIFolderunderneath a destination folder;- Specified by:
copyToin interfaceIBaseLibraryModule- Specified by:
copyToin interfaceILibraryModule- Parameters:
context- The execution context.folder- TheIFolderto copy.newName- The newIFoldername.dest- The destinationIFolderobject.- Returns:
- the newly created folder
- Throws:
LibraryModuleException- default module exception.
-
copyTo
public IFile copyTo(IContext context, IFile file, ILibrary dest, CopyOption... copyOptions) throws LibraryModuleException Description copied from interface:ILibraryModule- Specified by:
copyToin interfaceIBaseLibraryModule- Specified by:
copyToin interfaceILibraryModule- Parameters:
context- The execution context.file- TheIFileto copy.dest- The destinationILibraryobject.- Returns:
- the newly created file
- Throws:
LibraryModuleException- default module exception.
-
copyTo
public IFile copyTo(IContext context, IFile file, String newName, ILibrary dest, CopyOption... copyOptions) throws LibraryModuleException Description copied from interface:ILibraryModule- Specified by:
copyToin interfaceIBaseLibraryModule- Specified by:
copyToin interfaceILibraryModule- Parameters:
context- The execution context.file- TheIFileto copy.newName- The newIFilename.dest- The destinationILibraryobject.- Returns:
- the newly created file
- Throws:
LibraryModuleException- default module exception.
-
copyTo
public IFile copyTo(IContext context, IFile file, IFolder dest, CopyOption... copyOptions) throws LibraryModuleException Description copied from interface:ILibraryModuleAllows to copy a specifiedIFileunderneath a destination folder;- Specified by:
copyToin interfaceIBaseLibraryModule- Specified by:
copyToin interfaceILibraryModule- Parameters:
context- The execution context.file- file TheIFileto copy.dest- The destinationIFolderobject.- Returns:
- the newly created file
- Throws:
LibraryModuleException- default module exception.
-
copyTo
public IFile copyTo(IContext context, IFile file, String newName, IFolder dest, CopyOption... copyOptions) throws LibraryModuleException Description copied from interface:ILibraryModuleAllows to copy a specifiedIFileunderneath a destination folder;- Specified by:
copyToin interfaceIBaseLibraryModule- Specified by:
copyToin interfaceILibraryModule- Parameters:
context- The execution context.file- file TheIFileto copy.dest- The destinationIFolderobject.- Returns:
- the newly created file
- Throws:
LibraryModuleException- default module exception.
-
moveTo
public boolean moveTo(IContext context, IFolder folder, ILibrary destLibrary) throws LibraryModuleException Description copied from interface:ILibraryModule- Specified by:
moveToin interfaceIBaseLibraryModule- Specified by:
moveToin interfaceILibraryModule- Parameters:
context- The execution context.folder- TheIFolderto move.destLibrary- The destinationILibraryobject.- 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:ILibraryModuleAllows to move a specifiedIFolderunderneath a destination folder.- Specified by:
moveToin interfaceIBaseLibraryModule- Specified by:
moveToin interfaceILibraryModule- Parameters:
context- The execution context.folder- TheIFolderto move.destFolder- The destinationIFolderobject.- 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:ILibraryModule- Specified by:
moveToin interfaceIBaseLibraryModule- Specified by:
moveToin interfaceILibraryModule- Parameters:
context- The execution context.file- TheIFileto move.destLibrary- The destinationILibraryobject.- 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:ILibraryModuleAllows to move a specifiedIFileunderneath a destination folder.- Specified by:
moveToin interfaceIBaseLibraryModule- Specified by:
moveToin interfaceILibraryModule- Parameters:
context- The execution context.file- TheIFileto move.destFolder- The destinationIFolderobject.- Returns:
- true if the file has been moved, false otherwise.
- Throws:
LibraryModuleException- The default exception.
-
getElementByProtocolURI
Description copied from interface:ILibraryModuleGets anIElementobject which implementsIProtocolSupportinterface.- Specified by:
getElementByProtocolURIin interfaceIBaseLibraryModule- Specified by:
getElementByProtocolURIin interfaceILibraryModule- Parameters:
protocolURI- The protocol URI as a java.lang.String.- Returns:
- A
IProtocolSupportobject. - Throws:
ModuleException- default module exception.
-
getViewController
Deprecated.Description copied from interface:ILibraryModuleGets a view controller to searchIResourceobjects through their properties.- Specified by:
getViewControllerin interfaceIBaseLibraryModule- Specified by:
getViewControllerin interfaceILibraryModule- Returns:
- A
IViewControllerobject. - Throws:
LibraryModuleException- default module exception.
-
getViewController
Description copied from interface:ILibraryModuleGets a view controller to searchIResourceobjects through their properties.- Specified by:
getViewControllerin interfaceIBaseLibraryModule- Specified by:
getViewControllerin interfaceILibraryModule- Parameters:
context- The execution context.- Returns:
- A
IViewControllerobject. - Throws:
LibraryModuleException- default module exception.
-
getRootFolder
-
getViewController
@Deprecated public IViewController getViewController(Class natureClass) throws LibraryModuleException Deprecated.Description copied from interface:ILibraryModuleGets a view controller to searchIResourceobjects through their properties.- Specified by:
getViewControllerin interfaceIBaseLibraryModule- Specified by:
getViewControllerin interfaceILibraryModule- Parameters:
natureClass- : The class of the searched objectsIWorkflowInstance,ITaskInstance,IResource}- Returns:
- A
IViewControllerobject. - Throws:
LibraryModuleException- default module exception.
-
getViewController
public IViewController getViewController(IContext context, Class natureClass) throws LibraryModuleException Description copied from interface:ILibraryModuleGets a view controller to searchIResourceobjects through their properties.- Specified by:
getViewControllerin interfaceIBaseLibraryModule- Specified by:
getViewControllerin interfaceILibraryModule- Parameters:
context- The execution context.natureClass- : The class of the searched objectsIWorkflowInstance,ITaskInstance,IResource}- Returns:
- A
IViewControllerobject. - Throws:
LibraryModuleException- default module exception.
-
getViewController
Description copied from interface:ILibraryModuleGets a view controller to searchIResourceobjects through their properties.- Specified by:
getViewControllerin interfaceIBaseLibraryModule- Specified by:
getViewControllerin interfaceILibraryModule- Parameters:
inputStream- The java.io.InputStream XML entry.- Returns:
- A
IViewControllerobject. - Throws:
LibraryModuleException- default module exception.
-
getViewController
public IViewController getViewController(IContext context, InputStream inputStream) throws LibraryModuleException Description copied from interface:ILibraryModuleGets a view controller to searchIResourceobjects through their properties.- Specified by:
getViewControllerin interfaceIBaseLibraryModule- Specified by:
getViewControllerin interfaceILibraryModule- Parameters:
context- The execution context.inputStream- The java.io.InputStream XML entry.- Returns:
- A
IViewControllerobject. - Throws:
LibraryModuleException- default module exception.
-