com.axemble.vdoc.sdk.interfaces

Interface IFolder

All Superinterfaces:

IDeletionSupport, IElement, IExternalSupport, ILibraryElement, IProtocolSupport, ISearchSupport, ISecuritySupport, ITrashSupport, IUriSupport, Serializable

public interface IFolder
extends IElement, IDeletionSupport, IExternalSupport, ISecuritySupport, ISearchSupport, IUriSupport, IProtocolSupport, ITrashSupport, ILibraryElement

The folder within the library system.

Since:

1.0, 15/04/2008

Author:

vlygeros

See Also:

ILibrary, IFile, ICategory

Method Summary

Modifier and Type	Method and Description
void	addFile(IFile file) Adds a IFile object.
IUser	getCreatedBy() Gets the creator of the folder.
Date	getCreatedDate() Gets the created date.
String	getDescription() Gets the description of the folder.
IFolder	getFolder(IContext context, String name) Gets a child IFolder object by its name.
Collection	getFolders(IContext context) Gets the child folders
ILibrary	getLibrary() Gets the library.
IUser	getModifiedBy() Gets the last user who modified the folder.
Date	getModifiedDate() Gets the modified date.
String	getName() Gets the name of the folder.
IFolder	getParentFolder() Gets the parent folder.
void	setCreatedBy(IUser user) Sets the creator of the folder.
void	setDescription(String description) Sets the description of the folder.
void	setModifiedBy(IUser user) Sets last user who modified the folder.
void	setModifiedDate(Date date) Sets the modified date.
void	setName(String name) Sets the name of the folder.

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.IUriSupport

getURI

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

deleteFromTrash, isInTrash, moveToTrash, restoreFromTrash

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

getId, getModule, getNativeObject, getPath, save

Method Detail

setName

void setName(String name)

Sets the name of the folder.

Parameters:

name - the new name to set.

getName

String getName()

Gets the name of the folder.

Specified by:

getName in interface ILibraryElement

Returns:

a String object.

setDescription

void setDescription(String description)

Sets the description of the folder.

Parameters:

description - the new description to set.

getDescription

String getDescription()

Gets the description of the folder.

Specified by:

getDescription in interface ILibraryElement

Returns:

a String of the folder.

getCreatedDate

Date getCreatedDate()

Gets the created date.

Returns:

a Date object.

setModifiedDate

void setModifiedDate(Date date)

Sets the modified date.

Parameters:

date - The Date to set.

getModifiedDate

Date getModifiedDate()

Gets the modified date.

Returns:

a Date object.

setCreatedBy

void setCreatedBy(IUser user)

Sets the creator of the folder.

Parameters:

user - The user to set as the creator of the folder.

getCreatedBy

IUser getCreatedBy()

Gets the creator of the folder.

Returns:

a IUser object.

setModifiedBy

void setModifiedBy(IUser user)

Sets last user who modified the folder.

Parameters:

user - The last IUser who modified the folder.

getModifiedBy

IUser getModifiedBy()

Gets the last user who modified the folder.

Returns:

a IUser object.

addFile

void addFile(IFile file)

Adds a IFile object.

Parameters:

file - The IFile object to add.

getFolders

Collection getFolders(IContext context)

Gets the child folders

Parameters:

context - The execution context.

Returns:

A collection of IFolder objects.

getFolder

IFolder getFolder(IContext context,
                  String name)

Gets a child IFolder object by its name.

Parameters:

context - The execution context.

name - The name of the child folder.

Returns:

A IFolder object.

getParentFolder

IFolder getParentFolder()

Gets the parent folder.

Returns:

A IFolder object.

getLibrary

ILibrary getLibrary()

Gets the library.

Returns:

A ILibrary object.