ag.ion.bion.officelayer.document
Interface IDocumentDescriptor

All Known Implementing Classes:

DocumentDescriptor

public interface IDocumentDescriptor

Descriptor of a document. A document descriptor can be used in order to load and store documents.

Method Summary

boolean	getAsPreview() Returns information whether the document should be opened as preview.
boolean	getAsTemplate() Returns information whether the document is a template.
java.lang.String	getAuthor() Returns the author of the document.
java.lang.String	getBaseURL() Returns the base URL of the document.
java.lang.String	getComment() Returns the comment of the document.
boolean	getHidden() Returns information whether the document is hidden.
boolean	getReadOnly() Returns information whether the document should be opened read only.
java.lang.String	getTitle() Returns the title of the document.
java.lang.String	getURL() Returns the URL of the document.
void	setAsPreview(boolean asPreview) Sets information whether the document should be opened as preview.
void	setAsTemplate(boolean asTemplate) Sets information whether the document is a template.
void	setAuthor(java.lang.String author) Sets the author of the document.
void	setBaseURL(java.lang.String baseURL) Sets the base URL of the document to be used to resolve relative links.
void	setComment(java.lang.String comment) Sets the comment of the document.
void	setHidden(boolean hidden) Sets information whether the document is hidden.
void	setReadOnly(boolean readOnly) Sets information whether the document should be opened read only.
void	setTitle(java.lang.String title) Sets the title of the document.
void	setURL(java.lang.String URL) Sets the URL of the document.

Method Detail

setHidden

void setHidden(boolean hidden)

Sets information whether the document is hidden.

Parameters:

hidden - information whether the document is hidden

getHidden

boolean getHidden()

Returns information whether the document is hidden.

Returns:

information whether the document is hidden

setAsTemplate

void setAsTemplate(boolean asTemplate)

Sets information whether the document is a template.

Parameters:

asTemplate - information whether the document is a template

getAsTemplate

boolean getAsTemplate()

Returns information whether the document is a template. The default value is false

Returns:

information whether the document is a template

setReadOnly

void setReadOnly(boolean readOnly)

Sets information whether the document should be opened read only. The default value is false

Parameters:

readOnly - information whether the document should be opened read only

getReadOnly

boolean getReadOnly()

Returns information whether the document should be opened read only. The default value is false

Returns:

information whether the document should be opened read only

setAsPreview

void setAsPreview(boolean asPreview)

Sets information whether the document should be opened as preview. The default value is false

Parameters:

asPreview - information whether the document should be opened as preview

getAsPreview

boolean getAsPreview()

Returns information whether the document should be opened as preview. The default value is false

Returns:

information whether the document should be opened as preview

setAuthor

void setAuthor(java.lang.String author)

Sets the author of the document.

Parameters:

author - the author of the document to be set

getAuthor

java.lang.String getAuthor()

Returns the author of the document.

Returns:

the author of the document

setComment

void setComment(java.lang.String comment)

Sets the comment of the document.

Parameters:

comment - the comment of the document to be set

getComment

java.lang.String getComment()

Returns the comment of the document.

Returns:

the comment of the document

setTitle

void setTitle(java.lang.String title)

Sets the title of the document.

Parameters:

title - the title of the document to be set

getTitle

java.lang.String getTitle()

Returns the title of the document.

Returns:

the title of the document

setBaseURL

void setBaseURL(java.lang.String baseURL)

Sets the base URL of the document to be used to resolve relative links.

Parameters:

baseURL - the base URL of the document to be set

getBaseURL

java.lang.String getBaseURL()

Returns the base URL of the document.

Returns:

the base URL of the document

setURL

void setURL(java.lang.String URL)

Sets the URL of the document. This is the location of the component in URL syntax. It must be the full qualified URL .

Parameters:

URL - the URL of the document to be set

getURL

java.lang.String getURL()

Returns the URL of the document. This is the location of the component in URL syntax. It must be the full qualified URL

Returns:

the URL of the document