Package com.axemble.vdoc.sdk.impl

Class PortalLibrary

java.lang.Object
com.axemble.vdoc.sdk.impl.AbstractElement
com.axemble.vdoc.sdk.impl.PortalElement
com.axemble.vdoc.sdk.impl.PortalLibrary
All Implemented Interfaces:
IElement, ILibrary, IDeletionSupport, IExternalSupport, IProtocolSupport, ISearchSupport, ISecuritySupport, Serializable
public class PortalLibrary extends PortalElement implements ILibrary
Portal library (classic ILibrary implementation for Process)
Author:
vlygeros
See Also:

  • Field Details

    • store

      protected com.axemble.webdrive.om.DataStore store

  • Constructor Details

    • PortalLibrary

      protected PortalLibrary(IModule module, com.axemble.webdrive.jdo.beans.JDODataStore store)

    • PortalLibrary

      protected PortalLibrary(IModule module, com.axemble.webdrive.om.DataStore store)

  • Method Details

    • getNativeObject

      public Object getNativeObject()
      Description copied from interface: IElement
      Gets the native object underneath.
      Specified by:
      getNativeObject in interface IElement
      Returns:
      an object.

    • getExternalClassName

      public String getExternalClassName()
      Specified by:
      getExternalClassName in interface IExternalSupport

    • getExternalNativeId

      public String getExternalNativeId()
      Specified by:
      getExternalNativeId in interface IExternalSupport

    • getName

      public String getName()
      Description copied from interface: ILibrary
      Gets the name of the library.
      Specified by:
      getName in interface ILibrary
      Returns:
      The name of the library.

    • setName

      public void setName(String name)
      Description copied from interface: ILibrary
      Sets the name of the library.
      Specified by:
      setName in interface ILibrary
      Parameters:
      name - The new name to set to the library.

    • getAllFolders

      public Collection<IFolder> getAllFolders(IContext iContext)
      Description copied from interface: ILibrary
      Gets off the folders.
      Specified by:
      getAllFolders in interface ILibrary
      Parameters:
      iContext - The user context.
      Returns:
      A java.util.Collection of IFolder objects.

    • getFolders

      public Collection<IFolder> getFolders(IContext iContext)
      Description copied from interface: ILibrary
      Gets all the folders at the root level.
      Specified by:
      getFolders in interface ILibrary
      Parameters:
      iContext - The user context.
      Returns:
      A java.util.Collection of IFolder objects.

    • getAllCategories

      public Collection<ICategory> getAllCategories()
      Description copied from interface: ILibrary
      Gets all the categories.
      Specified by:
      getAllCategories in interface ILibrary
      Returns:
      A java.util.Collection of ICategory objects.

    • getCategories

      public Collection<ICategory> getCategories()
      Description copied from interface: ILibrary
      Gets all the root categories.
      Specified by:
      getCategories in interface ILibrary
      Returns:
      A java.util.Collection of ICategory objects.

    • getFileDefinitions

      public Collection getFileDefinitions()
      Description copied from interface: ILibrary
      Gets the file definitions.
      Specified by:
      getFileDefinitions in interface ILibrary
      Returns:
      A java.util.Collection of IResourceDefinition objects.

    • getPhysicalPath

      public String getPhysicalPath()
      Description copied from interface: ILibrary
      Retrieves the physical path of the library.
      Specified by:
      getPhysicalPath in interface ILibrary
      Returns:
      The physical path.

    • delete

      public void delete(IContext context)
      Description copied from interface: IDeletionSupport
      Deletes the IElement object.
      Specified by:
      delete in interface IDeletionSupport
      Parameters:
      context - The Execution context.

    • getOrganization

      public IOrganization getOrganization()
      Description copied from interface: ILibrary
      Gets the organization.
      Specified by:
      getOrganization in interface ILibrary
      Returns:
      A IOrganization object.

    • setOrganization

      public void setOrganization(IOrganization organization)
      Description copied from interface: ILibrary
      Sets the organization.
      Specified by:
      setOrganization in interface ILibrary
      Parameters:
      organization - The IOrganization object.

    • getForbiddenExtensions

      public String getForbiddenExtensions()
      Description copied from interface: ILibrary
      Gets the list of forbidden extensions.
      Specified by:
      getForbiddenExtensions in interface ILibrary
      Returns:
      The list of forbidden extensions.

    • setForbiddenExtensions

      public void setForbiddenExtensions(String forbiddenExtensions)
      Description copied from interface: ILibrary
      Sets the list of forbidden extensions.
      Specified by:
      setForbiddenExtensions in interface ILibrary
      Parameters:
      forbiddenExtensions - The forbidden extensions.

    • getAlertEventListeners

      public String getAlertEventListeners()
      Description copied from interface: ILibrary
      Gets the email addresses to notify when the alert size is reached.
      Specified by:
      getAlertEventListeners in interface ILibrary
      Returns:
      The email addresses.

    • getAlertSize

      public int getAlertSize()
      Description copied from interface: ILibrary
      Gets the alert size in bytes.
      Specified by:
      getAlertSize in interface ILibrary
      Returns:
      The size in bytes.

    • getMaxFileSize

      public long getMaxFileSize()
      Description copied from interface: ILibrary
      Gets the maximum size of a file.
      Specified by:
      getMaxFileSize in interface ILibrary
      Returns:
      The maximum size of a file in bytes.

    • getMaxSize

      public long getMaxSize()
      Description copied from interface: ILibrary
      Gets the maximum size available for a library.
      Specified by:
      getMaxSize in interface ILibrary
      Returns:
      The maximum size in bytes.

    • getMaxSizeEventListeners

      public String getMaxSizeEventListeners()
      Description copied from interface: ILibrary
      Gets the email addresses to notify if the maximum size is reached.
      Specified by:
      getMaxSizeEventListeners in interface ILibrary
      Returns:
      The email addresses.

    • setAlertEventListeners

      public void setAlertEventListeners(String emails)
      Description copied from interface: ILibrary
      Sets the email addresses to notify when the alert size is reached.
      Specified by:
      setAlertEventListeners in interface ILibrary
      Parameters:
      emails - The email addresses.

    • setAlertSize

      public void setAlertSize(int alertSize)
      Description copied from interface: ILibrary
      Sets the alert size.
      Specified by:
      setAlertSize in interface ILibrary
      Parameters:
      alertSize - The size in bytes.

    • setMaxFileSize

      public void setMaxFileSize(long maxFileSize)
      Description copied from interface: ILibrary
      Sets the maximum size for a file.
      Specified by:
      setMaxFileSize in interface ILibrary
      Parameters:
      maxFileSize - The file size in bytes.

    • setMaxSize

      public void setMaxSize(long maxSize)
      Description copied from interface: ILibrary
      Sets the maximum size available.
      Specified by:
      setMaxSize in interface ILibrary
      Parameters:
      maxSize - The maximum size.

    • setMaxSizeEventListeners

      public void setMaxSizeEventListeners(String emails)
      Description copied from interface: ILibrary
      Sets the email addresses to notify when the maximum size is reached.
      Specified by:
      setMaxSizeEventListeners in interface ILibrary
      Parameters:
      emails - The email addresses.

    • setPhysicalPath

      public void setPhysicalPath(String path)
      Description copied from interface: ILibrary
      Sets the physical path of the library
      Specified by:
      setPhysicalPath in interface ILibrary
      Parameters:
      path - The physical path.

    • getCurrentSize

      public long getCurrentSize()
      Description copied from interface: ILibrary
      Gets the current size.
      Specified by:
      getCurrentSize in interface ILibrary
      Returns:
      The size in bytes.

    • getLargestFileSize

      public long getLargestFileSize()
      Description copied from interface: ILibrary
      Gets the largest file size.
      Specified by:
      getLargestFileSize in interface ILibrary
      Returns:
      The size in bytes.

    • getNumberOfElements

      public long getNumberOfElements()
      Description copied from interface: ILibrary
      The number of elements.
      Specified by:
      getNumberOfElements in interface ILibrary
      Returns:
      The number of elements.

    • getNumberOfElements

      public long getNumberOfElements(Class natureClass)
      Description copied from interface: ILibrary
      The number of elements of a specific class.
      Specified by:
      getNumberOfElements in interface ILibrary
      Parameters:
      natureClass - The nature.
      Returns:
      The number of elements.

    • getSmallestFileSize

      public long getSmallestFileSize()
      Description copied from interface: ILibrary
      Gets the smallest file size.
      Specified by:
      getSmallestFileSize in interface ILibrary
      Returns:
      The size in bytes.

    • allowHistoryEvents

      public void allowHistoryEvents()
      Description copied from interface: ILibrary
      Allows to log history events.
      Specified by:
      allowHistoryEvents in interface ILibrary

    • denyHistoryEvents

      public void denyHistoryEvents()
      Description copied from interface: ILibrary
      Allows to stop logging history events.
      Specified by:
      denyHistoryEvents in interface ILibrary

    • setHistoryEvents

      public void setHistoryEvents(boolean enabled)

    • isHistoryEnabled

      public boolean isHistoryEnabled()
      Description copied from interface: ILibrary
      History activation status
      Specified by:
      isHistoryEnabled in interface ILibrary
      Returns:
      The status of history.

    • isIndexationEnable

      public boolean isIndexationEnable()
      Description copied from interface: ILibrary
      Check if the datastore must be indexed
      Specified by:
      isIndexationEnable in interface ILibrary
      Returns:
      true if the datastore must be indexed, false if not

    • setIndexationEnable

      public void setIndexationEnable(boolean indexationEnable)
      Description copied from interface: ILibrary
      Sets the indexation state of the datastore
      Specified by:
      setIndexationEnable in interface ILibrary
      Parameters:
      indexationEnable - true if the datastore must be indexed, false if not

    • getAuthorizedExtensions

      public String getAuthorizedExtensions()
      Description copied from interface: ILibrary
      Gets the list of authorized extensions.
      Specified by:
      getAuthorizedExtensions in interface ILibrary
      Returns:
      The list of authorized extensions.

    • setAuthorizedExtensions

      public void setAuthorizedExtensions(String authorizedExtensions)
      Description copied from interface: ILibrary
      Sets the list of authorized extensions.
      Specified by:
      setAuthorizedExtensions in interface ILibrary
      Parameters:
      authorizedExtensions - The authorized extensions.