com.filenet.rm.api

Interface RecordCategory

  • All Superinterfaces:
    ActivableObject, com.filenet.wcm.api.BaseObject, ClosableObject, DisposableObject, DispositionAllocatableObject, com.filenet.wcm.api.Folder, com.filenet.wcm.api.GettableObject, HoldableObject, com.filenet.wcm.api.LockableObject, com.filenet.wcm.api.ReadableMetadataObject, com.filenet.wcm.api.ReadableSecurityObject, RMFolder, RMObject, RMRecordCategoryContainer, RMRecordContainer, RMRecordFolderContainer, java.io.Serializable, com.filenet.wcm.api.ValueObject, VitalableObject, com.filenet.wcm.api.WorkflowTarget, com.filenet.wcm.api.WriteableMetadataObject, com.filenet.wcm.api.WriteableSecurityObject


    public interface RecordCategory
    extends RMRecordContainer, RMRecordCategoryContainer, RMRecordFolderContainer, HoldableObject, ClosableObject, ActivableObject, VitalableObject, DispositionAllocatableObject, DisposableObject
    Represents a container that categorizes a set of related records within a file plan. You typically use record categories to classify records based on functional categories. A RecordCategory object can contain also contain subcategories and record folders.

    NOTE  A RecordCategory object can contain RecordInfo objects only in DoD and Base installations of Records Manager. You cannot file a RecordInfo object in a RecordCategory in a PRO installation.

    You can instantiate a RecordCategory object as follows:

    • Call the addRecordCategory method on a ClassificationScheme object to create a new record category in the classification scheme.
    • Call the getDeletedObjects method on the ClassificationScheme class to return the logically deleted BaseObjects.
    • Call the addRecordCategory method on the RecordCategory class to create a record category that is a subcategory of a specified record category.
    • Call the getParentRecordCategories method on the RecordInfo class, which returns an instance of the parent categories.
    • Call the getParentFolder() method on an object whose parent is the RecordCategory object.
    • Call the getRecordCategoryInterface() method on the RMObjectStore object to create a record category for a com.filenet.wcm.api.Folder instance.
    • Call the getContainees method on the ClassificationScheme and RecordCategory.

    • Method Detail

      • move

        void move(RMFolder aoDestinationFolder,
                java.lang.String asReasonForRelocation,
                DispositionSchedule aoDispositionSchedule)
                  throws RMException
        Moves this RecordCategory object to a specified classification scheme or a record category.
        Parameters:
        aoDestinationFolder - An RMFolder object representing the classification scheme or record category to which this RecordCategory object is to be moved.
        asReasonForRelocation - A String specifying the reason this object is being moved.
        aoDispositionSchedule - The DispositionSchedule object that is to be associated with this RecordCategory object after it is moved.
        Throws:
        RMException - If a Records Manager error occurs.

© Copyright IBM Corp. 2003, 2013. All Rights Reserved.