public interface OwDocumentImportItem
Interface describing one single document imported by a document importer.
A document importer can be used by plugins that gather content like the add document,
the save or the checkin plugins to receive the content from the user.
Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.
For licensing information read the license.txt file or
go to: http://wiki.alfresco.com
Modifier and Type | Method and Description |
---|---|
Boolean |
getCheckinAsMajor()
Return a Boolean representing the checkin status
for this item, possible values are:
Boolean.TRUE : create/checkin as major version
Boolean.FALSE : create/checkin as minor version
null : action should be request from user/or ignore
|
String |
getContentMimeParameter(int i_p)
Returns the MIME parameter of the i-th content stream.
|
String |
getContentMimeType(int i_p)
Returns the MIME type of the i-th content stream.
|
InputStream |
getContentStream(int i_p)
Returns the ith content stream of the imported document as InputStream.
|
int |
getContentStreamCount()
Returns the number of content elements associated with this imported document.
|
String |
getDisplayName()
Returns a String that represents this imported Document.
Used for example for the stack of imported documents. |
String |
getObjectClassName()
Return the ECM classification name for this OwDocumentItem, which should be used
to save the document in the back-end system.
|
String |
getPreviewFilePath(int i_p)
Returns the full path to a file that can be used for preview of the i-th content
stream.
|
Map |
getPropertyValueMap()
Returns a Map with property class to value mappings.
|
String |
getProposedDocumentName()
Returns the proposed Document name.
Nearly every ECM back-end knows some name property or represents item property that is used by this ECM system as a name of the document. |
void |
release()
Release this imported document by freeing all temporarily acquired resources like
deleting temporary files.
Please note: This method must be able to deal with (a) multiple calls of this method, and (b) calls to this method AFTER a call to releaseAll of the creating importer. |
int getContentStreamCount()
InputStream getContentStream(int i_p) throws Exception
i_p
- zero-based index in the list of imported content streamsException
- if the InputStream
of this imported document can not be createdString getContentMimeType(int i_p)
i_p
- zero-based index in the list of imported content streamsString getContentMimeParameter(int i_p)
i_p
- zero-based index in the list of imported content streamsMap getPropertyValueMap()
String getDisplayName()
String getProposedDocumentName()
String getPreviewFilePath(int i_p)
i_p
- zero-based index in the list of imported conent streamsvoid release() throws Exception
releaseAll
of the creating importer.Exception
- if there are problems freeing the ocupied resourcesString getObjectClassName()
Can return null
, so the default handling
or user action should be processed.
Boolean getCheckinAsMajor()
Boolean.TRUE
: create/checkin as major versionBoolean.FALSE
: create/checkin as minor versionnull
: action should be request from user/or ignoreCopyright © 2014 Alfresco Business Solutions. All Rights Reserved.