FileProcessor.CheckinContext (TIF 2024.1.0 API Documentation)

Enclosing interface:: FileProcessor

public static interface FileProcessor.CheckinContext

Since:: 2019-12-17

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`Context`	`getContext()`
`java.lang.String`	`getFormat()`
`java.nio.file.Path`	`getSourceFile()`
`BusinessObjectData`	`getSourceObject()`
`java.lang.String`	`getStore()`
`java.lang.String`	`getTargetBusinessObjectId()`
`boolean`	`isAppend()`
`boolean`	`isUnlock()`

- Method Detail
  - getContext
```
Context getContext()
```
    Returns:
    
    The current context
  - getSourceFile
```
java.nio.file.Path getSourceFile()
```
    Returns:
    
    The file to be checked in
  - getSourceObject
```
BusinessObjectData getSourceObject()
```
    Returns:
    
    The data for the source object
  - getFormat
```
java.lang.String getFormat()
```
    Returns:
    
    The format to check in the file with
  - getTargetBusinessObjectId
```
java.lang.String getTargetBusinessObjectId()
```
    Returns:
    
    The actual business object to checkin the file to.
  - getStore
```
java.lang.String getStore()
```
    Returns:
    
    Optional override the store
  - isUnlock
```
boolean isUnlock()
```
    Returns:
    
    True if to unlock the object after checkin
  - isAppend
```
boolean isAppend()
```
    Returns:
    
    True to append the file to the object