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

  1. public interface RecordCategory
  2. 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:


Field Summary

Fields inherited from interface com.filenet.rm.api.RMObject
AGGREGATION_RECORD, AGGREGATION_RECORD_CATEGORY, AGGREGATION_RECORD_FOLDER, AGGREGATION_VOLUME, CLEAR_INHERITED_CHILDREN, INHERIT_IMMEDIATE_CHILDREN, INHERITED_CHILDREN, NON_INHERITED_CHILDREN, WORK_FLOW_STATUS_COMPLETED, WORK_FLOW_STATUS_NOT_STARTED, WORK_FLOW_STATUS_STARTED
Fields inherited from interface com.filenet.wcm.api.BaseObject
EXPORT_DEFAULT, EXPORT_ENCODED_CONTENT, EXPORT_FULL, EXPORT_OBJECT_ID, EXPORT_OBJECT_SECURITY, IMPORT_DEFAULT, IMPORT_OBJECT_ID, IMPORT_OWNER, IMPORT_PERMISSIONS, TYPE_ACTIVE_MARKING, TYPE_ANNOTATION, TYPE_ANY, TYPE_AUDIT_DEFINITION, TYPE_CBR_ENGINE_TYPE, TYPE_CHOICE, TYPE_CHOICELIST, TYPE_CLASS_SUBSCRIPTION, TYPE_CLASSDEFINITION, TYPE_CLASSDESCRIPTION, TYPE_COLUMN_DEFINITION, TYPE_COMPUTER, TYPE_CONTENT_CACHE_SERVICE, TYPE_CONTENT_MGR_SERVICE, TYPE_CONTENT_REFERENCE, TYPE_CONTENT_TRANSFER, TYPE_CUSTOMOBJECT, TYPE_DOCUMENT, TYPE_DOCUMENT_CLASSIFICATION_ACTION, TYPE_DOCUMENT_LIFECYCLE_ACTION, TYPE_DOCUMENT_LIFECYCLE_POLICY, TYPE_DOCUMENTSTATE, TYPE_DOMAIN, TYPE_DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_ENTIRENETWORK, TYPE_EVENT, TYPE_EVENT_ACTION, TYPE_FEATURE_ADD_ON, TYPE_FILESTORE, TYPE_FOLDER, TYPE_GROUP, TYPE_INSTANCE_SUBSCRIPTION, TYPE_LINK, TYPE_LOCALIZED_STRING, TYPE_MARKING_SET, TYPE_MULTIPLEVALUES, TYPE_OBJECT_STORE, TYPE_OBJECTSET, TYPE_OBJSTORE_SERVICE, TYPE_PERMISSION, TYPE_PROPERTY_DEFINITION, TYPE_PROPERTYDESCRIPTION, TYPE_PROPERTYDESCRIPTIONS, TYPE_PUBLISH_REQUEST, TYPE_PUBLISH_TEMPLATE, TYPE_READONLY_OBJECT_SET, TYPE_REALM, TYPE_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_SECURITY_POLICY, TYPE_SECURITY_TEMPLATE, TYPE_STORAGE_POLICY, TYPE_STORED_SEARCH, TYPE_STYLE_TEMPLATE, TYPE_SUBSCRIBED_EVENT, TYPE_SUBSCRIPTION, TYPE_TABLE_DEFINITION, TYPE_TRANSIENT, TYPE_USER, TYPE_VERSIONSERIES, TYPE_WORKFLOW_CLASS_SUBSCRIPTION, TYPE_WORKFLOW_INSTANCE_SUBSCRIPTION, TYPE_WORKFLOWDEFINITION, TYPE_XML_PROPERTY_MAPPING_SCRIPT

Method Summary

Modifier and Type Method and Description
  1. void
