Package org.silverpeas.core.importexport.control

Class ImportSettings

java.lang.Object

org.silverpeas.core.importexport.control.ImportSettings

All Implemented Interfaces:

Cloneable

public class ImportSettings
extends Object
implements Cloneable

Field Summary

Fields

Modifier and Type	Field	Description
static int	FROM_DRAGNDROP
static int	FROM_MANUAL
static int	FROM_XML

Constructor Summary

Constructors

Constructor	Description
ImportSettings(String pathToImport, UserDetail user, String componentId, String folderId, boolean draftUsed, boolean poiUsed, int method)

Method Summary

Modifier and Type	Method	Description
ImportSettings	clone()
String	getComponentId()
String	getContentLanguage()
String	getFolderId()
int	getMethod()
String	getPathToImport()
PublicationDetail	getPublicationForAllFiles()	Gets the instance of PublicationDetail that stores the following data in case of creation of one publication for all imported files: the name of the publication.
String	getPublicationName(String filename)
String	getSingleFileDescription()
String	getSingleFileTitle()
String	getTargetValidatorIds()
UserDetail	getUser()
String	getVersionComment()
int	getVersionType()
boolean	isDraftUsed()
boolean	isFromDocumentTemplate()
boolean	isPoiUsed()
boolean	isPublicationMergeEnabled()
boolean	isUseFileMetadata()
boolean	isVersioningUsed()
boolean	mustCreateOnePublicationForAllFiles()	Indicates that it must be created one publication for all files.
void	setContentLanguage(String contentLanguage)
void	setFolderId(String folderId)
void	setFrom(int from)
void	setFromDocumentTemplate(boolean fromDocumentTemplate)
void	setPathToImport(String path)
void	setSingleFileDescription(String singleFileDescription)
void	setSingleFileTitle(String singleFileTitle)
void	setTargetValidatorIds(String targetValidatorIds)
void	setVersionAndComment(int versionType, String comment)
void	setVersioningUsed(boolean versioningUsed)
void	setVersionType(int versionType)
boolean	useFileDates()

Methods inherited from class java.lang.Object

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

Field Detail

FROM_XML

public static final int FROM_XML

See Also:

Constant Field Values

FROM_DRAGNDROP

public static final int FROM_DRAGNDROP

See Also:

Constant Field Values

FROM_MANUAL

public static final int FROM_MANUAL

See Also:

Constant Field Values

Constructor Detail

ImportSettings

public ImportSettings(String pathToImport,
                      UserDetail user,
                      String componentId,
                      String folderId,
                      boolean draftUsed,
                      boolean poiUsed,
                      int method)

Method Detail

getPathToImport

public String getPathToImport()

setPathToImport

public void setPathToImport(String path)

getUser

public UserDetail getUser()

getComponentId

public String getComponentId()

getFolderId

public String getFolderId()

setFolderId

public void setFolderId(String folderId)

isDraftUsed

public boolean isDraftUsed()

isPoiUsed

public boolean isPoiUsed()

setVersioningUsed

public void setVersioningUsed(boolean versioningUsed)

isVersioningUsed

public boolean isVersioningUsed()

setFrom

public void setFrom(int from)

getMethod

public int getMethod()

isPublicationMergeEnabled

public boolean isPublicationMergeEnabled()

mustCreateOnePublicationForAllFiles

public boolean mustCreateOnePublicationForAllFiles()

Indicates that it must be created one publication for all files.

PLEASE notice that the creation of one publication for all files is compatible only with getMethod() returning FROM_DRAGNDROP. The code has to be adjusted for other processes.

Returns:

true if one publication only must be created.

getPublicationForAllFiles

public PublicationDetail getPublicationForAllFiles()

Gets the instance of PublicationDetail that stores the following data in case of creation of one publication for all imported files:

• the name of the publication. If it exists then the method mustCreateOnePublicationForAllFiles() will indicate that all files will be attached to a same publication
• the description of a publication
• the keywords of a publication

Returns:

a string that represents the publication description.

getPublicationName

public String getPublicationName(String filename)

setVersionType

public void setVersionType(int versionType)

setVersionAndComment

public void setVersionAndComment(int versionType,
                                 String comment)

getVersionType

public int getVersionType()

getVersionComment

public String getVersionComment()

getSingleFileTitle

public String getSingleFileTitle()

setSingleFileTitle

public void setSingleFileTitle(String singleFileTitle)

getSingleFileDescription

public String getSingleFileDescription()

setSingleFileDescription

public void setSingleFileDescription(String singleFileDescription)

isUseFileMetadata

public boolean isUseFileMetadata()

getContentLanguage

public String getContentLanguage()

setContentLanguage

public void setContentLanguage(String contentLanguage)

getTargetValidatorIds

public String getTargetValidatorIds()

setTargetValidatorIds

public void setTargetValidatorIds(String targetValidatorIds)

isFromDocumentTemplate

public boolean isFromDocumentTemplate()

setFromDocumentTemplate

public void setFromDocumentTemplate(boolean fromDocumentTemplate)

useFileDates

public boolean useFileDates()

clone

public ImportSettings clone()

Overrides:

clone in class Object