public interface IBaseLibraryModule extends IModule
Code sample :
// creation of a library module object
IBaseLibraryModule libraryModule = Modules.getLibraryModule();
try
{
}
finally
{
// uninitialize the module
Modules.releaseModule(libraryModule);
}
Modifier and Type | Interface and Description |
---|---|
static class |
IBaseLibraryModule.SubscriptionFrequency
The possible subscription frequencies.
|
Modifier and Type | Method and Description |
---|---|
IAttachment |
addAttachment(IFile file,
File ioFile) |
IAttachment |
addAttachment(IFile file,
IAttachment attachment) |
IAttachment |
addAttachment(IFile file,
String fileName,
InputStream inputStream) |
IAttachment |
addAttachment(IFile file,
String fileName,
String fullPath) |
void |
addCategories(IContext context,
IFile file,
Collection categories) |
void |
addCategory(IContext context,
IFile file,
ICategory category) |
IUser |
checkedOutBy(IContext context,
IFile file) |
void |
checkIn(IContext context,
IFile file) |
void |
checkOut(IContext context,
IFile file) |
IFile |
copyTo(IContext context,
IFile file,
IFolder dest,
CopyOption... copyOptions)
Allows to copy a specified
IFile underneath a destination folder; |
IFile |
copyTo(IContext context,
IFile file,
ILibrary dest,
CopyOption... copyOptions)
|
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)
|
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)
|
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)
|
ICategory |
createCategory(IContext context,
ICategory category,
String name) |
ICategory |
createCategory(IContext context,
ILibrary library,
String name) |
ICategory |
createCategory(IContext context,
String name) |
IFile |
createFile(IContext context,
IFolder folder,
String description,
IAttachment attachment) |
IFile |
createFile(IContext context,
IFolder folder,
String name,
String description,
byte[] content) |
IFile |
createFile(IContext context,
IFolder folder,
String name,
String description,
InputStream content) |
IFile |
createFile(IContext context,
ILibrary library,
String description,
IAttachment attachment) |
IFile |
createFile(IContext context,
ILibrary library,
String name,
String description,
byte[] content) |
IFile |
createFile(IContext context,
ILibrary library,
String name,
String description,
InputStream content) |
IFolder |
createFolder(IContext context,
IFolder parent,
String name) |
IFolder |
createFolder(IContext context,
ILibrary library,
String name) |
ILibrary |
createLibrary(IContext context,
IOrganization organization,
String name)
Creates a library on a specified organization.
|
ILibrary |
createLibrary(IContext context,
String name)
Deprecated.
use createLibrary( IContext context, IOrganization organization, String name ) method instead.
|
IResourceDefinition |
createResourceDefinition(IContext context,
String name) |
void |
delete(IContext context,
IFile file)
Allow to delete a file.
|
void |
delete(IContext context,
IFolder folder)
Allow to delete a folder.
|
boolean |
existSubscriptionByLibraryElement(IContext context,
ILibraryElement libraryElement)
check if the
ILibraryElement is subscribed by the user |
void |
fireDownloadHistoryEvent(IContext context,
IFile file,
String protocol) |
IAttachment |
getAttachment(IFile file,
String fileName) |
Collection |
getAttachments(IFile file) |
Collection |
getCategories(IContext context,
ICategory category,
boolean recursive) |
Collection<ICategory> |
getCategories(IContext context,
ILibrary library,
boolean recursive) |
ICategory |
getCategory(IContext context,
ICategory category,
String name) |
ICategory |
getCategory(IContext context,
ILibrary library,
String name) |
ICategory |
getCategory(Object object) |
IProtocolSupport |
getElementByProtocolURI(String protocolURI)
Gets an
IElement object which implements IProtocolSupport interface. |
IFile |
getFile(IContext context,
IFolder folder,
String name) |
IFile |
getFile(IContext context,
ILibrary library,
String name) |
IFile |
getFile(IContext context,
String fileId) |
IFile |
getFile(Object object) |
IFile |
getFileByPath(IContext context,
ILibrary library,
String path) |
Collection |
getFiles(IContext context,
ICategory category)
Retrieves all the files associated with a specified
ICategory object. |
Collection |
getFiles(IContext context,
ICategory category,
boolean includeDeleted)
Retrieves all the files associated with a specified
ICategory object. |
Collection |
getFiles(IContext context,
IFolder parent) |
Collection |
getFiles(IContext context,
ILibrary library) |
IFolder |
getFolder(IContext context,
IFolder parent,
String name) |
IFolder |
getFolder(IContext context,
ILibrary library,
String name) |
IFolder |
getFolder(IContext context,
String folderId) |
IFolder |
getFolder(Object object) |
IFolder |
getFolderByPath(IContext context,
ILibrary library,
String path) |
Collection |
getFolders(IContext context,
IFolder parent) |
Collection |
getFolders(IContext context,
ILibrary library) |
Collection |
getLibraries(IContext context)
Retrieves all the libraries.
|
Collection |
getLibraries(IContext context,
IOrganization organization)
Retrieves all the libraries within a specified organization.
|
Collection |
getLibraries(IContext context,
String right)
Retrieves all the libraries.
|
ILibrary |
getLibrary(IContext context,
IFile file) |
ILibrary |
getLibrary(IContext context,
IFolder folder) |
ILibrary |
getLibrary(IContext context,
IOrganization organization,
String name)
Retrieves a
ILibrary within a specified organization. |
ILibrary |
getLibrary(IContext context,
String name)
Deprecated.
use getLibrary( IContext context, IOrganization organization, String name ) method instead.
|
ILibrary |
getLibrary(Object object) |
ILibrary |
getLibraryByPath(IContext context,
IOrganization organization,
String path)
Retrieves a library by its path.
|
IList |
getList(IContext context,
ILibrary library,
String name) |
Collection |
getLists(IContext context,
ILibrary library) |
ICategory |
getParentCategory(IContext context,
ICategory category) |
IFolder |
getParentFolder(IContext context,
IFile file) |
IFolder |
getParentFolder(IContext context,
IFolder folder) |
Collection |
getParentFolders(IContext context,
IFile file) |
Collection |
getParentFolders(IContext context,
IFolder folder) |
Collection |
getProperties(IContext context,
IResourceDefinition resourceDefinition) |
IProperty |
getProperty(IContext context,
IResourceDefinition resourceDefinition,
String name) |
IResourceDefinition |
getResourceDefinition(IContext context,
ILibrary library,
String name) |
IResourceDefinition |
getResourceDefinition(Object object) |
Collection<IResourceDefinition> |
getResourceDefinitions(IContext context,
ILibrary library) |
ISearchController |
getSearchController() |
ISearchController |
getSearchController(IConnectionDefinition connectionDefinition)
Gets a search controller object by specifying a ConnectionDefinition object.
|
ISearchController |
getSearchController(IDataSourceReference reference) |
ISearchController |
getSearchController(IJdbcReference reference)
Deprecated.
use getSearchController( IConnectionDefinition connectionDefinition ) method instead.
|
ISecurityController |
getSecurityController(ISecuritySupport securitySupport) |
IBaseLibraryModule.SubscriptionFrequency |
getSubscriptionFrequency(IContext context,
ILibrary library)
Gets subscription frequency.
|
Collection<ILibrarySubscription> |
getSubscriptions(IContext context,
ILibrary library,
boolean showElementInTrash)
get all subscriptions for a user and a library
|
ITransformer |
getTransformer() |
IUser |
getUser(Object object) |
IUser |
getUserByLogin(String login) |
Object |
getValue(IContext context,
IFile file,
String propertyName) |
IViewController |
getViewController()
Deprecated.
use getViewController( IContext context ) instead.
|
IViewController |
getViewController(Class natureClass)
Deprecated.
use getViewController( IContext context, Class natureClass ) instead.
|
IViewController |
getViewController(IContext context)
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(IContext context,
InputStream inputStream)
Gets a view controller to search
IResource objects through their properties. |
IViewController |
getViewController(InputStream inputStream)
Deprecated.
use getViewController( IContext context, InputStream inputStream ) instead.
|
boolean |
isCheckedOut(IContext context,
IFile file) |
boolean |
moveTo(IContext context,
IFile file,
IFolder destFolder,
boolean bOverwrite)
Allows to move a specified
IFile underneath a destination folder. |
boolean |
moveTo(IContext context,
IFile file,
ILibrary destLibrary,
boolean bOverwrite)
|
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)
|
void |
setSubscriptionFrequency(IContext context,
ILibrary library,
IBaseLibraryModule.SubscriptionFrequency frequency)
Sets subscription frequency.
|
void |
setSubscriptionRecursive(IContext context,
ILibrary library,
ILibraryElement libraryElement)
toggle subsription recursive flag
|
void |
setValue(IContext context,
IFile file,
String propertyName,
Object value) |
void |
subscribe(IContext context,
ILibrary library,
ILibraryElement libraryElement)
Subscribe to a
ILibraryElement (IFile, IFolder, ICategory) |
void |
undoCheckOut(IContext context,
IFile file) |
void |
unsubscribe(IContext context,
ILibrary library,
ILibraryElement libraryElement)
Unsubscribe to a
ILibraryElement (IFile, IFolder, ICategory) |
beginTransaction, beginTransaction, commitTransaction, commitTransaction, convertId, findNativeClass, generateSystemName, getAnonymous, getAnonymousContext, getContext, getContext, getContextByLogin, getElementFromExternalElement, getExternalElement, getExternalElement, getLoggedOnUser, getLoggedOnUserContext, getLoggedOnUserLanguage, getProtocolPath, getProtocolPath, getProtocolURI, getProtocolURI, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getStaticString, getSysadmin, getSysadminContext, getTranslation, getTranslationForLanguage, getTranslationKey, initialize, isTransactionActive, rollbackTransaction, rollbackTransaction, setTransactionTimeout, unInitialize
@Deprecated ILibrary createLibrary(IContext context, String name) throws LibraryModuleException
context
- The execution context.name
- The name of the library.ILibrary
object.LibraryModuleException
- default module exception.ILibrary createLibrary(IContext context, IOrganization organization, String name) throws LibraryModuleException
context
- The execution context.organization
- The IOrganization
object.name
- The name of the library.ILibrary
object.LibraryModuleException
- default module exception.@Deprecated ILibrary getLibrary(IContext context, String name) throws LibraryModuleException
ILibrary
.context
- The execution context.name
- The name of the library.ILibrary
object.LibraryModuleException
- default module exception.ILibrary getLibrary(IContext context, IOrganization organization, String name) throws LibraryModuleException
ILibrary
within a specified organization.context
- The execution context.organization
- The IOrganization
object.name
- The name of the library.ILibrary
object.LibraryModuleException
- default module exception.Collection getLibraries(IContext context) throws LibraryModuleException
context
- The execution context.ILibrary
objects.LibraryModuleException
- default module exception.Collection getLibraries(IContext context, String right) throws LibraryModuleException
context
- The execution context.right
- The right required.ILibrary
objects.LibraryModuleException
- default module exception.Collection getLibraries(IContext context, IOrganization organization) throws LibraryModuleException
context
- The execution context.organization
- The IOrganization
object.ILibrary
objects.LibraryModuleException
- default module exception.ILibrary getLibraryByPath(IContext context, IOrganization organization, String path) throws LibraryModuleException
context
- The execution context.organization
- The IOrganization
object.path
- The path to retrieve the organization from.ILibrary
object.LibraryModuleException
- default module exception.IResourceDefinition createResourceDefinition(IContext context, String name) throws LibraryModuleException
LibraryModuleException
IResourceDefinition getResourceDefinition(IContext context, ILibrary library, String name) throws LibraryModuleException
LibraryModuleException
Collection<IResourceDefinition> getResourceDefinitions(IContext context, ILibrary library) throws LibraryModuleException
LibraryModuleException
Collection getProperties(IContext context, IResourceDefinition resourceDefinition) throws LibraryModuleException
LibraryModuleException
IProperty getProperty(IContext context, IResourceDefinition resourceDefinition, String name) throws LibraryModuleException
LibraryModuleException
Collection getLists(IContext context, ILibrary library) throws LibraryModuleException
LibraryModuleException
IList getList(IContext context, ILibrary library, String name) throws LibraryModuleException
LibraryModuleException
ICategory getParentCategory(IContext context, ICategory category) throws LibraryModuleException
LibraryModuleException
ICategory createCategory(IContext context, String name) throws LibraryModuleException
LibraryModuleException
ICategory createCategory(IContext context, ILibrary library, String name) throws LibraryModuleException
LibraryModuleException
ICategory createCategory(IContext context, ICategory category, String name) throws LibraryModuleException
LibraryModuleException
ICategory getCategory(IContext context, ILibrary library, String name) throws LibraryModuleException
LibraryModuleException
ICategory getCategory(IContext context, ICategory category, String name) throws LibraryModuleException
LibraryModuleException
Collection<ICategory> getCategories(IContext context, ILibrary library, boolean recursive) throws LibraryModuleException
LibraryModuleException
Collection getCategories(IContext context, ICategory category, boolean recursive) throws LibraryModuleException
LibraryModuleException
IFolder createFolder(IContext context, ILibrary library, String name) throws LibraryModuleException
LibraryModuleException
IFolder createFolder(IContext context, IFolder parent, String name) throws LibraryModuleException
LibraryModuleException
void delete(IContext context, IFolder folder) throws LibraryModuleException
context
- The execution context.folder
- The folder to deleteLibrarySecurityException
- thrown when context has no writing rightsLibraryModuleException
- thrown on any internal errorIFolder getFolder(IContext context, ILibrary library, String name) throws LibraryModuleException
LibraryModuleException
IFolder getFolder(IContext context, IFolder parent, String name) throws LibraryModuleException
LibraryModuleException
Collection getFolders(IContext context, IFolder parent) throws LibraryModuleException
LibraryModuleException
Collection getFolders(IContext context, ILibrary library) throws LibraryModuleException
LibraryModuleException
IFolder getFolderByPath(IContext context, ILibrary library, String path) throws LibraryModuleException
LibraryModuleException
ILibrary getLibrary(IContext context, IFolder folder) throws LibraryModuleException
LibraryModuleException
IFolder getParentFolder(IContext context, IFolder folder) throws LibraryModuleException
LibraryModuleException
Collection getParentFolders(IContext context, IFolder folder) throws LibraryModuleException
LibraryModuleException
IFile createFile(IContext context, ILibrary library, String name, String description, byte[] content) throws LibraryModuleException
LibraryModuleException
IFile createFile(IContext context, ILibrary library, String name, String description, InputStream content) throws LibraryModuleException
LibraryModuleException
IFile createFile(IContext context, ILibrary library, String description, IAttachment attachment) throws LibraryModuleException
LibraryModuleException
IFile createFile(IContext context, IFolder folder, String name, String description, byte[] content) throws LibraryModuleException
LibraryModuleException
IFile createFile(IContext context, IFolder folder, String name, String description, InputStream content) throws LibraryModuleException
LibraryModuleException
IFile createFile(IContext context, IFolder folder, String description, IAttachment attachment) throws LibraryModuleException
LibraryModuleException
void delete(IContext context, IFile file) throws LibraryModuleException
context
- The execution context.file
- The file to deleteLibraryLockException
- thrown when file is checked out by another user.LibrarySecurityException
- thrown when context has no writing rightsLibraryModuleException
- thrown on any internal errorIFile getFile(IContext context, ILibrary library, String name) throws LibraryModuleException
LibraryModuleException
IFile getFile(IContext context, IFolder folder, String name) throws LibraryModuleException
LibraryModuleException
IFile getFileByPath(IContext context, ILibrary library, String path) throws LibraryModuleException
LibraryModuleException
Collection getFiles(IContext context, IFolder parent) throws LibraryModuleException
LibraryModuleException
Collection getFiles(IContext context, ILibrary library) throws LibraryModuleException
LibraryModuleException
Collection getFiles(IContext context, ICategory category) throws LibraryModuleException
ICategory
object.context
- The execution context.category
- The ICategory
object.IFile
objects.LibraryModuleException
Collection getFiles(IContext context, ICategory category, boolean includeDeleted) throws LibraryModuleException
ICategory
object. It allows to specify if the deleted files should be includedcontext
- The execution context.category
- The ICategory
object.includeDeleted
- The flag to include or not deleted IFile
objects.IFile
objects.LibraryModuleException
IFolder copyTo(IContext context, IFolder folder, ILibrary dest, CopyOption... copyOptions) throws LibraryModuleException
context
- The execution context.folder
- The IFolder
to copy.dest
- The destination ILibrary
object.LibraryModuleException
IFolder copyTo(IContext context, IFolder folder, String newName, ILibrary dest, CopyOption... copyOptions) throws LibraryModuleException
context
- The execution context.folder
- The IFolder
to copy.newName
- The new IFolder
name.dest
- The destination ILibrary
object.LibraryModuleException
IFolder copyTo(IContext context, IFolder folder, IFolder dest, CopyOption... copyOptions) throws LibraryModuleException
IFolder
underneath a destination folder;context
- The execution context.folder
- The IFolder
to copy.dest
- The destination IFolder
object.LibraryModuleException
IFolder copyTo(IContext context, IFolder folder, String newName, IFolder dest, CopyOption... copyOptions) throws LibraryModuleException
IFolder
underneath a destination folder;context
- The execution context.folder
- The IFolder
to copy.newName
- The new IFolder
name.dest
- The destination IFolder
object.LibraryModuleException
IFile copyTo(IContext context, IFile file, ILibrary dest, CopyOption... copyOptions) throws LibraryModuleException
context
- The execution context.file
- The IFile
to copy.dest
- The destination ILibrary
object.LibraryModuleException
IFile copyTo(IContext context, IFile file, String newName, ILibrary dest, CopyOption... copyOptions) throws LibraryModuleException
context
- The execution context.file
- The IFile
to copy.newName
- The new IFile
name.dest
- The destination ILibrary
object.LibraryModuleException
IFile copyTo(IContext context, IFile file, IFolder dest, CopyOption... copyOptions) throws LibraryModuleException
IFile
underneath a destination folder;context
- The execution context.file
- file The IFile
to copy.dest
- The destination IFolder
object.LibraryModuleException
IFile copyTo(IContext context, IFile file, String newName, IFolder dest, CopyOption... copyOptions) throws LibraryModuleException
IFile
underneath a destination folder;context
- The execution context.file
- file The IFile
to copy.dest
- The destination IFolder
object.LibraryModuleException
boolean moveTo(IContext context, IFolder folder, ILibrary destLibrary) throws LibraryModuleException
context
- The execution context.folder
- The IFolder
to move.destLibrary
- The destination ILibrary
object.LibraryModuleException
- The default exception.boolean moveTo(IContext context, IFolder folder, IFolder destFolder) throws LibraryModuleException
IFolder
underneath a destination folder.context
- The execution context.folder
- The IFolder
to move.destFolder
- The destination IFolder
object.LibraryModuleException
- The default exception.boolean moveTo(IContext context, IFile file, ILibrary destLibrary, boolean bOverwrite) throws LibraryModuleException
context
- The execution context.file
- The IFile
to move.destLibrary
- The destination ILibrary
object.LibraryModuleException
- The default exception.boolean moveTo(IContext context, IFile file, IFolder destFolder, boolean bOverwrite) throws LibraryModuleException
IFile
underneath a destination folder.context
- The execution context.file
- The IFile
to move.destFolder
- The destination IFolder
object.LibraryModuleException
- The default exception.ILibrary getLibrary(IContext context, IFile file) throws LibraryModuleException
LibraryModuleException
IFolder getParentFolder(IContext context, IFile file) throws LibraryModuleException
LibraryModuleException
Collection getParentFolders(IContext context, IFile file) throws LibraryModuleException
LibraryModuleException
IFile getFile(IContext context, String fileId) throws LibraryModuleException
LibraryModuleException
IFolder getFolder(IContext context, String folderId) throws LibraryModuleException
LibraryModuleException
Collection getAttachments(IFile file) throws LibraryModuleException
LibraryModuleException
IAttachment getAttachment(IFile file, String fileName) throws LibraryModuleException
LibraryModuleException
IAttachment addAttachment(IFile file, File ioFile) throws LibraryModuleException
LibraryModuleException
IAttachment addAttachment(IFile file, String fileName, InputStream inputStream) throws LibraryModuleException
LibraryModuleException
IAttachment addAttachment(IFile file, String fileName, String fullPath) throws LibraryModuleException
LibraryModuleException
IAttachment addAttachment(IFile file, IAttachment attachment) throws LibraryModuleException
LibraryModuleException
void fireDownloadHistoryEvent(IContext context, IFile file, String protocol) throws LibraryModuleException
LibraryModuleException
void setValue(IContext context, IFile file, String propertyName, Object value) throws LibraryModuleException
LibraryModuleException
Object getValue(IContext context, IFile file, String propertyName) throws LibraryModuleException
LibraryModuleException
void addCategory(IContext context, IFile file, ICategory category) throws LibraryModuleException
LibraryModuleException
void addCategories(IContext context, IFile file, Collection categories) throws LibraryModuleException
LibraryModuleException
void checkOut(IContext context, IFile file) throws LibraryModuleException
LibraryModuleException
void undoCheckOut(IContext context, IFile file) throws LibraryModuleException
LibraryModuleException
void checkIn(IContext context, IFile file) throws LibraryModuleException
LibraryModuleException
IUser checkedOutBy(IContext context, IFile file) throws LibraryModuleException
LibraryModuleException
boolean isCheckedOut(IContext context, IFile file) throws LibraryModuleException
LibraryModuleException
IUser getUser(Object object) throws LibraryModuleException
LibraryModuleException
ILibrary getLibrary(Object object) throws LibraryModuleException
LibraryModuleException
IFolder getFolder(Object object) throws LibraryModuleException
LibraryModuleException
IFile getFile(Object object) throws LibraryModuleException
LibraryModuleException
ICategory getCategory(Object object) throws LibraryModuleException
LibraryModuleException
IResourceDefinition getResourceDefinition(Object object) throws LibraryModuleException
LibraryModuleException
IProtocolSupport getElementByProtocolURI(String protocolURI) throws ModuleException
IElement
object which implements IProtocolSupport
interface.protocolURI
- The protocol URI as a java.lang.String.IProtocolSupport
object.ModuleException
- default module exception.ISearchController getSearchController() throws LibraryModuleException
LibraryModuleException
@Deprecated ISearchController getSearchController(IJdbcReference reference) throws LibraryModuleException
reference
- The IJdbcReference
object.ISearchController
object.LibraryModuleException
- default module exception.ISearchController getSearchController(IConnectionDefinition connectionDefinition) throws LibraryModuleException
connectionDefinition
- The IConnectionDefinition
object.ISearchController
object.LibraryModuleException
- default module exception.ISearchController getSearchController(IDataSourceReference reference) throws LibraryModuleException
LibraryModuleException
ISecurityController getSecurityController(ISecuritySupport securitySupport) throws LibraryModuleException
LibraryModuleException
ITransformer getTransformer() throws LibraryModuleException
LibraryModuleException
@Deprecated IViewController getViewController() throws LibraryModuleException
IResource
objects through their properties.IViewController
object.LibraryModuleException
- default module exception.IViewController getViewController(IContext context) throws LibraryModuleException
IResource
objects through their properties.context
- The execution context.IViewController
object.LibraryModuleException
- default module exception.@Deprecated IViewController getViewController(Class natureClass) throws LibraryModuleException
IResource
objects through their properties.natureClass
- : The class of the searched objects IWorkflowInstance
, ITaskInstance
, IResource
}IViewController
object.LibraryModuleException
- default module exception.IViewController getViewController(IContext context, Class natureClass) throws LibraryModuleException
IResource
objects through their properties.context
- The execution context.natureClass
- : The class of the searched objects IWorkflowInstance
, ITaskInstance
, IResource
}IViewController
object.LibraryModuleException
- default module exception.@Deprecated IViewController getViewController(InputStream inputStream) throws LibraryModuleException
IResource
objects through their properties.inputStream
- The java.io.InputStream XML entry.IViewController
object.LibraryModuleException
- default module exception.IViewController getViewController(IContext context, InputStream inputStream) throws LibraryModuleException
IResource
objects through their properties.context
- The execution context.inputStream
- The java.io.InputStream XML entry.IViewController
object.LibraryModuleException
- default module exception.Collection<ILibrarySubscription> getSubscriptions(IContext context, ILibrary library, boolean showElementInTrash) throws LibraryModuleException
context
- user contextlibrary
- library scopeshowElementInTrash
- include subscribed elements that are in trashILibrarySubscription
> subscriptionsLibraryModuleException
- default module exceptionvoid subscribe(IContext context, ILibrary library, ILibraryElement libraryElement) throws LibraryModuleException
ILibraryElement
(IFile, IFolder, ICategory)context
- user contextlibrary
- library scopelibraryElement
- library element to subscribeLibraryModuleException
- default module exceptionvoid unsubscribe(IContext context, ILibrary library, ILibraryElement libraryElement) throws LibraryModuleException
ILibraryElement
(IFile, IFolder, ICategory)context
- user contextlibrary
- library scopelibraryElement
- library element to unsubscribeLibraryModuleException
- default module exceptionvoid setSubscriptionRecursive(IContext context, ILibrary library, ILibraryElement libraryElement) throws LibraryModuleException
context
- user contextlibrary
- library scopelibraryElement
- folder or category to set recursive flag toLibraryModuleException
- default module exceptionboolean existSubscriptionByLibraryElement(IContext context, ILibraryElement libraryElement) throws LibraryModuleException
ILibraryElement
is subscribed by the usercontext
- user contextlibraryElement
- library element to checkILibraryElement
LibraryModuleException
- default module exceptionIBaseLibraryModule.SubscriptionFrequency getSubscriptionFrequency(IContext context, ILibrary library) throws LibraryModuleException
context
- the contextlibrary
- the libraryLibraryModuleException
- the library module exceptionvoid setSubscriptionFrequency(IContext context, ILibrary library, IBaseLibraryModule.SubscriptionFrequency frequency) throws LibraryModuleException
context
- the contextlibrary
- the libraryfrequency
- the frequencyLibraryModuleException
- the library module exceptionCopyright © 2022 Visiativ. All rights reserved.