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

Packages that use Document
Package Description

com.redwood.scheduler.api.model
Scheduler API - Model

com.redwood.scheduler.api.model.compatibility_14

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

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

Methods in com.redwood.scheduler.api.model that return Document
Modifier and Type	Method	Description
`Document`	SchedulerSession.`createDocument()`	Return a new instance of Document.
`Document`	VisualizationProcessServerQueue.`getBackgroundDocument()`	Get the BackgroundDocument.
`Document`	Application.`getChildDocumentByPartitionSearchName(Partition partition, String searchName)`	Get the Document by Path.
`Document`	UserMessageAttachment.`getDocument()`	Attempts to return the Document that is the attachment.
`static Document`	BusinessKeyLookup.`getDocumentByBusinessKey(SchedulerSession session, String key)`	Query an instance of `Document`, based on its business key.
`Document`	SchedulerSession.`getDocumentByFullPath(String fullPath)`	Get the `Document` by FullPath.
`Document`	BusinessKeyResolver.`getDocumentByKey(BusinessKey key)`	Query an instance of `Document`, based on its business key.
`Document`	Partition.`getDocumentByParentApplicationSearchName(Application parentApplication, String searchName)`	Get the Document by Path.
`Document`	SchedulerSession.`getDocumentByPath(Partition partition, Application parentApplication, String searchName)`	Get the `Document` by Path.
`Document`	SchedulerSession.`getDocumentByUniqueId(Long uniqueId)`	Get the `Document` by UniqueId.

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

Methods in com.redwood.scheduler.api.model with parameters of type Document
Modifier and Type	Method	Description
`void`	AbstractConcreteObjectCallback.`handle(Document theDocument)`
`void`	ConcreteObjectCallback.`handle(Document theDocument)`
`void`	VisualizationProcessServerQueue.`setBackgroundDocument(Document newBackgroundDocument)`	Set the value for BackgroundDocument.
`void`	UserMessageAttachment.`setDocument(Document document)`	Set the attachment to a Document
`void`	JobParameter.`setInValueFileParameter(Document document)`	This will set the type of the FileParameter to `Document`, and set the business key correctly to reference `document`.
`void`	JobParameter.`setOutValueFileParameter(Document document)`	This will set the type of the FileParameter to `Document`, and set the business key correctly to reference `document`.

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

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