Class TransferReportGet
java.lang.Object
org.springframework.extensions.webscripts.AbstractWebScript
org.alfresco.repo.web.scripts.content.StreamContent
org.alfresco.repo.web.scripts.content.StreamACP
org.alfresco.module.org_alfresco_module_rm.script.BaseTransferWebScript
org.alfresco.module.org_alfresco_module_rm.script.TransferReportGet
- All Implemented Interfaces:
RecordsManagementCustomModel
,RecordsManagementModel
,org.springframework.extensions.webscripts.WebScript
Deprecated.
Returns a JSON representation of a transfer report.
- Author:
- Gavin Cornwell
-
Nested Class Summary
Nested classes/interfaces inherited from class org.springframework.extensions.webscripts.AbstractWebScript
org.springframework.extensions.webscripts.AbstractWebScript.ScriptDetails
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected ContentStreamer
Deprecated.protected DictionaryService
Deprecated.protected DispositionService
Deprecated.protected static final String
Deprecated.protected static final String
Deprecated.Fields inherited from class org.alfresco.module.org_alfresco_module_rm.script.BaseTransferWebScript
filePlanService
Fields inherited from class org.alfresco.repo.web.scripts.content.StreamACP
exporterService, MULTIPART_FORMDATA, PARAM_NODE_REFS, TEMP_FILE_PREFIX, ZIP_EXTENSION
Fields inherited from class org.alfresco.repo.web.scripts.content.StreamContent
delegate, mimetypeService, nodeService, permissionService, repository
Fields inherited from interface org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementCustomModel
ASPECT_CUSTOM_ASSOCIATIONS, ASPECT_SUPPLEMENTAL_MARKING_LIST, CONSTRAINT_CUSTOM_SMLIST, CUSTOM_REF_CROSSREFERENCE, CUSTOM_REF_OBSOLETES, CUSTOM_REF_RENDITION, CUSTOM_REF_SUPERSEDES, CUSTOM_REF_SUPPORTS, CUSTOM_REF_VERSIONS, PROP_SUPPLEMENTAL_MARKING_LIST, RM_CUSTOM_MODEL, RM_CUSTOM_PREFIX, RM_CUSTOM_URI
Fields inherited from interface org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel
ASPECT_ARCHIVED, ASPECT_ASCENDED, ASPECT_CAVEAT_CONFIG_ROOT, ASPECT_COMMON_RECORD_DETAILS, ASPECT_COUNTABLE, ASPECT_CUSTOM_RM_DATA, ASPECT_CUT_OFF, ASPECT_DECLARED_RECORD, ASPECT_DISPOSITION_LIFECYCLE, ASPECT_DISPOSITION_PROCESSED, ASPECT_EMAIL_CONFIG_ROOT, ASPECT_EXTENDED_SECURITY, ASPECT_FILABLE, ASPECT_FILE_PLAN_COMPONENT, ASPECT_FROZEN, ASPECT_GHOSTED, ASPECT_HELD_CHILDREN, ASPECT_LOADED_DATA_SET_ID, ASPECT_RECORD, ASPECT_RECORD_COMPONENT_ID, ASPECT_RECORD_META_DATA, ASPECT_RECORD_ORIGINATING_DETAILS, ASPECT_RECORD_REJECTION_DETAILS, ASPECT_RECORDS_MANAGEMENT_ROOT, ASPECT_RM_SEARCH, ASPECT_SAVED_SEARCH, ASPECT_SCHEDULED, ASPECT_TRANSFERRED, ASPECT_TRANSFERRING, ASPECT_UNCUT_OFF, ASPECT_UNPUBLISHED_UPDATE, ASPECT_VERSIONED_RECORD, ASPECT_VITAL_RECORD, ASPECT_VITAL_RECORD_DEFINITION, ASSOC_CAVEAT_CONFIG, ASSOC_DISPOSITION_ACTION_DEFINITIONS, ASSOC_DISPOSITION_ACTION_HISTORY, ASSOC_DISPOSITION_SCHEDULE, ASSOC_EMAIL_CONFIG, ASSOC_EVENT_EXECUTIONS, ASSOC_FROZEN_CONTENT, ASSOC_FROZEN_RECORDS, ASSOC_HOLDS, ASSOC_NEXT_DISPOSITION_ACTION, ASSOC_TRANSFERRED, ASSOC_TRANSFERS, GL_URI, PROP_COMBINE_DISPOSITION_STEP_CONDITIONS, PROP_COUNT, PROP_CUT_OFF_DATE, PROP_DATE_FILED, PROP_DB_UNIQUENESS_ID, PROP_DECLARED_AT, PROP_DECLARED_BY, PROP_DISPOSITION_ACTION, PROP_DISPOSITION_ACTION_COMPLETED_AT, PROP_DISPOSITION_ACTION_COMPLETED_BY, PROP_DISPOSITION_ACTION_GHOST_ON_DESTROY, PROP_DISPOSITION_ACTION_ID, PROP_DISPOSITION_ACTION_NAME, PROP_DISPOSITION_ACTION_STARTED_AT, PROP_DISPOSITION_ACTION_STARTED_BY, PROP_DISPOSITION_AS_OF, PROP_DISPOSITION_AUTHORITY, PROP_DISPOSITION_DESCRIPTION, PROP_DISPOSITION_EVENT, PROP_DISPOSITION_EVENT_COMBINATION, PROP_DISPOSITION_EVENTS_ELIGIBLE, PROP_DISPOSITION_INSTRUCTIONS, PROP_DISPOSITION_LOCATION, PROP_DISPOSITION_PERIOD, PROP_DISPOSITION_PERIOD_PROPERTY, PROP_EVENT_EXECUTION_AUTOMATIC, PROP_EVENT_EXECUTION_COMPLETE, PROP_EVENT_EXECUTION_COMPLETED_AT, PROP_EVENT_EXECUTION_COMPLETED_BY, PROP_EVENT_EXECUTION_NAME, PROP_FROZEN_AT, PROP_FROZEN_BY, PROP_HELD_CHILDREN_COUNT, PROP_HOLD_REASON, PROP_IDENTIFIER, PROP_IS_CLOSED, PROP_LOADED_DATA_SET_IDS, PROP_LOCATION, PROP_MANUALLY_SET_AS_OF, PROP_ORIGIONAL_NAME, PROP_PUBLISH_IN_PROGRESS, PROP_READERS, PROP_RECORD_LEVEL_DISPOSITION, PROP_RECORD_ORIGINATING_CREATION_DATE, PROP_RECORD_ORIGINATING_LOCATION, PROP_RECORD_ORIGINATING_USER_ID, PROP_RECORD_REJECTION_DATE, PROP_RECORD_REJECTION_REASON, PROP_RECORD_REJECTION_USER_ID, PROP_REVIEW_AS_OF, PROP_REVIEW_PERIOD, PROP_ROOT_NODEREF, PROP_RS_DECLASSIFICATION_REVIEW_COMPLETED_AT, PROP_RS_DECLASSIFICATION_REVIEW_COMPLETED_BY, PROP_RS_DISPOITION_AUTHORITY, PROP_RS_DISPOITION_INSTRUCTIONS, PROP_RS_DISPOSITION_ACTION_AS_OF, PROP_RS_DISPOSITION_ACTION_NAME, PROP_RS_DISPOSITION_EVENTS, PROP_RS_DISPOSITION_EVENTS_ELIGIBLE, PROP_RS_DISPOSITION_PERIOD, PROP_RS_DISPOSITION_PERIOD_EXPRESSION, PROP_RS_HAS_DISPOITION_SCHEDULE, PROP_RS_HOLD_REASON, PROP_RS_VITAL_RECORD_REVIEW_PERIOD, PROP_RS_VITAL_RECORD_REVIEW_PERIOD_EXPRESSION, PROP_TRANSFER_ACCESSION_INDICATOR, PROP_TRANSFER_LOCATION, PROP_TRANSFER_PDF_INDICATOR, PROP_UNPUBLISHED_UPDATE, PROP_UPDATE_TO, PROP_UPDATED_PROPERTIES, PROP_VITAL_RECORD_INDICATOR, PROP_WRITERS, RM_MODEL, RM_PREFIX, RM_URI, TYPE_CAVEAT_CONFIG, TYPE_DISPOSITION_ACTION, TYPE_DISPOSITION_ACTION_DEFINITION, TYPE_DISPOSITION_SCHEDULE, TYPE_EMAIL_CONFIG, TYPE_EVENT_EXECUTION, TYPE_FILE_PLAN, TYPE_HOLD, TYPE_HOLD_CONTAINER, TYPE_NON_ELECTRONIC_DOCUMENT, TYPE_RECORD_CATEGORY, TYPE_RECORD_FOLDER, TYPE_RECORDS_MANAGEMENT_CONTAINER, TYPE_RM_SITE, TYPE_TRANSFER, TYPE_TRANSFER_CONTAINER, TYPE_UNFILED_RECORD_CONTAINER, TYPE_UNFILED_RECORD_FOLDER, UPDATE_TO_DISPOSITION_ACTION_DEFINITION
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected File
executeTransfer
(NodeRef transferNode, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache) Deprecated.Abstract method subclasses implement to perform the actual logic required.protected void
generateTransferFolderJSON
(Writer writer, NodeRef folderNode) Deprecated.Generates the JSON to represent the given folder.protected void
generateTransferItemsJSON
(Writer writer, NodeRef[] itemsToTransfer) Deprecated.Generates the JSON to represent the given NodeRefsprotected void
generateTransferRecordJSON
(Writer writer, NodeRef recordNode) Deprecated.Generates the JSON to represent the given record.void
setContentStreamer
(ContentStreamer contentStreamer) Deprecated.void
setDictionaryService
(DictionaryService ddService) Deprecated.Sets the DictionaryService instancevoid
setDispositionService
(DispositionService dispositionService) Deprecated.Sets the disposition serviceMethods inherited from class org.alfresco.module.org_alfresco_module_rm.script.BaseTransferWebScript
execute, findTransferNode, getTransferNodes, setFilePlanService
Methods inherited from class org.alfresco.repo.web.scripts.content.StreamACP
createACP, getNodeRefs, getNodeRefs, setExporterService
Methods inherited from class org.alfresco.repo.web.scripts.content.StreamContent
createObjectReferenceFromUrl, executeImpl, executeImpl, executeImpl, renderFormatTemplate, setAttachment, setDelegate, setMimetypeService, setNodeService, setPermissionService, setRepository, streamContent, streamContent, streamContent, streamContentImpl
Methods inherited from class org.springframework.extensions.webscripts.AbstractWebScript
addModuleBundleToCache, checkModuleBundleCache, createArgs, createArgsM, createHeaders, createHeadersM, createScriptParameters, createStatusException, createTemplateParameters, executeScript, getContainer, getDescription, getExecuteScript, getResources, getStatusTemplate, init, renderString, renderString, renderTemplate, sendStatus, setURLModelFactory, toString
-
Field Details
-
REPORT_FILE_PREFIX
Deprecated.- See Also:
-
REPORT_FILE_SUFFIX
Deprecated.- See Also:
-
ddService
Deprecated. -
dispositionService
Deprecated. -
contentStreamer
Deprecated.
-
-
Constructor Details
-
TransferReportGet
public TransferReportGet()Deprecated.
-
-
Method Details
-
setDictionaryService
Deprecated.Sets the DictionaryService instance- Parameters:
ddService
- The DictionaryService instance
-
setDispositionService
Deprecated.Sets the disposition service- Parameters:
dispositionService
- the disposition service
-
setContentStreamer
Deprecated.- Parameters:
contentStreamer
-
-
executeTransfer
protected File executeTransfer(NodeRef transferNode, org.springframework.extensions.webscripts.WebScriptRequest req, org.springframework.extensions.webscripts.WebScriptResponse res, org.springframework.extensions.webscripts.Status status, org.springframework.extensions.webscripts.Cache cache) throws IOException Deprecated.Description copied from class:BaseTransferWebScript
Abstract method subclasses implement to perform the actual logic required.- Specified by:
executeTransfer
in classBaseTransferWebScript
- Parameters:
transferNode
- The transfer nodereq
- The requestres
- The responsestatus
- Status objectcache
- Cache object- Returns:
- File object representing the file containing the JSON of the report
- Throws:
IOException
-
generateTransferItemsJSON
protected void generateTransferItemsJSON(Writer writer, NodeRef[] itemsToTransfer) throws IOException Deprecated.Generates the JSON to represent the given NodeRefs- Parameters:
writer
- Writer to write toitemsToTransfer
- NodeRefs being transferred- Throws:
IOException
-
generateTransferFolderJSON
Deprecated.Generates the JSON to represent the given folder.- Parameters:
writer
- Writer to write tofolderNode
- Folder being transferred- Throws:
IOException
-
generateTransferRecordJSON
Deprecated.Generates the JSON to represent the given record.- Parameters:
writer
- Writer to write torecordNode
- Record being transferred- Throws:
IOException
-