com.ibm.xsp.actions.document
Interface DocumentAdapter

public interface DocumentAdapter

Method Summary

void	addAttachment(javax.faces.context.FacesContext context, java.lang.Object document, java.lang.String name, java.io.InputStream istream, int length, java.lang.String description, java.lang.String type)
void	addOpenPageParameters(javax.faces.context.FacesContext context, java.lang.String var, ActionOutcomeUrl outcomeUrl)
void	delete(javax.faces.context.FacesContext context, java.lang.Object document)
void	deleteAttachments(javax.faces.context.FacesContext context, java.lang.Object document, java.lang.String name, boolean deleteAll)
java.lang.String	getDocumentId(javax.faces.context.FacesContext context, java.lang.String var)
java.lang.String	getDocumentPage(javax.faces.context.FacesContext context, java.lang.String documentId)
java.util.List<FileRowData>	getEmbeddedImageList(java.lang.Object document, java.lang.String fieldName)
java.lang.String	getParentId(javax.faces.context.FacesContext context, java.lang.Object document)
boolean	isEditable(javax.faces.context.FacesContext context, java.lang.Object document)
void	modifyField(javax.faces.context.FacesContext context, java.lang.Object document, java.lang.String name, java.lang.Object value)
void	save(javax.faces.context.FacesContext context, java.lang.Object document)
void	setDocument(javax.faces.context.FacesContext context, java.lang.Object document, java.lang.Object value)
void	setUserReadOnly(javax.faces.context.FacesContext context, java.lang.Object document, boolean readOnly)

Method Detail

getDocumentId

java.lang.String getDocumentId(javax.faces.context.FacesContext context,
                               java.lang.String var)

Parameters:

context -

var -

Returns:

Return the Document ID for the Document

getDocumentPage

java.lang.String getDocumentPage(javax.faces.context.FacesContext context,
                                 java.lang.String documentId)

Parameters:

context -

documentId -

Returns:

Return the name of XPage associated with the Document

save

void save(javax.faces.context.FacesContext context,
          java.lang.Object document)

Parameters:

context -

document -

setDocument

void setDocument(javax.faces.context.FacesContext context,
                 java.lang.Object document,
                 java.lang.Object value)

Parameters:

context -

document -

value -

isEditable

boolean isEditable(javax.faces.context.FacesContext context,
                   java.lang.Object document)

Parameters:

context -

document -

Returns:

Return true>/code> if the document is editable

setUserReadOnly

void setUserReadOnly(javax.faces.context.FacesContext context,
                     java.lang.Object document,
                     boolean readOnly)

Parameters:

context -

document -

readOnly - true is the document should be read only, false if the document should be editable

modifyField

void modifyField(javax.faces.context.FacesContext context,
                 java.lang.Object document,
                 java.lang.String name,
                 java.lang.Object value)

Parameters:

context -

document -

name -

value -

delete

void delete(javax.faces.context.FacesContext context,
            java.lang.Object document)

Parameters:

document -

getParentId

java.lang.String getParentId(javax.faces.context.FacesContext context,
                             java.lang.Object document)

Parameters:

context -

document -

Returns:

addAttachment

void addAttachment(javax.faces.context.FacesContext context,
                   java.lang.Object document,
                   java.lang.String name,
                   java.io.InputStream istream,
                   int length,
                   java.lang.String description,
                   java.lang.String type)

Parameters:

name -

istream -

length -

description -

type -

addOpenPageParameters

void addOpenPageParameters(javax.faces.context.FacesContext context,
                           java.lang.String var,
                           ActionOutcomeUrl outcomeUrl)

Parameters:

context -

var -

outcomeUrl -

deleteAttachments

void deleteAttachments(javax.faces.context.FacesContext context,
                       java.lang.Object document,
                       java.lang.String name,
                       boolean deleteAll)

Parameters:

context - FacesContext

document - This is typically a RichTextItem that has attachments

name - name of the attachment to be deleted (if deleteAll is false)

deleteAll - will delete all attachments for the RichTextItem

getEmbeddedImageList

java.util.List<FileRowData> getEmbeddedImageList(java.lang.Object document,
                                                 java.lang.String fieldName)

Parameters:

document -

fieldName -

Returns: