com.filenet.api.core
Interface ContentTransfer
-
- All Superinterfaces:
- ContentElement, DependentObject, EngineObject, RepositoryObject, java.io.Serializable
public interface ContentTransfer extends RepositoryObject, ContentElement, DependentObject
Represents content data that is local to an object store and directly managed by the Content Engine server.Metadata
-
-
Method Summary
Methods Modifier and Type Method and Description java.io.InputStream
accessContentStream()
Obtains read access, via an input stream, to the content data of thisContentTransfer
object.java.lang.Double
get_ContentSize()
Returns the value of the ContentSize property.java.lang.String
get_RetrievalName()
Returns the value of the RetrievalName property.void
set_RetrievalName(java.lang.String value)
Sets the value of the RetrievalName property.void
setCaptureSource(java.io.InputStream source)
Specifies an input stream as the source of content data for thisContentTransfer
object.-
Methods inherited from interface com.filenet.api.core.ContentElement
get_ContentType, get_ElementSequenceNumber, set_ContentType
-
Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore
-
Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
-
-
-
-
Method Detail
-
get_RetrievalName
java.lang.String get_RetrievalName()
Returns the value of the RetrievalName property. For more information, see RetrievalName Property.
-
set_RetrievalName
void set_RetrievalName(java.lang.String value)
Sets the value of the RetrievalName property. For more information, see RetrievalName Property.
-
get_ContentSize
java.lang.Double get_ContentSize()
Returns the value of the ContentSize property. For more information, see ContentSize Property.
-
accessContentStream
java.io.InputStream accessContentStream()
Obtains read access, via an input stream, to the content data of thisContentTransfer
object. The content data is fetched from the server. The Content Engine will not automatically close the stream after access has finished; unless you want the stream to remain open, your application should close the stream after it has finished reading the content data.- Returns:
- An
InputStream
object for reading content data. - See Also:
- ContentAccessRecordingLevel property, DateContentLastAccessed property
-
setCaptureSource
void setCaptureSource(java.io.InputStream source)
Specifies an input stream as the source of content data for thisContentTransfer
object. The Content Engine will not automatically close the stream after access has finished; unless you want the stream to remain open, your application should close the stream once all of the content data has been read by the server. The stream can safely be closed after you have added thisContentTransfer
object to the ContentElements collection of a document or annotation and called that object'ssave
method.- Parameters:
source
- AnInputStream
object specifying the source of the content data.- Throws:
E_NULL_OR_INVALID_PARAM_VALUE
- if thesource
parameter isnull
.
-
-