org.nuxeo.ecm.platform.url.api
Interface DocumentView

All Known Implementing Classes:

DocumentViewImpl

public interface DocumentView

Document information describing a document context.

Some information is required (document location). Other information (like the currently selected tab) are handled through parameters.*

This interface is used to map a url to a document context.

Method Summary

void	addParameter(java.lang.String name, java.lang.String value)
DocumentLocation	getDocumentLocation()
java.lang.String	getParameter(java.lang.String name)
java.util.Map<java.lang.String,java.lang.String>	getParameters()
java.lang.String	getPatternName() Returns the url pattern names used to generate this document view.
java.lang.String	getSubURI()
java.lang.String	getTabId() Deprecated. should use the parameters map for the tab identifier.
java.lang.String	getViewId() Returns the outcome to use for this document view.
void	removeParameter(java.lang.String name)
void	setDocumentLocation(DocumentLocation documentLocation)
void	setPatternName(java.lang.String patternName)
void	setSubURI(java.lang.String subURI)
void	setViewId(java.lang.String viewId)

Method Detail

getPatternName

java.lang.String getPatternName()

Returns the url pattern names used to generate this document view.

setPatternName

void setPatternName(java.lang.String patternName)

setDocumentLocation

void setDocumentLocation(DocumentLocation documentLocation)

getDocumentLocation

DocumentLocation getDocumentLocation()

getParameters

java.util.Map<java.lang.String,java.lang.String> getParameters()

getParameter

java.lang.String getParameter(java.lang.String name)

addParameter

void addParameter(java.lang.String name,
                  java.lang.String value)

removeParameter

void removeParameter(java.lang.String name)

getViewId

java.lang.String getViewId()

Returns the outcome to use for this document view.

XXX AT: Can be considered to be badly named "view id".

setViewId

void setViewId(java.lang.String viewId)

getSubURI

java.lang.String getSubURI()

setSubURI

void setSubURI(java.lang.String subURI)

getTabId

@Deprecated
java.lang.String getTabId()

Deprecated. should use the parameters map for the tab identifier.