ag.ion.bion.officelayer.document
Class DocumentDescriptor

java.lang.Object
  ag.ion.bion.officelayer.document.DocumentDescriptor

All Implemented Interfaces:

IDocumentDescriptor

public class DocumentDescriptor
extends java.lang.Object
implements IDocumentDescriptor

Descriptor of a document. A document descriptor can be used in order control the load or store process of a document.

Field Summary

static DocumentDescriptor	DEFAULT A default document descriptor.
static DocumentDescriptor	DEFAULT_HIDDEN A default document descriptor for hidden documents.

Constructor Summary

DocumentDescriptor()
Constructs new DocumentDescriptor.

DocumentDescriptor(boolean hidden)
Constructs new DocumentDescriptor.

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT

public static final DocumentDescriptor DEFAULT

A default document descriptor.

DEFAULT_HIDDEN

public static final DocumentDescriptor DEFAULT_HIDDEN

A default document descriptor for hidden documents.

Constructor Detail

DocumentDescriptor

public DocumentDescriptor()

Constructs new DocumentDescriptor.

DocumentDescriptor

public DocumentDescriptor(boolean hidden)

Constructs new DocumentDescriptor.

Parameters:

hidden - information whether the document is hidden

Method Detail

setHidden

public void setHidden(boolean hidden)

Sets information whether the document is hidden.

Specified by:

setHidden in interface IDocumentDescriptor

Parameters:

hidden - information whether the document is hidden

getHidden

public boolean getHidden()

Returns information whether the document is hidden.

Specified by:

getHidden in interface IDocumentDescriptor

Returns:

information whether the document is hidden

setAsTemplate

public void setAsTemplate(boolean asTemplate)

Sets information whether the document is a template.

Specified by:

setAsTemplate in interface IDocumentDescriptor

Parameters:

asTemplate - information whether the document is a template

getAsTemplate

public boolean getAsTemplate()

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

Specified by:

getAsTemplate in interface IDocumentDescriptor

Returns:

information whether the document is a template

setReadOnly

public void setReadOnly(boolean readOnly)

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

Specified by:

setReadOnly in interface IDocumentDescriptor

Parameters:

readOnly - information whether the document should be opened read only

getReadOnly

public boolean getReadOnly()

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

Specified by:

getReadOnly in interface IDocumentDescriptor

Returns:

information whether the document should be opened read only

setAsPreview

public void setAsPreview(boolean asPreview)

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

Specified by:

setAsPreview in interface IDocumentDescriptor

Parameters:

asPreview - information whether the document should be opened as preview

getAsPreview

public boolean getAsPreview()

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

Specified by:

getAsPreview in interface IDocumentDescriptor

Returns:

information whether the document should be opened as preview

setAuthor

public void setAuthor(java.lang.String author)

Sets the author of the document.

Specified by:

setAuthor in interface IDocumentDescriptor

Parameters:

author - the author of the document to be set

getAuthor

public java.lang.String getAuthor()

Returns the author of the document.

Specified by:

getAuthor in interface IDocumentDescriptor

Returns:

the author of the document

setComment

public void setComment(java.lang.String comment)

Sets the comment of the document.

Specified by:

setComment in interface IDocumentDescriptor

Parameters:

comment - the comment of the document to be set

getComment

public java.lang.String getComment()

Returns the comment of the document.

Specified by:

getComment in interface IDocumentDescriptor

Returns:

the comment of the document

setTitle

public void setTitle(java.lang.String title)

Sets the title of the document.

Specified by:

setTitle in interface IDocumentDescriptor

Parameters:

title - the title of the document to be set

getTitle

public java.lang.String getTitle()

Returns the title of the document.

Specified by:

getTitle in interface IDocumentDescriptor

Returns:

the title of the document

setBaseURL

public void setBaseURL(java.lang.String baseURL)

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

Specified by:

setBaseURL in interface IDocumentDescriptor

Parameters:

baseURL - the base URL of the document to be set

getBaseURL

public java.lang.String getBaseURL()

Returns the base URL of the document.

Specified by:

getBaseURL in interface IDocumentDescriptor

Returns:

the base URL of the document

setURL

public 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 .

Specified by:

setURL in interface IDocumentDescriptor

Parameters:

URL - the URL of the document to be set

getURL

public 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

Specified by:

getURL in interface IDocumentDescriptor

Returns:

the URL of the document