Uses of Interface
org.nuclos.api.common.NuclosFile

Packages that use NuclosFile

Package	Description
org.nuclos.api.businessobject.facade.thin
org.nuclos.api.common
org.nuclos.api.context
org.nuclos.api.mail
org.nuclos.api.objectimport
org.nuclos.api.provider
org.nuclos.api.service

Uses of NuclosFile in org.nuclos.api.businessobject.facade.thin

Methods in org.nuclos.api.businessobject.facade.thin that return types with arguments of type NuclosFile

Modifier and Type	Method	Description
List<NuclosFile>	Stateful.getAttachments()	Returns all generic documents attached to this businessobject

Methods in org.nuclos.api.businessobject.facade.thin with parameters of type NuclosFile

Modifier and Type	Method	Description
void	Stateful.deleteAttachment(NuclosFile nuclosFile)	Deletes the given file if attached to this businessobject
void	Stateful.insertAttachment(NuclosFile nuclosFile, String comment)	Inserts the given file as generic document with the given comment

Uses of NuclosFile in org.nuclos.api.common

Methods in org.nuclos.api.common that return NuclosFile

Modifier and Type	Method	Description
NuclosFile	NuclosFileLink.toFile()

Uses of NuclosFile in org.nuclos.api.context

Methods in org.nuclos.api.context that return NuclosFile

Modifier and Type	Method	Description
NuclosFile	PrintResult.getOutput()	returns printed result as NuclosFile

Uses of NuclosFile in org.nuclos.api.mail

Methods in org.nuclos.api.mail that return types with arguments of type NuclosFile