move(RMFolder aoDestinationFolder,java.lang.String asReasonForRelocation,DispositionSchedule aoDispositionSchedule)
Moves this RecordCategory object to a specified classification scheme or a record category.
Methods inherited from interface com.filenet.rm.api.RMRecordContainer
canDeclare, clearDispositionSchedule, declare, declare, declare, declare, declareAllVersions, declareAllVersions, declareAllVersions, declareAllVersions, declareAndClassify, declareAndClassify, delete, getPatternBaseName, getPatternBaseName, getPatternBaseName, getPatternBaseName, setProperties, validateCloseProperty, validateInactiveProperty
Methods inherited from interface com.filenet.rm.api.RMRecordCategoryContainer
addRecordCategory, getPatternBaseName, getPatternBaseName, getPatternBaseName, getPatternBaseName
Methods inherited from interface com.filenet.rm.api.RMRecordFolderContainer
addRecordFolder, addRecordFolder, getPatternBaseName, getPatternBaseName, getPatternBaseName, getPatternBaseName
Methods inherited from interface com.filenet.rm.api.HoldableObject
getAllChildsOnHold, getAssociatedHolds, getParentsOnHold, hold, isAnyChildonHold, isAnyParentOnHold, isOnHold, unHold
Methods inherited from interface com.filenet.rm.api.ClosableObject
close, getClosedParents, isAnyParentClosed, isClosed, isReOpened, reOpen
Methods inherited from interface com.filenet.rm.api.ActivableObject
getInActiveParents, inActivate, isAnyParentInActive, isInActive
Methods inherited from interface com.filenet.rm.api.RMFolder
getAllAllowedContaineeType, getAllAllowedContaineeType, getAllowedContainee, getAllowedContaineeType, getContainees, getContaineesXML, getDeletedObjects, getDeletedObjectsIds, getFolderType, getLevel, getPattern, isMinimumMetadataRetained
Methods inherited from interface com.filenet.rm.api.RMObject
getObjectStore, getRMDeclassificationOffset, getRMEntityType, getRMImplementationType, registerExternalEvent, setState
Methods inherited from interface com.filenet.wcm.api.Folder
addSubFolder, addSubFolder, applySecurityTemplate, changeClass, delete, getContainees, getContainees, getContainees, getContainees, getContainees, getContainees, getContaineesXML, getContaineesXML, getHeadLinks, getHeadLinksXML, getParentFolder, getParentFolderXML, getPermissionsXML, getSubscriptions, getTailLinks, getTailLinksXML, getUserAccess, getUserAccess, getUserAccess, move, raiseEvent
Methods inherited from interface com.filenet.wcm.api.WorkflowTarget
getWorkflowSubscriptions, getWorkflowSubscriptionsXML, getWorkflowSubscriptionsXML
Methods inherited from interface com.filenet.wcm.api.WriteableSecurityObject
setPermissions, setPermissions
Methods inherited from interface com.filenet.wcm.api.WriteableMetadataObject
setProperties
Methods inherited from interface com.filenet.wcm.api.ReadableSecurityObject
getAccessMask, getPermissions, getPermissions
Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject
getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
Methods inherited from interface com.filenet.wcm.api.BaseObject
equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject
Methods inherited from interface com.filenet.wcm.api.LockableObject
extendLock, extendLock, isLocked, lock, unlock, unlock
Methods inherited from interface com.filenet.rm.api.VitalableObject
executeVital, isVital, setVital, updateVitalStatus
Methods inherited from interface com.filenet.rm.api.DispositionAllocatableObject
allocateDisposalSchedule, applyDisposalScheduleInheritance, getAssociatedDisposalSchedule, registerExternalEvent
Methods inherited from interface com.filenet.rm.api.DisposableObject
clearDispositionData, clearVitalData, completePhaseExecution, completePhaseExecution, destroy, destroy, destroyWithoutSchedule, executeInterimTransfer, executeInterimTransferWithTransferAPI, executeInterimTransferWithTransferAPI, export, exportWithTransferAPI, exportWithTransferAPI, initiateDisposition, initiateDisposition, recalculateCuttOff, review, setIsExportedBeforeDestroy, transfer, updatePhaseDataOnEntity, updatePhaseDataOnEntity

Method Detail

move

  1. void move(RMFolder aoDestinationFolder,
  2. java.lang.String asReasonForRelocation,
  3. DispositionSchedule aoDispositionSchedule)
  4. 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.