|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Document
A CMS document.
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_PREFIX
|
static java.lang.String |
NAMESPACE
|
Method Summary | |
---|---|
boolean |
exists()
Check if a document with the given document-id, language and in the given area actually exists. |
boolean |
existsInAnyLanguage()
Check if a document exists with the given document-id and the given area independently of the given language. |
java.lang.String |
getArea()
Returns the area this document belongs to. |
java.lang.String |
getCompleteInfoURL()
Returns the complete URL of this document in the info area: /{publication-id}/info-{area}{document-id}{language-suffix}. |
java.lang.String |
getCompleteURL()
Returns the complete URL of this document: /{publication-id}/{area}{document-id}{language-suffix}. |
java.lang.String |
getCompleteURLWithoutLanguage()
Returns the complete URL of this document without the language-suffix: /{publication-id}/{area}{document-id}. |
java.lang.String |
getDocumentURL()
Returns the URL of this document: {document-id}{language-suffix}. |
DublinCore |
getDublinCore()
Returns the dublin core class for this document. |
java.lang.String |
getExtension()
Returns the extension in the URL. |
java.io.File |
getFile()
Returns the file for this document. |
java.lang.String |
getId()
Returns the document ID of this document. |
java.lang.String |
getLabel()
Get the navigation label associated with this document for the language. |
java.lang.String |
getLanguage()
Returns the language of this document. |
java.lang.String[] |
getLanguages()
Returns all the languages this document is available in. |
java.util.Date |
getLastModified()
Returns the date of the last modification of this document. |
java.lang.String |
getName()
Returns the document name of this document. |
java.lang.String |
getNodeId()
Instead of returning the full document-id for this document it just returns the id of the particular node, basically the basename of the document-id. |
Publication |
getPublication()
Returns the publication this document belongs to. |
Field Detail |
---|
static final java.lang.String NAMESPACE
static final java.lang.String DEFAULT_PREFIX
Method Detail |
---|
java.lang.String getId()
java.lang.String getName()
java.lang.String getNodeId()
Publication getPublication()
java.lang.String getCompleteInfoURL()
java.lang.String getCompleteURL()
java.lang.String getCompleteURLWithoutLanguage()
java.lang.String getDocumentURL()
DublinCore getDublinCore()
java.lang.String getLanguage()
java.lang.String[] getLanguages() throws DocumentException
DocumentException
- if an error occursjava.lang.String getLabel() throws DocumentException
DocumentException
- if an error occursjava.util.Date getLastModified()
java.lang.String getArea()
java.io.File getFile()
java.lang.String getExtension()
boolean exists() throws DocumentException
DocumentException
- if an error occursboolean existsInAnyLanguage() throws DocumentException
DocumentException
- if an error occurs
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |