Content Engine Java API: CmRecoveryItem

All Superinterfaces:

EngineObject, IndependentlyPersistableObject, IndependentObject, RepositoryObject, java.io.Serializable, Subscribable
```
public interface CmRecoveryItem
extends RepositoryObject, Subscribable, IndependentlyPersistableObject
```
A representative for one or more objects that have been marked for deletion. An object marked for deletion is a recoverable object, that is, an object that still exists in the object store database and can be restored.
The recoverable objects represented by a CmRecoveryItem object consist of an object that was originally marked for deletion by a user, plus any objects referenced by object-valued properties (OVPs) of the original object. The referenced objects are marked for deletion by a cascade-delete operation performed by the server.

In general, recoverable objects cannot be accessed directly; they can only be accessed through the CmRecoveryItem objects that represent them. A set of recovery items can be retrieved from a CmRecoveryBin object. By default, a recovery item inherits its permissions from the CmRecoveryBin object that contains it.

A user can invoke either a recovery or purge operation on a CmRecoveryItem object. The recovery operation restores the original object that was marked for deletion and any cascade-deleted objects referenced by OVPs of the original object. The purge operation deletes the original object and any cascade-deleted objects (removes them from the object store database).

Metadata

Auditable: true
AllowsInstances: true
AllowsSubClasses: true
ClassDefinitionName: SubscribableClassDefinition
IsDependent: false
IsHidden: false
Name: OriginalName
Searchable: true
StorageType: ObjectStore
SuperclassName: Subscribable

See Also:
Recovery Bin Concepts

Method Summary

Methods
Modifier and Type	Method and Description
`ActiveMarkingList`	`get_ActiveMarkings()` Returns the value of the ActiveMarkings property.
`EventSet`	`get_AuditedEvents()` Returns the value of the AuditedEvents property.
`java.lang.String`	`get_Creator()` Returns the value of the Creator property.
`java.util.Date`	`get_DateCreated()` Returns the value of the DateCreated property.
`java.util.Date`	`get_DateLastModified()` Returns the value of the DateLastModified property.
`Id`	`get_Id()` Returns the value of the Id property.
`java.lang.Boolean`	`get_InheritRecoveryBinPermissions()` Returns the value of the InheritRecoveryBinPermissions property.
`java.lang.String`	`get_LastModifier()` Returns the value of the LastModifier property.
`Id`	`get_OriginalClassId()` Returns the value of the OriginalClassId property.
`java.lang.String`	`get_OriginalCreator()` Returns the value of the OriginalCreator property.
`java.util.Date`	`get_OriginalDateCreated()` Returns the value of the OriginalDateCreated property.
`java.util.Date`	`get_OriginalDateLastModified()` Returns the value of the OriginalDateLastModified property.
`Id`	`get_OriginalId()` Returns the value of the OriginalId property.
`java.lang.String`	`get_OriginalLastModifier()` Returns the value of the OriginalLastModifier property.
`java.lang.String`	`get_OriginalName()` Returns the value of the OriginalName property.
`Subscribable`	`get_OriginalObject()` Returns the value of the OriginalObject property.
`java.lang.String`	`get_Owner()` Returns the value of the Owner property.
`AccessPermissionList`	`get_Permissions()` Returns the value of the Permissions property.
`java.lang.Integer`	`get_RecoverableObjectsCount()` Returns the value of the RecoverableObjectsCount property.
`CmRecoveryBin`	`get_RecoveryBin()` Returns the value of the RecoveryBin property.
`void`	`recover()` Initiates recovery of the objects represented by this recovery item.
`void`	`set_Creator(java.lang.String value)` Sets the value of the Creator property.
`void`	`set_DateCreated(java.util.Date value)` Sets the value of the DateCreated property.
`void`	`set_DateLastModified(java.util.Date value)` Sets the value of the DateLastModified property.
`void`	`set_InheritRecoveryBinPermissions(java.lang.Boolean value)` Sets the value of the InheritRecoveryBinPermissions property.
`void`	`set_LastModifier(java.lang.String value)` Sets the value of the LastModifier property.
`void`	`set_OriginalObject(Subscribable value)` Sets the value of the OriginalObject property.
`void`	`set_Owner(java.lang.String value)` Sets the value of the Owner property.
`void`	`set_Permissions(AccessPermissionList value)` Sets the value of the Permissions property.
`void`	`set_RecoveryBin(CmRecoveryBin value)` Sets the value of the RecoveryBin property.

Methods inherited from interface com.filenet.api.core.RepositoryObject
getObjectStore

Methods inherited from interface com.filenet.api.core.Subscribable
raiseEvent

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber

Methods inherited from interface com.filenet.api.core.IndependentObject
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh

Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses

- Method Detail
  - get_Creator
```
java.lang.String get_Creator()
```
    Returns the value of the Creator property. For more information, see Creator Property.
  - set_Creator
```
void set_Creator(java.lang.String value)
```
    Sets the value of the Creator property. For more information, see Creator Property.
  - get_DateCreated
```
java.util.Date get_DateCreated()
```
    Returns the value of the DateCreated property. For more information, see DateCreated Property.
  - set_DateCreated
```
void set_DateCreated(java.util.Date value)
```
    Sets the value of the DateCreated property. For more information, see DateCreated Property.
  - get_LastModifier
