Package com.redwood.scheduler.api.usermessage

Interface WritableJobFile

All Superinterfaces:

Detail, JobFile, Readable, SchedulerEntity, SchedulerEntityComp

public interface WritableJobFile
extends JobFile

Extend the JobFile interface to allow writing in a limited case.

Field Summary

Fields inherited from interface com.redwood.scheduler.api.model.Detail

VERSION_DETAIL

Fields inherited from interface com.redwood.scheduler.api.model.JobFile

APPS_EXTRAOUTPUT, APPS_EXTRAOUTPUT_ORDER, APPS_JOBLOG, APPS_JOBLOG_ORDER, APPS_OUTPUT, APPS_OUTPUT_ORDER, AS400_FILENUMBER_START, CUSTOMER_ORDER_END, CUSTOMER_ORDER_START, OBJECT_TYPE, OHI_JOBLOG, OHI_JOBLOG_ORDER, OHI_OUTPUT, OHI_OUTPUT_ORDER, PREFERRED_CHARACTERSET, PREFERRED_CHARSET, SAP_APPLLOG, SAP_APPLLOG_CSV, SAP_APPLLOG_DAT, SAP_APPLLOG_HTML, SAP_APPLLOG_MHTML, SAP_APPLLOG_PDF, SAP_APPLLOGS_ORDER_START, SAP_CC_BASIC_LIST, SAP_CC_BASIC_LIST_ORDER, SAP_CC_DETAIL_LIST, SAP_CC_DETAIL_LIST_ORDER, SAP_FILENUMBER_START, SAP_JOBLOG, SAP_JOBLOG_DAT, SAP_JOBLOG_ORDER, SAP_JOBLOG_PDF, SAP_SPOOLLIST, SAP_SPOOLLIST_BIN, SAP_SPOOLLIST_CSV, SAP_SPOOLLIST_HTML, SAP_SPOOLLIST_MHTML, SAP_SPOOLLIST_PDF, SAP_SPOOLLIST_RTX, SAP_SPOOLLIST_XLS, SAP_SPOOLLIST_XLSX, SAP_SPOOLLISTID_MAPPING, SAP_SPOOLLISTID_MAPPING_ORDER, SAP_SPOOLLISTS_ORDER_START, SAP_STATISTICS, SAP_STATISTICS_ORDER, SEC_RANK_ALL, SEC_RANK_NONE, STANDARD_AUDIT_ARCHIVE, STANDARD_AUDIT_ARCHIVE_ORDER, STANDARD_CARIN, STANDARD_CARIN_ORDER, STANDARD_CAROUT, STANDARD_CAROUT_ORDER, STANDARD_DATAIN, STANDARD_ERROR, STANDARD_ERROR_ORDER, STANDARD_EXPORT_INFO, STANDARD_INTERNAL_LOG, STANDARD_INTERNAL_LOG_ORDER, STANDARD_JARIN, STANDARD_JARIN_ORDER, STANDARD_ON_BEFORE_USER_JOB_CHANGE, STANDARD_ON_BEFORE_USER_JOB_CHANGE_ORDER, STANDARD_OUTPUT, STANDARD_OUTPUT_ORDER, STANDARD_REPORT, STANDARD_REPORT_ORDER, STANDARD_REPORT_ORDER_XML, STANDARD_SEARCH_RESULTS, STANDARD_SEARCH_RESULTS_ORDER, STANDARD_TUTORIALS, STANDARD_TUTORIALS_ORDER, STANDARD_UPLOAD_ORDER_END, STANDARD_UPLOAD_ORDER_START, TYPE, VERSION_JOBFILE

Fields inherited from interface com.redwood.scheduler.api.model.Readable

COPYRIGHT_MESSAGE_E, ID_E

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM, VERSION_SCHEDULERENTITY

Fields inherited from interface com.redwood.scheduler.api.model.compatibility_14.SchedulerEntityComp

VERSION_SCHEDULERENTITYCOMP

Method Summary

Modifier and Type	Method	Description
OutputStream	getOutputStream()	Get the output stream to write to the JobFile.

Methods inherited from interface com.redwood.scheduler.api.model.JobFile

getCharacterSet, getCommonLog, getFileLastModificationTime, getFileName, getFileOrder, getFormat, getInputStream, getInputStream, getInputStream, getInputStream, getJob, getName, getOwnerSubject, getSize, getType, getURLTail, getViewerURL, isInCommonLogFormat, isLinkedJobFile, search, search, setCharacterSet, setFileNameAutomatic, setFileType, setFormat, setInCommonLogFormat, setName, setOrder, setOwnerSubject, updateFromLocalFile, updateFromLocalFile

Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

canPerform, createSubjectObjectPrivilegeGrant, deleteObject, getAuditTrail, getAuditTrailSize, getBehavior, getEffectiveBehavior, getErrorNameEN, getErrorNameKey, getLLPVersion, getLOV, getLOVSupport, getObjectType, getParentSchedulerEntities, getRuntime, getSubjectObjectPrivilegeGrantBySubject, getSubjectObjectPrivilegeGrants, getUniqueId, getUrl, getUrl, isCreated, isDeletable, isDeleted, isModifiable, isModified, isSelectVersioned, processRelatedObjects, processRelatedObjects, processRelatedObjects, refreshObject, resetObject, resetObject, resetValuesToDefault, selectForRead

Method Detail

getOutputStream

OutputStream getOutputStream()
                      throws IOException

Get the output stream to write to the JobFile. This is not a caching call and a new OutputStream will be returned for each subsequent call. NOTE: It is the callers responsibility to close the OutputStream.

Returns:

the output stream to write the contents of the JobFile

Throws:

IOException - if the file cannot be created