|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DocumentBuilder
A document builder builds a document from a URL.
Method Summary | |
---|---|
java.lang.String |
buildCanonicalUrl(Publication publication,
java.lang.String area,
java.lang.String documentid)
Builds an URL corresponding to a cms document from the publication, the area and the document id |
java.lang.String |
buildCanonicalUrl(Publication publication,
java.lang.String area,
java.lang.String documentid,
java.lang.String language)
Builds an URL corresponding to a cms document from the publication, the area, the document id and the language |
Document |
buildDocument(Publication publication,
java.lang.String url)
Builds a document. |
Document |
buildLanguageVersion(Document document,
java.lang.String language)
Builds a clone of a document for another language. |
boolean |
isDocument(Publication publication,
java.lang.String url)
Checks if an URL corresponds to a CMS document. |
Method Detail |
---|
Document buildDocument(Publication publication, java.lang.String url) throws DocumentBuildException
publication
- The publication the document belongs to.url
- The URL of the form /{publication-id}/{area}/{document-id}{language-suffix}.{extension}.
DocumentBuildException
- when something went wrong.boolean isDocument(Publication publication, java.lang.String url) throws DocumentBuildException
publication
- The publication the document belongs to.url
- The URL of the form /{publication-id}/...
DocumentBuildException
- when something went wrong.java.lang.String buildCanonicalUrl(Publication publication, java.lang.String area, java.lang.String documentid, java.lang.String language)
publication
- The publication the document belongs to.area
- The area the document belongs to.documentid
- The document id of the document.language
- The language of the document.
java.lang.String buildCanonicalUrl(Publication publication, java.lang.String area, java.lang.String documentid)
publication
- The publication the document belongs to.area
- The area the document belongs to.documentid
- The document id of the document.
Document buildLanguageVersion(Document document, java.lang.String language)
document
- The document to clone.language
- The language of the target document.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |