IBM Enterprise Records, Version 5.1.2    

Vital

The Vital operation marks an object as vital, which applies a time-bound review process to the object. A vital object is held within a recursive review loop and is periodically reviewed.

To perform the vital operation, you use the VitalableObject interface, which defines the behavior of any vital object. This interface is implemented by RecordCategory, RecordFolder, Volume, and Record objects. To declare an object as vital, you must associate it with a vital trigger and a vital action. A vital trigger specifies the condition on which an action needs to be performed on the object, while a vital action specifies the type of action to be performed on the object. Once an object is marked as vital, the DisposalSweep utility calculates the review date and launches the workflow associated with the vital action.

To set an object as vital, you must create a property collection, as shown in the following code fragment.
//Creates a properties collection 
private Properties getVitalProperties() 
{ 
   // Sets the IsVitalRecord property 
   Property loIsVitalRecord = ObjectFactory.getProperty(RMProperty.IS_VITAL_RECORD); 
   loIsVitalRecord.setValue(true); 
        
   // Sets VitalRecordDisposalTrigger 
   CustomObject loTrigger = (CustomObject)loRMOS.getObject(BaseObject.TYPE_CUSTOMOBJECT, 
      "{6CEE58A6-B8B2-4CAD-8239-3E3BACF57C87}"); 

   //ID of DisposalTrigger 
   Property loVitalRecordDisposalTrigger = 
      ObjectFactory.getProperty(RMProperty.VITAL_RECORD_DISPOSALTRIGGER); 
   loVitalRecordDisposalTrigger.setValue(loTrigger); 
        
   // Sets the VitalRecordReviewAction          
   CustomObject loAction = (CustomObject)loRMOS.getObject(BaseObject.TYPE_CUSTOMOBJECT, 
      "{A8A3FC76-8750-49FF-8A99-151DB4B9CC47}");//ID of VitalRecordReviewAction 
   Property loVitalRecordReviewAction = 
      ObjectFactory.getProperty(RMProperty.VITAL_RECORD_REVIEW_ACTION); 
   loVitalRecordReviewAction.setValue(loAction); 
        
   // Sets the properties collection to declare an entity as //vital          
   Properties loProperties = ObjectFactory.getProperties(); 
   loProperties.add(loIsVitalRecord); 
   loProperties.add(loVitalRecordDisposalTrigger); 
   loProperties.add(loVitalRecordReviewAction); 
   return loProperties; 
} 
Note: You can retrieve the corresponding property collection of a vital object by calling the getClassID method on an RMObject object.


Feedback

Last updated: November 2013
ierdg066.htm

© Copyright IBM Corporation 2013