com.filenet.rm.api

Interface RMFolder

All Superinterfaces:
com.filenet.wcm.api.BaseObject, com.filenet.wcm.api.Folder, com.filenet.wcm.api.GettableObject, com.filenet.wcm.api.LockableObject, com.filenet.wcm.api.ReadableMetadataObject, com.filenet.wcm.api.ReadableSecurityObject, RMObject, java.io.Serializable, com.filenet.wcm.api.ValueObject, com.filenet.wcm.api.WorkflowTarget, com.filenet.wcm.api.WriteableMetadataObject, com.filenet.wcm.api.WriteableSecurityObject
All known subinterfaces:
ActivableObject, ClassificationScheme, ClosableObject, RecordCategory, RecordFolder, RMRecordCategoryContainer, RMRecordContainer, RMRecordFolderContainer, Volume

  1. public interface RMFolder
  2. extends RMObject, com.filenet.wcm.api.Folder
Represents the base interface for all container objects in the Records Manager Java API. Container objects represent the different types of folders that exist in the file plan hierarchy. The types of container objects are ClassificationScheme, RecordCategory, RecordFolder, and Volume.

The RMFolder interface extends the RMObject interface and the Content Java API Folder interface.


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. int[]
getAllAllowedContaineeType()
Returns a list of the Record Manager entity types that can be contained in this RMFolder object regardless of its current state.
  1. int[]
getAllAllowedContaineeType(com.filenet.wcm.api.Property aoProperty)
Returns a list of the Record Manager entity types that can be contained in this RMFolder object regardless of its current state.
  1. com.filenet.wcm.api.Values
getAllowedContainee()
Returns the Record Manager entity types that can be contained in this RMFolder object regardless of its current state.
  1. int[]
getAllowedContaineeType()
Returns a list of the Record Manager entity types that can be contained in this RMFolder object in its current state.
  1. com.filenet.wcm.api.BaseObjects
getContainees(int[] aiRMTypes,java.lang.String[] asArrProps,boolean abIncludedHidden,int aiMaxResultForFolder,int aiMaxResultForRecord)
Returns a collection of the RMObjectobjects of the specified types that are contained in this RMFolder object.
  1. java.lang.String
getContaineesXML(int[] aiRMTypes,java.lang.String[] asArrProps,boolean abIncludedHidden,int aiMaxResultForFolder,int aiMaxResultForRecord)
Returns the RMObjectobjects of the specified types that are contained in this RMFolder object.
  1. com.filenet.wcm.api.BaseObjects
getDeletedObjects()
Returns the RM entities contained in the hierarchy below this RMFolder object that have been logically deleted.
  1. java.lang.String[]
getDeletedObjectsIds()
Returns the GUIDs of the RM entities contained in the hierarchy below this RMFolder object that have been logically deleted.
  1. int
getFolderType()
Returns the RMEntityType property value that indicates what type of entity this RMFolder object.
  1. int
getLevel()
Returns the level at which this RMFolder object exists within its file plan.
  1. com.filenet.wcm.api.CustomObject
getPattern()
Returns the pattern associates with this RMFolder object.
  1. int
isMinimumMetadataRetained()
Returns the RetainMetadata property value for the ClassificationSchemeobject to which this RMFolder object belongs.
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, 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

Method Detail

isMinimumMetadataRetained

  1. int isMinimumMetadataRetained()
  2. throws RMException
Returns the RetainMetadata property value for the ClassificationScheme object to which this RMFolder object belongs. The RetainMetadata property indicates whether minimum metadata is to be retained when this object is deleted.
Returns:
An int value indicating the RetainMetadata property value as follows:

0 The entity is logically deleted. That is, minimum metadata is retained on deletion and the IsDeleted property of the relevant RM entity is set to true.
1 The entity is completely deleted without saving any minimum metadata.
2 The user is to be prompted when deleting an entity to specify whether minimum metadata should be retained.

Throws:
RMException - If a Records Manager error occurs.

getAllowedContaineeType

  1. int[] getAllowedContaineeType()
  2. throws RMException
Returns a list of the Record Manager entity types that can be contained in this RMFolder object in its current state.
Returns:
An int array containing the RMType values that identify Record Manager entity types that can be contained in this object.
Throws:
RMException - If a Records Manager error occurs.

getAllAllowedContaineeType

  1. int[] getAllAllowedContaineeType( )
  2. throws RMException
Returns a list of the Record Manager entity types that can be contained in this RMFolder object regardless of its current state.
Returns:
An int array containing the RMType values that identify Record Manager entity types that can be contained in this object.
Throws:
RMException - If a Records Manager error occurs.

getAllAllowedContaineeType

  1. int[] getAllAllowedContaineeType( com.filenet.wcm.api.Property aoProperty)
  2. throws RMException