Modifier and Type	Method	Description
Collection<NuclosFile>	NuclosMail.getAttachments()	returns a collection of all attached NuclosFiles
Collection<NuclosFile>	NuclosMail.getInlineAttachments()	Returns a collection of all attached NuclosFiles representing inline attachments (e.g.

Methods in org.nuclos.api.mail with parameters of type NuclosFile

Modifier and Type	Method	Description
void	NuclosMail.addAttachment(NuclosFile pFileToAttach)	attaches a NuclosFile to the email
void	NuclosMail.addInlineAttachment(NuclosFile pFileToAttach)	Attaches a NuclosFile representing an inline attachment (e.g.

Uses of NuclosFile in org.nuclos.api.objectimport

Methods in org.nuclos.api.objectimport that return NuclosFile

Modifier and Type	Method	Description
NuclosFile	ImportResult.getLogFile()	This method returns the log file that has been created during import process

Constructors in org.nuclos.api.objectimport with parameters of type NuclosFile

Modifier	Constructor	Description
	ImportResult(boolean hasErrors, String message, NuclosFile logFile)

Uses of NuclosFile in org.nuclos.api.provider

Methods in org.nuclos.api.provider that return NuclosFile

Modifier and Type	Method	Description
static NuclosFile	BusinessObjectProvider.newFile(String name, byte[] content)	This method creates a new NuclosFile using the given content
static NuclosFile	FileProvider.newFile(File file)	Opens and reads the data from the given file and returns a new NuclosFile with the same filename and content.
static NuclosFile	FileProvider.newFile(String completeFilename)	Opens and reads the data from the file the given filename points to and returns a new NuclosFile with the same filename and content.
static NuclosFile	FileProvider.newFile(String fileName, byte[] content)	Returns a new NuclosFile with the given filename and content.
static NuclosFile	PrintoutProvider.run(OutputFormat format, Long boId)	This method runs the Printout that belongs to the given OutputFormat and returns the generated NuclosFile
static NuclosFile	PrintoutProvider.run(OutputFormat format, Long boId, Map<String,Object> params)	Providing the parameters this method runs the Printout that belongs to the given OutputFormat and returns the generated NuclosFile
static NuclosFile	PrintoutProvider.run(OutputFormat format, Long boId, Map<String,Object> params, NuclosLocale locale)	Providing the parameters this method runs the Printout that belongs to the given OutputFormat and returns the generated NuclosFile containing all localized data in the given locale language
static NuclosFile	PrintoutProvider.run(OutputFormat format, Long boId, NuclosLocale locale)	This method runs the Printout that belongs to the given OutputFormat and returns the generated NuclosFile containing all localized data in the given locale language
static NuclosFile	ReportProvider.run(OutputFormat format)	This method runs the Report that belongs to the given OutputFormat and returns the generated NuclosFile
static NuclosFile	ReportProvider.run(OutputFormat format, Map<String,Object> params)	Providing the parameters this method runs the Report that belongs to the given OutputFormat and returns the generated NuclosFile
static NuclosFile	ReportProvider.run(OutputFormat format, Map<String,Object> params, NuclosLocale locale)	Providing the parameters this method runs the Report that belongs to the given OutputFormat and returns the generated NuclosFile containing all localized data in the given locale language
static NuclosFile	ReportProvider.run(OutputFormat format, NuclosLocale locale)	This method runs the Report that belongs to the given OutputFormat and returns the generated NuclosFile containing all localized data in the given locale language
static NuclosFile	ReportProvider.run(UID outputFormatId, Map<String,Object> params, NuclosLocale locale)
static NuclosFile	FileProvider.toPdf(NuclosFile file)	Transforms the given file to PDF.

Methods in org.nuclos.api.provider with parameters of type NuclosFile

Modifier and Type	Method	Description
static void	FileProvider.print(NuclosFile file)	This method sends a NuclosFile to the default printer
static void	FileProvider.print(NuclosFile file, String printername)	This method sends a NuclosFile to the given printer
static void	FileProvider.print(NuclosFile file, PrintProperties printProperties)	This method prints a NuclosFile with the given PrintProperties
static ImportResult	ImportProvider.run(NuclosFile importFile, boolean isTransactional, Class<? extends ImportStructureDefinition>... structureDefClasses)	This method executes an import process by which the content of a NuclosFile is parsed using the given structure definitions and stored in the database afterwards.
static ImportResult	XmlImportProvider.run(NuclosFile importFile, boolean isTransactional, Class<? extends XmlImportStructureDefinition>... structureDefClasses)	This method executes an import process by which the content of a NuclosFile is parsed using the given structure definitions and stored in the database afterwards.
static void	FileProvider.save(NuclosFile file, String directory)	This method saves a NuclosFile in the given directory
static NuclosFile	FileProvider.toPdf(NuclosFile file)	Transforms the given file to PDF.

Uses of NuclosFile in org.nuclos.api.service

Methods in org.nuclos.api.service that return NuclosFile

Modifier and Type	Method	Description
NuclosFile	BusinessObjectService.newFile(String name, byte[] content)
NuclosFile	FileService.newFile(File file)
NuclosFile	FileService.newFile(String completeFilePath)
NuclosFile	FileService.newFile(String fileName, byte[] content)
NuclosFile	PrintoutService.run(OutputFormat format, Long iBusinessObjectId)
NuclosFile	PrintoutService.run(OutputFormat format, Long iBusinessObjectId, Map<String,Object> params)
NuclosFile	PrintoutService.run(OutputFormat format, Long iBusinessObjectId, Map<String,Object> params, NuclosLocale locale)
NuclosFile	PrintoutService.run(OutputFormat format, Long iBusinessObjectId, NuclosLocale locale)
NuclosFile	ReportService.run(OutputFormat format)
NuclosFile	ReportService.run(OutputFormat format, Map<String,Object> params)
NuclosFile	ReportService.run(OutputFormat format, Map<String,Object> params, NuclosLocale locale)
NuclosFile	ReportService.run(OutputFormat format, NuclosLocale locale)
NuclosFile	ReportService.run(UID outputFormatId, Map<String,Object> params, NuclosLocale locale)
NuclosFile	FileService.toPdf(NuclosFile file)

Methods in org.nuclos.api.service with parameters of type NuclosFile

Modifier and Type	Method	Description
void	FileService.print(NuclosFile file)
void	FileService.print(NuclosFile file, String printerName)
void	FileService.print(NuclosFile file, PrintProperties printProperties)
ImportResult	ImportService.run(NuclosFile importFile, boolean isTransactional, Class<? extends ImportStructureDefinition>... structureDefClasses)	This method executes an import process by which the content of a NuclosFile is parsed using the given structure definitions and stored in the database afterwards.
ImportResult	XmlImportService.run(NuclosFile importFile, boolean isTransactional, Class<? extends XmlImportStructureDefinition>... structureDefClasses)	This method executes an XML import process by which the content of a NuclosFile is parsed using the given XML structure definitions and stored in the database afterwards.
void	FileService.save(NuclosFile file, String directory)
NuclosFile	FileService.toPdf(NuclosFile file)