Package com.axemble.vdoc.sdk.interfaces

Interface ILibrary

All Superinterfaces:
IDeletionSupport, IElement, IExternalSupport, IProtocolSupport, ISearchSupport, ISecuritySupport, Serializable
All Known Implementing Classes:
PortalLibrary
public interface ILibrary extends IElement, IDeletionSupport, IExternalSupport, ISecuritySupport, ISearchSupport, IProtocolSupport
The library object within the library system.
Since:
1.0, 10/05/2008
Author:
vlygeros
See Also:

  • Method Details Link icon

    • getName Link icon

      String getName()
      Gets the name of the library.
      Returns:
      The name of the library.

    • setName Link icon

      void setName(String name)
      Sets the name of the library.
      Parameters:
      name - The new name to set to the library.

    • getPhysicalPath Link icon

      String getPhysicalPath()
      Retrieves the physical path of the library.
      Returns:
      The physical path.

    • setPhysicalPath Link icon

      void setPhysicalPath(String path)
      Sets the physical path of the library
      Parameters:
      path - The physical path.

    • getMaxFileSize Link icon

      long getMaxFileSize()
      Gets the maximum size of a file.
      Returns:
      The maximum size of a file in bytes.

    • setMaxFileSize Link icon

      void setMaxFileSize(long maximumFileSize)
      Sets the maximum size for a file.
      Parameters:
      maximumFileSize - The file size in bytes.

    • getMaxSize Link icon

      long getMaxSize()
      Gets the maximum size available for a library.
      Returns:
      The maximum size in bytes.

    • setMaxSize Link icon

      void setMaxSize(long maxSize)
      Sets the maximum size available.
      Parameters:
      maxSize - The maximum size.

    • getMaxSizeEventListeners Link icon

      String getMaxSizeEventListeners()
      Gets the email addresses to notify if the maximum size is reached.
      Returns:
      The email addresses.

    • setMaxSizeEventListeners Link icon

      void setMaxSizeEventListeners(String emails)
      Sets the email addresses to notify when the maximum size is reached.
      Parameters:
      emails - The email addresses.

    • getAlertSize Link icon

      int getAlertSize()
      Gets the alert size in bytes.
      Returns:
      The size in bytes.

    • setAlertSize Link icon

      void setAlertSize(int alertSize)
      Sets the alert size.
      Parameters:
      alertSize - The size in bytes.

    • getAlertEventListeners Link icon

      String getAlertEventListeners()
      Gets the email addresses to notify when the alert size is reached.
      Returns:
      The email addresses.

    • setAlertEventListeners Link icon

      void setAlertEventListeners(String emails)
      Sets the email addresses to notify when the alert size is reached.
      Parameters:
      emails - The email addresses.

    • getForbiddenExtensions Link icon

      String getForbiddenExtensions()
      Gets the list of forbidden extensions.
      Returns:
      The list of forbidden extensions.

    • setForbiddenExtensions Link icon

      void setForbiddenExtensions(String forbiddenExtensions)
      Sets the list of forbidden extensions.
      Parameters:
      forbiddenExtensions - The forbidden extensions.

    • getAllFolders Link icon

      Collection<IFolder> getAllFolders(IContext iContext)
      Gets off the folders.
      Parameters:
      iContext - The user context.
      Returns:
      A java.util.Collection of IFolder objects.

    • getFolders Link icon

      Collection<IFolder> getFolders(IContext iContext)
      Gets all the folders at the root level.
      Parameters:
      iContext - The user context.
      Returns:
      A java.util.Collection of IFolder objects.

    • getAllCategories Link icon

      Collection<ICategory> getAllCategories()
      Gets all the categories.
      Returns:
      A java.util.Collection of ICategory objects.

    • getCategories Link icon

      Collection<ICategory> getCategories()
      Gets all the root categories.
      Returns:
      A java.util.Collection of ICategory objects.

    • getFileDefinitions Link icon

      Collection<IResourceDefinition> getFileDefinitions()
      Gets the file definitions.
      Returns:
      A java.util.Collection of IResourceDefinition objects.

    • getOrganization Link icon

      IOrganization getOrganization()
      Gets the organization.
      Returns:
      A IOrganization object.

    • setOrganization Link icon

      void setOrganization(IOrganization organization)
      Sets the organization.
      Parameters:
      organization - The IOrganization object.

    • getCurrentSize Link icon

      long getCurrentSize()
      Gets the current size.
      Returns:
      The size in bytes.

    • getLargestFileSize Link icon

      long getLargestFileSize()
      Gets the largest file size.
      Returns:
      The size in bytes.

    • getSmallestFileSize Link icon

      long getSmallestFileSize()
      Gets the smallest file size.
      Returns:
      The size in bytes.

    • getNumberOfElements Link icon

      long getNumberOfElements()
      The number of elements.
      Returns:
      The number of elements.

    • getNumberOfElements Link icon

      long getNumberOfElements(Class natureClass)
      The number of elements of a specific class.
      Parameters:
      natureClass - The nature.
      Returns:
      The number of elements.

    • allowHistoryEvents Link icon

      void allowHistoryEvents()
      Allows to log history events.

    • denyHistoryEvents Link icon

      void denyHistoryEvents()
      Allows to stop logging history events.

    • isHistoryEnabled Link icon

      boolean isHistoryEnabled()
      History activation status
      Returns:
      The status of history.

    • isIndexationEnable Link icon

      boolean isIndexationEnable()
      Check if the datastore must be indexed
      Returns:
      true if the datastore must be indexed, false if not

    • setIndexationEnable Link icon

      void setIndexationEnable(boolean indexationEnable)
      Sets the indexation state of the datastore
      Parameters:
      indexationEnable - true if the datastore must be indexed, false if not

    • getAuthorizedExtensions Link icon

      String getAuthorizedExtensions()
      Gets the list of authorized extensions.
      Returns:
      The list of authorized extensions.

    • setAuthorizedExtensions Link icon

      void setAuthorizedExtensions(String authorizedExtensions)
      Sets the list of authorized extensions.
      Parameters:
      authorizedExtensions - The authorized extensions.