Uses of Interface com.redwood.scheduler.api.model.Format

Packages that use Format
Package	Description
com.redwood.scheduler.api.model	Scheduler API - Model
com.redwood.scheduler.api.model.compatibility_14
com.redwood.scheduler.api.model.interfaces	Scheduler API - High level model interfaces.
com.redwood.scheduler.api.usermessage

Uses of Format in com.redwood.scheduler.api.model

Fields in com.redwood.scheduler.api.model with type parameters of type Format
Modifier and Type	Field	Description
`static QueryObjectType<Format>`	Format.`TYPE`	Type that can be used in `SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...)`.

Methods in com.redwood.scheduler.api.model that return Format
Modifier and Type	Method	Description
`Format`	SchedulerSession.`createFormat()`	Return a new instance of Format.
`static Format`	FileFormatFinder.`findByFile(SchedulerSession session, File file)`
`static Format`	FileFormatFinder.`findByFileName(SchedulerSession session, String fileName)`
`static Format`	FileFormatFinder.`findByFileNameMimeType(SchedulerSession session, String fileName, String mimeType)`
`static Format`	FileFormatFinder.`findByMimeType(SchedulerSession session, String mimeType)`
`static Format`	FileFormatFinder.`getDefaultJobFileFormat(SchedulerSession session, Job job, JobFileType fileType, String jobFileName, Long fileOrder)`	Get the fileFormat for this kind of output file.
`Format`	JobDefinition.`getDefaultLogFormat()`	Get the DefaultLogFormat.
`Format`	JobDefinition.`getDefaultOutputFormat()`	Get the DefaultOutputFormat.
`Format`	Document.`getFormat()`	Get the Format.
`static Format`	FileFormatFinder.`getFormat(SchedulerSession session, String extension, String mimeType)`
`Format`	JobFile.`getFormat()`	Get the Format.
`static Format`	BusinessKeyLookup.`getFormatByBusinessKey(SchedulerSession session, String key)`	Query an instance of `Format`, based on its business key.
`Format`	BusinessKeyResolver.`getFormatByKey(BusinessKey key)`	Query an instance of `Format`, based on its business key.
`Format`	Partition.`getFormatByName(String name)`	Get the Format by Name.
`Format`	SchedulerSession.`getFormatByName(Partition partition, String name)`	Get the `Format` by Name.
`Format`	SchedulerSession.`getFormatByName(String name)`	Get the `Format` by Name.
`Format`	SchedulerSession.`getFormatByUniqueId(Long uniqueId)`	Get the `Format` by UniqueId.

Methods in com.redwood.scheduler.api.model that return types with arguments of type Format
Modifier and Type	Method	Description
`RWIterable<Format>`	Application.`getChildFormats()`	Get an `RWIterable` over a collection of `ChildFormats`, the collection will be ordered by Name.
`RWIterable<Format>`	Partition.`getFormats()`	Get an `RWIterable` over an ordered collection of `Formats`.

Methods in com.redwood.scheduler.api.model with parameters of type Format
Modifier and Type	Method	Description
`void`	AbstractConcreteObjectCallback.`handle(Format theFormat)`
`void`	ConcreteObjectCallback.`handle(Format theFormat)`
`void`	JobDefinition.`setDefaultLogFormat(Format newDefaultLogFormat)`	Set the value for DefaultLogFormat.
`void`	JobDefinition.`setDefaultOutputFormat(Format newDefaultOutputFormat)`	Set the value for DefaultOutputFormat.
`void`	Document.`setFormat(Format newFormat)`	Set the value for Format.
`void`	JobFile.`setFormat(Format newFormat)`	Set the value for Format.
`UserMessageAttachmentUpload`	UserMessageAttachment.`startUpload(Format format)`	Start an upload of an attachment.

Uses of Format in com.redwood.scheduler.api.model.compatibility_14

Methods in com.redwood.scheduler.api.model.compatibility_14 that return types with arguments of type Format
Modifier and Type	Method	Description
`Iterator<Format>`	ApplicationComp.`getChildFormats()`	Deprecated. this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use `Application.getChildFormats()` instead.
`Iterator<Format>`	PartitionComp.`getFormats()`	Deprecated. this method should never be used directly, and is only provided to ensure binary compatibility with previous releases of the software, use `Partition.getFormats()` instead.

Uses of Format in com.redwood.scheduler.api.model.interfaces

Methods in com.redwood.scheduler.api.model.interfaces with parameters of type Format
Modifier and Type	Method	Description
`OutputStream`	FileParameterRuntime.`getOutputStream(JobFile jobFile, Format format)`	Get an OutputStream to write the Out content of an Out or InOut parameter to the specified (potentially partially populated, but not necessarily persisted) JobFile, and set the reference to it.

Uses of Format in com.redwood.scheduler.api.usermessage

Methods in com.redwood.scheduler.api.usermessage with parameters of type Format
Modifier and Type	Method	Description
`void`	UserMessageAttachmentUpload.`setFormat(Format format)`	Set the format for the file