```
java.lang.String get_LastModifier()
```
    Returns the value of the LastModifier property. For more information, see LastModifier Property.
  - set_LastModifier
```
void set_LastModifier(java.lang.String value)
```
    Sets the value of the LastModifier property. For more information, see LastModifier Property.
  - get_DateLastModified
```
java.util.Date get_DateLastModified()
```
    Returns the value of the DateLastModified property. For more information, see DateLastModified Property.
  - set_DateLastModified
```
void set_DateLastModified(java.util.Date value)
```
    Sets the value of the DateLastModified property. For more information, see DateLastModified Property.
  - get_Id
```
Id get_Id()
```
    Returns the value of the Id property. For more information, see Id Property.
  - get_AuditedEvents
```
EventSet get_AuditedEvents()
```
    Returns the value of the AuditedEvents property. For more information, see AuditedEvents Property.
  - get_Owner
```
java.lang.String get_Owner()
```
    Returns the value of the Owner property. For more information, see Owner Property.
  - set_Owner
```
void set_Owner(java.lang.String value)
```
    Sets the value of the Owner property. For more information, see Owner Property.
  - get_Permissions
```
AccessPermissionList get_Permissions()
```
    Returns the value of the Permissions property. For more information, see Permissions Property.
  - set_Permissions
```
void set_Permissions(AccessPermissionList value)
```
    Sets the value of the Permissions property. For more information, see Permissions Property.
  - get_ActiveMarkings
```
ActiveMarkingList get_ActiveMarkings()
```
    Returns the value of the ActiveMarkings property. For more information, see ActiveMarkings Property.
  - get_RecoveryBin
```
CmRecoveryBin get_RecoveryBin()
```
    Returns the value of the RecoveryBin property. For more information, see RecoveryBin Property.
  - set_RecoveryBin
```
void set_RecoveryBin(CmRecoveryBin value)
```
    Sets the value of the RecoveryBin property. For more information, see RecoveryBin Property.
  - get_InheritRecoveryBinPermissions
```
java.lang.Boolean get_InheritRecoveryBinPermissions()
```
    Returns the value of the InheritRecoveryBinPermissions property. For more information, see InheritRecoveryBinPermissions Property.
  - set_InheritRecoveryBinPermissions
```
void set_InheritRecoveryBinPermissions(java.lang.Boolean value)
```
    Sets the value of the InheritRecoveryBinPermissions property. For more information, see InheritRecoveryBinPermissions Property.
  - get_OriginalObject
```
Subscribable get_OriginalObject()
```
    Returns the value of the OriginalObject property. For more information, see OriginalObject Property.
  - set_OriginalObject
```
void set_OriginalObject(Subscribable value)
```
    Sets the value of the OriginalObject property. For more information, see OriginalObject Property.
  - get_RecoverableObjectsCount
```
java.lang.Integer get_RecoverableObjectsCount()
```
    Returns the value of the RecoverableObjectsCount property. For more information, see RecoverableObjectsCount Property.
  - get_OriginalId
```
Id get_OriginalId()
```
    Returns the value of the OriginalId property. For more information, see OriginalId Property.
  - get_OriginalClassId
```
Id get_OriginalClassId()
```
    Returns the value of the OriginalClassId property. For more information, see OriginalClassId Property.
  - get_OriginalName
```
java.lang.String get_OriginalName()
```
    Returns the value of the OriginalName property. For more information, see OriginalName Property.
  - get_OriginalCreator
```
java.lang.String get_OriginalCreator()
```
    Returns the value of the OriginalCreator property. For more information, see OriginalCreator Property.
  - get_OriginalDateCreated
```
java.util.Date get_OriginalDateCreated()
```
    Returns the value of the OriginalDateCreated property. For more information, see OriginalDateCreated Property.
  - get_OriginalLastModifier
```
java.lang.String get_OriginalLastModifier()
```
    Returns the value of the OriginalLastModifier property. For more information, see OriginalLastModifier Property.
  - get_OriginalDateLastModified
```
java.util.Date get_OriginalDateLastModified()
```
    Returns the value of the OriginalDateLastModified property. For more information, see OriginalDateLastModified Property.
  - recover
```
void recover()
```
    Initiates recovery of the objects represented by this recovery item. It restores the original object that was marked for deletion and any cascade-deleted objects referenced by OVPs of the original object.

Methods inherited from interface com.filenet.api.core.RepositoryObject

Methods inherited from interface com.filenet.api.core.Subscribable

Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject

Methods inherited from interface com.filenet.api.core.IndependentObject

Methods inherited from interface com.filenet.api.core.EngineObject

get_Creator

set_Creator

get_DateCreated

set_DateCreated

get_LastModifier

set_LastModifier

get_DateLastModified

set_DateLastModified

get_Id

get_AuditedEvents

get_Owner

set_Owner

get_Permissions

set_Permissions

get_ActiveMarkings

get_RecoveryBin

set_RecoveryBin

get_InheritRecoveryBinPermissions

set_InheritRecoveryBinPermissions

get_OriginalObject

set_OriginalObject

get_RecoverableObjectsCount

get_OriginalId

get_OriginalClassId

get_OriginalName

get_OriginalCreator

get_OriginalDateCreated

get_OriginalLastModifier

get_OriginalDateLastModified

recover