com.ibm.workplace.wcm.api
Class TreatAsNewCopyOption

java.lang.Object
  com.ibm.workplace.wcm.api.TreatAsNewCopyOption

All Implemented Interfaces:

CopyOption

public class TreatAsNewCopyOption
extends java.lang.Object
implements CopyOption

This CopyOption is used to indicate that the copy should be treated as if a new item was being created. For instance, the creator, author and owner of the copied item will all be set to the given user, the creation date will set as the creation date of the 'new' item, rather than that of the copied item, and the published date will be updated if necessary. The actions of the workflowstage will be executed if required. This is useful for complex site area and content creation scenarios, where creating a content from an authoring template is not sufficient. Instead, we want to create a whole branch of site areas and content, and treat these as new items. This option is effectively the same as applying the ReplaceCreatorCopyOption, UpdatePublishedDateCopyOption and optionally the CopyIntoProjectOption, and ReplaceOwnersCopyOption, ReplaceAuthorsCopyOption with one user specified.

Since:

8.0.0.1 CF9

Constructor Summary

TreatAsNewCopyOption(java.security.Principal user)
Constructor - create TreatAsNewCopyOption with a Java Security Principal

TreatAsNewCopyOption(java.lang.String user)
Constructor - create TreatAsNewCopyOption with a String.

TreatAsNewCopyOption(com.ibm.portal.um.User user)
Constructor - create TreatAsNewCopyOption with a PUMA User

Method Summary

void	clearAuthors(boolean p_clearAuthors) Set whether all authors should be removed from a copied item
void	clearOwners(boolean p_clearOwners) Set whether all owners should be removed from a copied item
boolean	getExecuteEntryActions() Get the boolean to indicate whether entry actions should be executed for a copied item
java.lang.String	getProjectUuid() Get the project id to which the item(s) will be copied.
java.security.Principal	getUser() Get the creating user to set as creator, author and owner of the copied item, if it has been set as a Java Security Principal, otherwise null
java.lang.String	getUserAsString() Get the creating user to set as creator, author and owner of the copied item, if it has been set as a String, otherwise null.
boolean	isClearingAuthors() Get the boolean to indicate whether all authors should be removed for a copied item
boolean	isClearingOwners() Get the boolean to indicate whether all owners should be removed for a copied item
boolean	isSettingManager() Get the boolean to indicate whether to add the creator as a manager of a copied item
void	setExecuteEntryActions(boolean p_executeEntryActions) Set whether entry actions should be executed for a copied item
void	setManager(boolean p_setManager) Set whether to add the creator as a manager of a copied item or not
void	setProjectUuid(java.lang.String projectUuid) Set the project UUID to copy the item(s) into a project.
java.lang.String	toString()
com.ibm.portal.um.User	user() Get the creating user to set as creator, author and owner of the copied item, if it has been set as a PUMA user, otherwise null

Methods inherited from class java.lang.Object

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

Constructor Detail

TreatAsNewCopyOption

public TreatAsNewCopyOption(java.security.Principal user)

Constructor - create TreatAsNewCopyOption with a Java Security Principal

Parameters:

user - the user to set as creator, author and owner of the copied item

TreatAsNewCopyOption

public TreatAsNewCopyOption(com.ibm.portal.um.User user)

Constructor - create TreatAsNewCopyOption with a PUMA User

Parameters:

user - the user to use

TreatAsNewCopyOption

public TreatAsNewCopyOption(java.lang.String user)

Constructor - create TreatAsNewCopyOption with a String. Can be a user DN or CN, depending on setting in Workspace.useDistinguishedNames().

Parameters:

user - the user to set as creator, author and owner of the copied item

Method Detail

setProjectUuid

public void setProjectUuid(java.lang.String projectUuid)

Set the project UUID to copy the item(s) into a project. If not set, the item(s) will not be copied into a project.

Parameters:

projectUuid - the project UUID to which the item(s) has to be copied into

getProjectUuid

public java.lang.String getProjectUuid()

Get the project id to which the item(s) will be copied. If not set, the item(s) will not be copied into a project.

Returns:

the project UUID to which the item(s) has to be copied into

setExecuteEntryActions

public void setExecuteEntryActions(boolean p_executeEntryActions)

Set whether entry actions should be executed for a copied item

Parameters:

p_executeEntryActions - whether entry actions should be executed for a copied item

getExecuteEntryActions

public boolean getExecuteEntryActions()

Get the boolean to indicate whether entry actions should be executed for a copied item

Returns:

the boolean to indicate whether entry actions should be executed for a copied item

getUser

public java.security.Principal getUser()

Get the creating user to set as creator, author and owner of the copied item, if it has been set as a Java Security Principal, otherwise null

Returns:

the user

getUserAsString

public java.lang.String getUserAsString()

Get the creating user to set as creator, author and owner of the copied item, if it has been set as a String, otherwise null. Can be a user DN or CN, depending on setting in Workspace.useDistinguishedNames().

Returns:

the user

user

public com.ibm.portal.um.User user()

Get the creating user to set as creator, author and owner of the copied item, if it has been set as a PUMA user, otherwise null

Returns:

the user, if it has been set as a PUMA User, otherwise null

clearOwners

public void clearOwners(boolean p_clearOwners)

Set whether all owners should be removed from a copied item

Parameters:

p_clearOwners - the boolean to indicate whether the owners will be cleared

Since:

8.5 CF8

isClearingOwners

public boolean isClearingOwners()

Get the boolean to indicate whether all owners should be removed for a copied item

Returns:

the flag to indicate whether the owners will be cleared

Since:

8.5 CF8

clearAuthors

public void clearAuthors(boolean p_clearAuthors)

Set whether all authors should be removed from a copied item

Parameters:

p_clearAuthors - the boolean to indicate whether the authors will be cleared

Since:

8.5 CF8

isClearingAuthors

public boolean isClearingAuthors()

Get the boolean to indicate whether all authors should be removed for a copied item

Returns:

the flag to indicate whether the authors will be cleared

Since:

8.5 CF8

setManager

public void setManager(boolean p_setManager)

Set whether to add the creator as a manager of a copied item or not

Parameters:

p_setManager - whether to add the creator as a manager of a copied item

Since:

8.5 CF8

isSettingManager

public boolean isSettingManager()

Get the boolean to indicate whether to add the creator as a manager of a copied item

Returns:

the boolean to indicate whether to add the creator as a manager of a copied item

Since:

8.5 CF8

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object