com.sapportals.wcm.repository

Interface ICopyParameter

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 -


Copyright 2006 SAP AG. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice. Microsoft, Windows, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation. Oracle is a registered trademark of Oracle Corporation. UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group. Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc. HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C, World Wide Web Consortium, Massachusetts Institute of Technology. Java is a registered trademark of Sun Microsystems, Inc. JavaScript is a registered trademark of Sun Microsystems, Inc., used under license for technology invented and implemented by Netscape. MaxDB is a trademark of MySQL AB, Sweden. SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary. These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.