RMCustomObject is the base object for
all RM custom objects. A custom object is a general object with no
inherent semantics, but independently securable and can be persisted
to an object store. RMCustomObject wraps the functionality
of the Content Java™ API CustomObject interface.
You can create and retrieve custom objects by using the methods provided
by the RMObjectStore interface. The types of
RM custom objects are:
- Pattern: Encapsulates information for defining
naming pattern grammar for RM entities at each level in the file plan
hierarchy. For more information about creating a Pattern object,
refer to Creating a Pattern object.
- RecordType: Represents a non-hierarchical grouping
of records. A RecordType object has a one-to-many
relationship with RecordInfo objects; however,
a RecordInfo object has a one-to-one relationship
with a RecordType object. For more information
about the relationship between RecordInfo and RecordType objects,
refer to Associating a RecordType object with a RecordInfo object.
- DispositionSchedule: Determines the period
for which an RM entity or its child objects should be retained by
the system. For more information about creating a DispositionSchedule object, refer to Creating a disposition schedule.
- Action: Encapsulates information to define
a sequence of operations that can be performed on an object. For more
information about creating an Action object, refer
to Creating a disposition schedule.
- Event: Enables you to specify a condition on
which you want to execute a particular action on an object. For example,
you can associate an Event object with a disposition
schedule to specify a predefined date for disposing of an RM entity.
For more information about creating an Event object,
refer to Creating a disposition schedule.
- Phase: Stores information about the retention
period and the action to be performed on an entity. The retention
period specifies the period after which the specified action is executed
on the entity. For more information about creating a Phase object,
refer to Creating a disposition schedule.
- Hold: Specifies a rule that prevents you from
performing any disposition-related operations on an RM entity. For
more information about creating a Hold object,
refer to Creating a disposition schedule.
To create a custom object, call the
createRMCustomObject method
on the
RMObjectStore object. In this method,
you pass the following as input parameters: an integer that specifies
the type of custom object to be created; a property collection containing
the values for all the required properties; and a permission collection
for the custom object, as shown in the following code snippet:
// Creates an Action object
void createCustomObject()
{
Properties loProperties = ObjectFactory.getPropeties();
Property loProperty = ObjectFactory.getProperty(RMProperty.ACTION_NAME);
loProperty.setValue("Action");
loProperties.add(loProperty);
RMCustomObject loObject = moRMOS.createRMCustomObject(RMType.RM_TYPE_ACTION,
loProperties, null);
}
To instantiate a custom object, call the
getObject method
on an instance of
RMObjectStore.
String lsObjectId = "{FDB1E9BF-D30D-4071-A3CC-631EB305A445}";
RMCustomObject loRMCustObj =
(RMCustomObject)loRMObjectStore.getObject(RMType.RM_TYPE_ACTION, lsObjectId);