Returns a list of the Record Manager entity types that can be contained in this RMFolder object regardless of its current state.
Parameters:
aoProperty - A Property object that corresponds to the AllowedRMTypes property.
Returns:
An int array containing the RMType values that identify Record Manager entity types that can be contained in this object.
Throws:
RMException - If a Records Manager error occurs.

getFolderType

  1. int getFolderType()
  2. throws RMException
Returns the RMEntityType property value that indicates what type of entity this RMFolder object.
Returns:
An int value representing the RMEntityType property value for this object.
Throws:
RMException - If the RMEntityType property is not found or if a Records Manager error occurs.

getLevel

  1. int getLevel()
  2. throws RMException
Returns the level at which this RMFolder object exists within its file plan.
Returns:
An int value that represents the level of this object within the file plan.
Throws:
RMException - If a Records Manager error occurs.

getPattern

  1. com.filenet.wcm.api.CustomObject getPattern( )
  2. throws RMException
Returns the pattern associates with this RMFolder object. If this object is not a ClassificationScheme, the method navigates up the file plan to obtain the pattern associated with the ClassificationScheme object in which this RMFolder object resides.
Returns:
A CustomObject object that represents the pattern associated this object.
Throws:
RMException - If a Records Manager error occurs.

getDeletedObjects

  1. com.filenet.wcm.api.BaseObjects getDeletedObjects( )
  2. throws RMException
Returns the RM entities contained in the hierarchy below this RMFolder object that have been logically deleted.
Returns:
A BaseObjects collection that contains the RM entities in this object that have been logically deleted.
Throws:
RMException - If the IsDeleted property for any RM entity cannot be retrieved or if a Records Manager error occurs.

getDeletedObjectsIds

  1. java.lang.String[] getDeletedObjectsIds( )
Returns the GUIDs of the RM entities contained in the hierarchy below this RMFolder object that have been logically deleted.
Returns:
A String array that contains the GUIDs of the RM entities in this object that have been logically deleted.

getAllowedContainee

  1. com.filenet.wcm.api.Values getAllowedContainee( )
  2. throws RMException
Returns the Record Manager entity types that can be contained in this RMFolder object regardless of its current state.
Returns:
A Values collection that contains the RMType values that can be contained within this object.
Throws:
RMException - If a Records Manager error occurs.

getContaineesXML

  1. java.lang.String getContaineesXML( int[] aiRMTypes,
  2. java.lang.String[] asArrProps,
  3. boolean abIncludedHidden,
  4. int aiMaxResultForFolder,
  5. int aiMaxResultForRecord)
Returns the RMObject objects of the specified types that are contained in this RMFolder object. The method returns the objects in an XML String that includes any property values requested.
Parameters:
aiRMTypes - An int array that specifies the types of objects to be returned. Use the constants defined in either the BaseObject or RMType interface in this array. The types must represent objects that can be contained within this RMFolder object.
asArrProps - A String array that contains the symbolic names of any properties whose values are to be returned.
abIncludedHidden - A boolean value that specifies whether this method is to return objects from hidden subfolders. Set to true to return objects from visible and hidden subfolders. Set to false to return object only from visible subfolders.
aiMaxResultForFolder - An int value that indicates the maximum number of RMFolders objects to be returned. This parameter is value is ignored if the method is called on an RMContainer object that does not allow RMFolders objects.
aiMaxResultForRecord - An int value that indicates the maximum number of records to be returned. This parameter is value is ignored if the method is called on an RMContainer object that does not allow records.
Returns:
A String in XML format that contains the objects of the specified types within this object. For more information about the XML schema used to generate this string, see "Schema Reference" in the FileNet P8 Documentation.

getContainees

  1. com.filenet.wcm.api.BaseObjects getContainees( int[] aiRMTypes,
  2. java.lang.String[] asArrProps,
  3. boolean abIncludedHidden,
  4. int aiMaxResultForFolder,
  5. int aiMaxResultForRecord)
Returns a collection of the RMObject objects of the specified types that are contained in this RMFolder object. The method also returns any property values that are requested.
Parameters:
aiRMTypes - An int array that specifies the types of objects to be returned. Use the constants defined in either the BaseObject or RMType interface in this array. The types must represent objects that can be contained within this RMFolder object.
asArrProps - A String array that contains the symbolic names of any properties whose values are to be returned.
abIncludedHidden - A boolean value that specifies whether this method is to return objects from hidden subfolders. Set to true to return objects from visible and hidden subfolders. Set to false to return object only from visible subfolders.
aiMaxResultForFolder - An int value that indicates the maximum number of RMFolders objects to be returned. This parameter is value is ignored if the method is called on an RMContainer object that does not allow RMFolders objects.
aiMaxResultForRecord - An int value that indicates the maximum number of records to be returned. This parameter is value is ignored if the method is called on an RMContainer object that does not allow records.
Returns:
A BaseObjects collection that contains the objects of the specified types within this object. If no objects of the specified types are contained within this object, the method returns an empty collection.