org.kuali.rice.krad.data

Class CopyOption

java.lang.Object

org.kuali.rice.krad.data.CopyOption

All Implemented Interfaces:

Serializable

public class CopyOption
extends Object
implements Serializable

CopyOption is used when calling the DataObjectService#copyInstance(Object) method to adjust the behavior of the method. See the constants defined within the class for the available options and descriptions.

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static CopyOption	RESET_OBJECT_ID Specify that the <tt>objectId</tt> field (see GloballyUnique) should be cleared on the copied object and all children.
static CopyOption	RESET_PK_FIELDS Specify that the PK fields on the object must be cleared as part of the copy operation.
static CopyOption	RESET_VERSION_NUMBER Specify that the Version annotated field should be cleared if present on the copied object.

Constructor Summary

Constructors

Constructor and Description
CopyOption(String optionId) Sets the option Id

Method Summary

Methods

Modifier and Type	Method and Description
String	getOptionId() Gets the option id.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

RESET_PK_FIELDS

public static CopyOption RESET_PK_FIELDS

Specify that the PK fields on the object must be cleared as part of the copy operation.

RESET_VERSION_NUMBER

public static CopyOption RESET_VERSION_NUMBER

Specify that the Version annotated field should be cleared if present on the copied object.

RESET_OBJECT_ID

public static CopyOption RESET_OBJECT_ID

Specify that the <tt>objectId</tt> field (see GloballyUnique) should be cleared on the copied object and all children.

Constructor Detail

CopyOption

public CopyOption(String optionId)

Sets the option Id

Parameters:

optionId - cannot be null or blank.

Method Detail

getOptionId

public String getOptionId()

Gets the option id.

Returns:

not null or blank.

toString

public String toString()

Overrides:

toString in class Object