com.sapportals.wcm.repository
Interface ICopyParameter

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.framework_api.jar]

All Known Implementing Classes:

CopyParameter

public interface ICopyParameter

Parameter collection for the copy() and move() methods in IResource and ICollection.

 Defaults:
 overwrite         = false
 omitProperties    = false
 copyChildren      = true
 copyInternalLinks = true
 copyExternalLinks = true
 

copyChildren, copyInternalLinks and copyExternalLinks are used for deep copy of collections only.

Copyright (c) SAP AG 2002

Method Summary

boolean	getCopyChildren() Gets the value of this parameter.
boolean	getCopyExternalLinks() Gets the value of this parameter.
boolean	getCopyInternalLinks() Gets the value of this parameter.
ResourceException	getFirstResourceException() Get the first resource exception.
boolean	getIgnorePropertyFailures() Gets the value of this parameter.
boolean	getOverwrite() Gets the value of this parameter.
void	setCopyChildren(boolean value) Copy all subfolders recursively (deep copy of collections only)
void	setCopyExternalLinks(boolean value) Include/exclude external links (deep copy of collections only)
void	setCopyInternalLinks(boolean value) Include/exclude internal links (deep copy of collections only)
void	setIgnorePropertyFailures(boolean value) Create the copy even if some or all properties could not be set on the destination resource.
void	setOverwrite(boolean value) Existing destination will be overwritten.

Method Detail

getOverwrite

public boolean getOverwrite()

Gets the value of this parameter.

Returns:

The overwrite value

getIgnorePropertyFailures

public boolean getIgnorePropertyFailures()

Gets the value of this parameter.

Returns:

The ignorePropertyFailures value

getCopyChildren

public boolean getCopyChildren()

Gets the value of this parameter.

Returns:

The copyChildren value

getCopyInternalLinks

public boolean getCopyInternalLinks()

Gets the value of this parameter.

Returns:

The copyInternalLinks value

getCopyExternalLinks

public boolean getCopyExternalLinks()

Gets the value of this parameter.

Returns:

The copyExternalLinks value

getFirstResourceException

public ResourceException getFirstResourceException()

Get the first resource exception. This exception will contain a reference to the next exception if more then one copy operation failed.

Returns:

The first resource exception

setCopyChildren

public void setCopyChildren(boolean value)

Copy all subfolders recursively (deep copy of collections only)

Parameters:

value -

setOverwrite

public void setOverwrite(boolean value)

Existing destination will be overwritten.

Parameters:

value -

setIgnorePropertyFailures

public void setIgnorePropertyFailures(boolean value)

Create the copy even if some or all properties could not be set on the destination resource.

Parameters:

value -

setCopyInternalLinks

public void setCopyInternalLinks(boolean value)

Include/exclude internal links (deep copy of collections only)

Parameters:

value -

setCopyExternalLinks

public void setCopyExternalLinks(boolean value)

Include/exclude external links (deep copy of collections only)

Parameters:

value -