Package 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addParameter(String name, String value)
DocumentLocation
getDocumentLocation()
String
getParameter(String name)
Map<String,String>
getParameters()
String
getPatternName()
Returns the url pattern names used to generate this document view.String
getSubURI()
String
getViewId()
Returns the outcome to use for this document view.void
removeParameter(String name)
void
setDocumentLocation(DocumentLocation documentLocation)
void
setPatternName(String patternName)
void
setSubURI(String subURI)
void
setViewId(String viewId)
-
-
-
Method Detail
-
getPatternName
String getPatternName()
Returns the url pattern names used to generate this document view.
-
setPatternName
void setPatternName(String patternName)
-
setDocumentLocation
void setDocumentLocation(DocumentLocation documentLocation)
-
getDocumentLocation
DocumentLocation getDocumentLocation()
-
removeParameter
void removeParameter(String name)
-
getViewId
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(String viewId)
-
getSubURI
String getSubURI()
-
setSubURI
void setSubURI(String subURI)
-
-