public interface OwContentElement
Base interface for Content Elements. Content Elements hold a piece of date, page etc.
To be implemented with the specific ECM system.
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 |
---|---|
String |
getContentFilePath()
get the file path to the content (optional, only available if content is stored locally)
NOTE: This function is only used for ECM Systems which can only download through files
If a FilePath exists, a stream will also exist.
|
Object |
getContentObject()
get the content object
The content representation is of type Object
|
int |
getContentRepresentation()
get the content representation, which can be either URL, stream or object
|
InputStream |
getContentStream(OutputStream out_p)
get the content from the object.
|
String |
getContentURL()
get the content URL
The content representation is of type URL (String)
|
String |
getMIMEParameter()
retrieve the MIME parameter for the specified page number
|
String |
getMIMEType()
retrieve the MIME type for the specified page number
|
int |
getPageNumber(int lPageIndex_p)
retrieve the page number for the given zero based index
NOTE: the Page numbers might be arbitrary in the collection in order to submit specific page content
|
boolean |
isInputStreamNative()
check if getContentStream is based on an native InputStream or OutputStream
NOTE: getContentStream must implement for Input- and OutputStream.
|
void |
releaseResources()
method is called e.g.
|
String getContentFilePath() throws Exception
Exception
String getContentURL() throws Exception
Exception
Object getContentObject() throws Exception
Exception
int getContentRepresentation() throws Exception
Exception
boolean isInputStreamNative()
InputStream getContentStream(OutputStream out_p) throws Exception
out_p
- optional OutputStream, if set the method writes the OutputStream and returns null, otherwise it returns an InputStreamException
int getPageNumber(int lPageIndex_p) throws Exception
Exception
String getMIMEType() throws Exception
Exception
String getMIMEParameter() throws Exception
Exception
void releaseResources()
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.