com.sapportals.wcm.repository

Class CopyParameter

java.lang.Object
  com.sapportals.wcm.repository.CopyParameter

All Implemented Interfaces:

ICopyParameter

public class CopyParameter
extends Object
implements 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 2001-2004

Constructor Summary

CopyParameter()

CopyParameter(boolean overwrite)

CopyParameter(boolean overwrite, boolean ignorePropertyFailures)

CopyParameter(boolean overwrite, boolean ignorePropertyFailures, boolean copyChildren)

CopyParameter(boolean overwrite, boolean ignorePropertyFailures, boolean copyChildren, boolean copyInternalLinks)

CopyParameter(boolean overwrite, boolean ignorePropertyFailures, boolean copyChildren, boolean copyInternalLinks, boolean copyExternalLinks)

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.
ResourceErrors	getResourceErrors()
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.
void	setResourceErrors(ResourceErrors errors)

Methods inherited from class java.lang.Object

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

Constructor Detail

CopyParameter

public CopyParameter()

CopyParameter

public CopyParameter(boolean overwrite)

CopyParameter

public CopyParameter(boolean overwrite,
                     boolean ignorePropertyFailures)

CopyParameter

public CopyParameter(boolean overwrite,
                     boolean ignorePropertyFailures,
                     boolean copyChildren)

CopyParameter

public CopyParameter(boolean overwrite,
                     boolean ignorePropertyFailures,
                     boolean copyChildren,
                     boolean copyInternalLinks)

CopyParameter

public CopyParameter(boolean overwrite,
                     boolean ignorePropertyFailures,
                     boolean copyChildren,
                     boolean copyInternalLinks,
                     boolean copyExternalLinks)

Method Detail

getCopyChildren

public boolean getCopyChildren()

Description copied from interface: ICopyParameter

Gets the value of this parameter.

Specified by:

getCopyChildren in interface ICopyParameter

Returns:

The copyChildren value

getOverwrite

public boolean getOverwrite()

Description copied from interface: ICopyParameter

Gets the value of this parameter.

Specified by:

getOverwrite in interface ICopyParameter

Returns:

The overwrite value

getIgnorePropertyFailures

public boolean getIgnorePropertyFailures()

Description copied from interface: ICopyParameter

Gets the value of this parameter.

Specified by:

getIgnorePropertyFailures in interface ICopyParameter

Returns:

The ignorePropertyFailures value

getCopyInternalLinks

public boolean getCopyInternalLinks()

Description copied from interface: ICopyParameter

Gets the value of this parameter.

Specified by:

getCopyInternalLinks in interface ICopyParameter

Returns:

The copyInternalLinks value

getCopyExternalLinks

public boolean getCopyExternalLinks()

Description copied from interface: ICopyParameter

Gets the value of this parameter.

Specified by:

getCopyExternalLinks in interface ICopyParameter

Returns:

The copyExternalLinks value

getFirstResourceException

public ResourceException getFirstResourceException()

Description copied from interface: ICopyParameter

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

Specified by:

getFirstResourceException in interface ICopyParameter

Returns:

The first resource exception

setOverwrite

public void setOverwrite(boolean value)

Description copied from interface: ICopyParameter

Existing destination will be overwritten.

Specified by:

setOverwrite in interface ICopyParameter

setIgnorePropertyFailures

public void setIgnorePropertyFailures(boolean value)

Description copied from interface: ICopyParameter

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

Specified by:

setIgnorePropertyFailures in interface ICopyParameter

setCopyChildren

public void setCopyChildren(boolean value)

Description copied from interface: ICopyParameter

Copy all subfolders recursively (deep copy of collections only)

Specified by:

setCopyChildren in interface ICopyParameter

setCopyInternalLinks

public void setCopyInternalLinks(boolean value)

Description copied from interface: ICopyParameter

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

Specified by:

setCopyInternalLinks in interface ICopyParameter

setCopyExternalLinks

public void setCopyExternalLinks(boolean value)

Description copied from interface: ICopyParameter

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

Specified by:

setCopyExternalLinks in interface ICopyParameter

getResourceErrors

public ResourceErrors getResourceErrors()

setResourceErrors

public void setResourceErrors(ResourceErrors errors)

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM