com.axemble.vdoc.sdk.interfaces

Interface IFile

All Superinterfaces:

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

public interface IFile
extends IResource, IDeletionSupport, IExternalSupport, ISecuritySupport, IUriSupport, IProtocolSupport, ITrashSupport, ILibraryElement

The file within the library system.

Since:

1.0, 15/04/2008

Author:

vlygeros

See Also:

ILibrary, IFolder, ICategory

Method Summary

Modifier and Type	Method and Description
void	addCategories(Collection categories) Associates a collection of ICategory objects to the file.
void	addCategory(ICategory category) Associates a category to the file.
IUser	checkedOutBy() Retrieve the user who checked out the file.
void	checkIn() Check in a file.
void	checkOut() Check out a file.
Collection	getCategories() Gets all the associated categories.
String	getDescription() Gets the description of the file.
String	getLanguage() Gets the language of the file.
ILibrary	getLibrary() Gets the library.
IFolder	getParentFolder() Gets the parent folder.
boolean	isCheckedOut() Check if the file has been checked out.
boolean	moveTo(IFolder destFolder, boolean bOverwrite) Move a file to a folder.
void	removeCategories(Collection categories) Removes the associations between the file and the collection of categories.
void	removeCategory(ICategory category) Removes the association between the file and the specified category.
void	setDefinition(IResourceDefinition definition) Associates the specified definition with the file.
void	setDescription(String description) Sets the description of the file.
void	setLanguage(String language) Sets the language of the file.
void	setName(String name) Sets the name of the file.
void	undoCheckOut() Undo check out.

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

addLinkedResource, addLinkedResources, allowEvents, createLinkedResource, deleteLinkedResource, deleteLinkedResources, denyEvents, exists, getCreatedBy, getCreatedDate, getDefinition, getHistory, getLinkedResources, getList, getModifiedBy, getModifiedDate, getName, getText, getValue, refresh, refresh, save, save, setCreatedBy, setCreatedDate, setList, setModifiedBy, setModifiedDate, setValue, setValueNoEvents

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

delete

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

getProtocolURI, getProtocolURI

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

getName

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

Parameters:

name - the new name to set.

setDescription

void setDescription(String description)

Sets the description of the file.

Parameters:

description - the new description to set.

getDescription

String getDescription()

Gets the description of the file.

Specified by:

getDescription in interface ILibraryElement

Returns:

a String of the file.

setLanguage

void setLanguage(String language)

Sets the language of the file.

Parameters:

language - the language to set.

getLanguage

String getLanguage()

Gets the language of the file.

Returns:

a String of the file.

addCategory

void addCategory(ICategory category)

Associates a category to the file.

Parameters:

category - the ICategory to add.

addCategories

void addCategories(Collection categories)

Associates a collection of ICategory objects to the file.

Parameters:

categories - a collection of ICategory objects.

removeCategory

void removeCategory(ICategory category)

Removes the association between the file and the specified category.

Parameters:

category - the ICategory object to remove.

removeCategories

void removeCategories(Collection categories)

Removes the associations between the file and the collection of categories.

Parameters:

categories - the collection of ICategory objects to remove.

getCategories

Collection getCategories()

Gets all the associated categories.

Returns:

a collection of ICategory objects.

getParentFolder

IFolder getParentFolder()

Gets the parent folder.

Returns:

a IFolder object.

getLibrary

ILibrary getLibrary()

Gets the library.

Returns:

a ILibrary object.

setDefinition

void setDefinition(IResourceDefinition definition)

Associates the specified definition with the file.

Parameters:

definition - the IResourceDefinition object.

checkOut

void checkOut()

Check out a file.

undoCheckOut

void undoCheckOut()

Undo check out.

checkIn

void checkIn()

Check in a file.

checkedOutBy

IUser checkedOutBy()

Retrieve the user who checked out the file.

Returns:

a IUser object.

isCheckedOut

boolean isCheckedOut()

Check if the file has been checked out.

Returns:

true if the file has been checked out, false otherwise.

moveTo

boolean moveTo(IFolder destFolder,
               boolean bOverwrite)

Move a file to a folder.

Parameters:

destFolder - The IFolder to put the file to.

bOverwrite - delete the file.

Returns:

true if succeed, false otherwise.