com.axemble.vdoc.sdk.interfaces

Interface ILibrary

All Superinterfaces:

IDeletionSupport, IElement, IExternalSupport, IProtocolSupport, ISearchSupport, ISecuritySupport, Serializable

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:

IFolder, IFile, ICategory

Method Summary

Modifier and Type	Method and Description
void	allowHistoryEvents() Allows to log history events.
void	denyHistoryEvents() Allows to stop logging history events.
String	getAlertEventListeners() Gets the email addresses to notify when the alert size is reached.
int	getAlertSize() Gets the alert size in bytes.
Collection	getAllCategories() Gets all the categories.
Collection	getAllFolders(IContext iContext) Gets off the folders.
Collection	getCategories() Gets all the root categories.
long	getCurrentSize() Gets the current size.
Collection	getFileDefinitions() Gets the file definitions.
Collection	getFolders(IContext iContext) Gets all the folders at the root level.
String	getForbiddenExtensions() Gets the list of forbidden extensions.
long	getLargestFileSize() Gets the largest file size.
long	getMaxFileSize() Gets the maximum size of a file.
long	getMaxSize() Gets the maximum size available for a library.
String	getMaxSizeEventListeners() Gets the email addresses to notify if the maximum size is reached.
String	getName() Gets the name of the library.
long	getNumberOfElements() The number of elements.
long	getNumberOfElements(Class natureClass) The number of elements of a specific class.
IOrganization	getOrganization() Gets the organization.
String	getPhysicalPath() Retrieves the physical path of the library.
long	getSmallestFileSize() Gets the smallest file size.
boolean	isHistoryEnabled() History activation status
void	setAlertEventListeners(String emails) Sets the email addresses to notify when the alert size is reached.
void	setAlertSize(int alertSize) Sets the alert size.
void	setForbiddenExtensions(String forbiddenExtensions) Sets the list of forbidden extensions.
void	setMaxFileSize(long maximumFileSize) Sets the maximum size for a file.
void	setMaxSize(long maxSize) Sets the maximum size available.
void	setMaxSizeEventListeners(String emails) Sets the email addresses to notify when the maximum size is reached.
void	setName(String name) Sets the name of the library.
void	setOrganization(IOrganization organization) Sets the organization.
void	setPhysicalPath(String path) Sets the physical path of the library

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement

getId, getModule, getNativeObject, getPath, save

Methods inherited from interface com.axemble.vdoc.sdk.supports.IDeletionSupport

delete

Methods inherited from interface com.axemble.vdoc.sdk.supports.IExternalSupport

getExternalClassName, getExternalNativeId

Methods inherited from interface com.axemble.vdoc.sdk.supports.IProtocolSupport

getProtocolURI, getProtocolURI

Method Detail

getName

String getName()

Gets the name of the library.

Returns:

The name of the library.

setName

void setName(String name)

Sets the name of the library.

Parameters:

name - The new name to set to the library.

getPhysicalPath

String getPhysicalPath()

Retrieves the physical path of the library.

Returns:

The physical path.

setPhysicalPath

void setPhysicalPath(String path)

Sets the physical path of the library

Parameters:

path - The physical path.

getMaxFileSize

long getMaxFileSize()

Gets the maximum size of a file.

Returns:

The maximum size of a file in bytes.

setMaxFileSize

void setMaxFileSize(long maximumFileSize)

Sets the maximum size for a file.

Parameters:

maximumFileSize - The file size in bytes.

getMaxSize

long getMaxSize()

Gets the maximum size available for a library.

Returns:

The maximum size in bytes.

setMaxSize

void setMaxSize(long maxSize)

Sets the maximum size available.

Parameters:

maxSize - The maximum size.

getMaxSizeEventListeners

String getMaxSizeEventListeners()

Gets the email addresses to notify if the maximum size is reached.

Returns:

The email addresses.

setMaxSizeEventListeners

void setMaxSizeEventListeners(String emails)

Sets the email addresses to notify when the maximum size is reached.

Parameters:

emails - The email addresses.

getAlertSize

int getAlertSize()

Gets the alert size in bytes.

Returns:

The size in bytes.

setAlertSize

void setAlertSize(int alertSize)

Sets the alert size.

Parameters:

alertSize - The size in bytes.

getAlertEventListeners

String getAlertEventListeners()

Gets the email addresses to notify when the alert size is reached.

Returns:

The email addresses.

setAlertEventListeners

void setAlertEventListeners(String emails)

Sets the email addresses to notify when the alert size is reached.

Parameters:

emails - The email addresses.

getForbiddenExtensions

String getForbiddenExtensions()

Gets the list of forbidden extensions.

Returns:

The list of forbidden extensions.

setForbiddenExtensions

void setForbiddenExtensions(String forbiddenExtensions)

Sets the list of forbidden extensions.

Parameters:

forbiddenExtensions - The forbidden extensions.

getAllFolders

Collection getAllFolders(IContext iContext)

Gets off the folders.

Parameters:

iContext - The user context.

Returns:

A java.util.Collection of IFolder objects.

getFolders

Collection 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

Collection getAllCategories()

Gets all the categories.

Returns:

A java.util.Collection of ICategory objects.

getCategories

Collection getCategories()

Gets all the root categories.

Returns:

A java.util.Collection of ICategory objects.

getFileDefinitions

Collection getFileDefinitions()

Gets the file definitions.

Returns:

A java.util.Collection of IResourceDefinition objects.

getOrganization

IOrganization getOrganization()

Gets the organization.

Returns:

A IOrganization object.

setOrganization

void setOrganization(IOrganization organization)

Sets the organization.

Parameters:

organization - The IOrganization object.

getCurrentSize

long getCurrentSize()

Gets the current size.

Returns:

The size in bytes.

getLargestFileSize

long getLargestFileSize()

Gets the largest file size.

Returns:

The size in bytes.

getSmallestFileSize

long getSmallestFileSize()

Gets the smallest file size.

Returns:

The size in bytes.

getNumberOfElements

long getNumberOfElements()

The number of elements.

Returns:

The number of elements.

getNumberOfElements

long getNumberOfElements(Class natureClass)

The number of elements of a specific class.

Parameters:

natureClass - The nature.

Returns:

The number of elements.

allowHistoryEvents

void allowHistoryEvents()

Allows to log history events.

denyHistoryEvents

void denyHistoryEvents()

Allows to stop logging history events.

isHistoryEnabled

boolean isHistoryEnabled()

History activation status

Returns:

The status of history.