com.jalios.jcms.mashup

Class ImportOptions

java.lang.Object

com.jalios.jcms.mashup.ImportOptions

public class ImportOptions
extends java.lang.Object

This class contains the options used during an import.

Since:

jcms-5.7.3

Version:

$Revision: 27753 $

Author:

Olivier Dedieu

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REVISION

Constructor Summary

Constructors

Constructor and Description
ImportOptions()

Method Summary

Methods

Modifier and Type	Method and Description
void	addOption(java.lang.String key, java.lang.Object value) Add a custom option.
Member	getImportAuthor() Returns the author used for new imported publications.
Workspace	getImportWorkspace() Returns the workspace used for new imported publications.
java.lang.Object	getOption(java.lang.String key) Returns the value of a custom option.
java.util.Map	getOptionMap() Returns the map of custom options.
boolean	isAppendMilestone() Returns true if milestones must be append in the store before and after the import process.
boolean	isImportAsLocal() Returns true if the imported data must be convert to local data.
boolean	isImportCategories() Returns true if the categories have to be imported.
boolean	isImportFiles() Returns true if the attached files have to be imported.
void	removeOption(java.lang.String key) Remove a custom option.
void	setAppendMilestone(boolean appendMilestone) Indicates if milestones must be append in the store before and after the import process.
void	setImportAsLocal(boolean importAsLocal) Indicates if the imported data must be converted to local data.
void	setImportAuthor(Member importAuthor) Sets the author used for new imported publications.
void	setImportCategories(boolean importCategories) Indicates if the categories have to be imported.
void	setImportFiles(boolean importFiles) Indicates if the attached files have to be imported.
void	setImportWorkspace(Workspace importWorkspace) Sets the workspace used for new imported publications.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

REVISION

public static final java.lang.String REVISION

See Also:

Constant Field Values

Constructor Detail

ImportOptions

public ImportOptions()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getImportWorkspace

public Workspace getImportWorkspace()

Returns the workspace used for new imported publications.

Returns:

the import workspace.

Since:

jcms-5.7.3

setImportWorkspace

public void setImportWorkspace(Workspace importWorkspace)

Sets the workspace used for new imported publications. By default, ImportManager.getImportWorkspace() is used.

Parameters:

importWorkspace - the workspace to used for new imported publications.

Since:

jcms-5.7.3

getImportAuthor

public Member getImportAuthor()

Returns the author used for new imported publications.

Returns:

the import author.

Since:

jcms-5.7.3

setImportAuthor

public void setImportAuthor(Member importAuthor)

Sets the author used for new imported publications. By default, ImportManager.getImportAuthor() is used.

Parameters:

importAuthor - the author to used for new imported publication.

Since:

jcms-5.7.3

isImportFiles

public boolean isImportFiles()

Returns true if the attached files have to be imported.

Returns:

true if the attached files have to be imported.

Since:

jcms-5.7.3

setImportFiles

public void setImportFiles(boolean importFiles)

Indicates if the attached files have to be imported.

Parameters:

importFiles - if true the attached files will be imported.

Since:

jcms-5.7.3

isImportCategories

public boolean isImportCategories()

Returns true if the categories have to be imported.

Returns:

true if the categories have to be imported.

Since:

jcms-5.7.3

setImportCategories

public void setImportCategories(boolean importCategories)

Indicates if the categories have to be imported.

Parameters:

importCategories - if true the categories will be imported.

Since:

jcms-5.7.3

isImportAsLocal

public boolean isImportAsLocal()

Returns true if the imported data must be convert to local data.

Returns:

true if the imported data must be convert to local data.

Since:

jcms-5.7.3

setImportAsLocal

public void setImportAsLocal(boolean importAsLocal)

Indicates if the imported data must be converted to local data.

Parameters:

importAsLocal - if true the imported data will be converted to local data.

Since:

jcms-5.7.3

addOption

public void addOption(java.lang.String key,
             java.lang.Object value)

Add a custom option.

Parameters:

key - the option's key.

value - the option's value.

Since:

jcms-5.7.3

removeOption

public void removeOption(java.lang.String key)

Remove a custom option.

Parameters:

key - the option's key

Since:

jcms-5.7.3

getOption

public java.lang.Object getOption(java.lang.String key)

Returns the value of a custom option.

Parameters:

key - the option's key.

Returns:

the value of the custom option.

Since:

jcms-5.7.3

getOptionMap

public java.util.Map getOptionMap()

Returns the map of custom options.

Returns:

the map of custom options.

Since:

jcms-5.7.3

isAppendMilestone

public boolean isAppendMilestone()

Returns true if milestones must be append in the store before and after the import process.

Returns:

true if milestones must be append in the store before and after the import process.

Since:

jcms-5.7.3

setAppendMilestone

public void setAppendMilestone(boolean appendMilestone)

Indicates if milestones must be append in the store before and after the import process.

Parameters:

appendMilestone - if true milestones will be added.

Since:

jcms-5.7.3