com.filenet.rm.api.exception

Uses of Class RMException

Packages that use RMException

Package Description
com.filenet.rm.api
com.filenet.rm.api.exception
com.filenet.rm.api.util

Uses of RMException in com.filenet.rm.api

Modifier and Type Method and Description
  1. GuideSection
GuideContainer.addGuideSection(java.lang.String asGuideSectionName,java.lang.String asClassID,com.filenet.wcm.api.Properties aoSectionProps,com.filenet.wcm.api.Permissions aoSectionACLs)
Adds a new GuideSection object to the hierarchy at the current level.
  1. GuideTopic
GuideContainer.addGuideTopic(java.lang.String asGuideTopicName,java.lang.String asClassID,com.filenet.wcm.api.Properties aoTopicProps,com.filenet.wcm.api.Permissions aoSectionACLs)
Adds a new GuideTopic object to the hierarchy at the current level.
  1. RecordCategory
RMRecordCategoryContainer.addRecordCategory(java.lang.String asRecordCategoryName,com.filenet.wcm.api.Properties aoRecordCategoryProps,com.filenet.wcm.api.Permissions aoRecordCategoryACLs)
Adds a RecordCategory object to this container object and validates the properties and permissions provided in the input parameters.
  1. RecordFolder
RMRecordFolderContainer.addRecordFolder(java.lang.String asRecordFolderName,com.filenet.wcm.api.Properties aoRecordFolderProps,com.filenet.wcm.api.Permissions aoRecordFolderACLs)
Creates a new RecordFolder object with the specified properties and permissions in this container object.
  1. RecordFolder
RMRecordFolderContainer.addRecordFolder(java.lang.String asRecordFolderName,java.lang.String asFolderClass,com.filenet.wcm.api.Properties aoRecordFolderProps,com.filenet.wcm.api.Permissions aoRecordFolderACLs)
Creates a new RecordFolder object with the specified properties and permissions in this container object.
  1. Volume
RecordFolder.addVolume(com.filenet.wcm.api.Properties volumeProps,com.filenet.wcm.api.Permissions volumeACLs)
Creates a Volumeobject within this RecordFolder object using the specified property and permission values.
  1. Volume
RecordFolder.addVolumeWithName(com.filenet.wcm.api.Properties aVolumeProps,com.filenet.wcm.api.Permissions aVolumeACLs)
Adds the Volume object within this instance of a RecordFolder object.
  1. void
DispositionAllocatableObject.allocateDisposalSchedule(DispositionSchedule aoDispositionSchedule)
Associates the specified DispositionSchedule object with this object.
  1. void
RecordInfo.allocateRecordType(RecordType aoRecordType)
Sets the AssociatedRecordType property for this RecordInfo object to the specified RecordType object.
  1. void
DispositionAllocatableObject.applyDisposalScheduleInheritance(DispositionSchedule aoDispSchedule,int aiApplyInheritTo)
Associates a specified disposition schedule with the children of this object as indicated by the aiApplyInheritTo parameter.
  1. void
RecordInfo.attachReceiptToParent(RecordInfo aoRecordInfo)
Attaches this RecordInfo object to the specified parent record as a receipt.
  1. boolean
RMConnector.canDeclare(java.lang.String asURL,java.lang.String[] asArrVersion)
Validates the eligibility of a document for the declaration operation.
  1. boolean
RMRecordContainer.canDeclare(java.lang.String asURL,java.lang.String[] asArrVersion)
Verifies whether the specified documents or versions of a document can be declared as records in this container object.
  1. void
DisposableObject.clearDispositionData()
Clears the disposition data from this object.
  1. void
RMRecordContainer.clearDispositionSchedule(int aiClearSchedule)
Clears the disposition schedule and disposition data from this container object and, optionally, from its children.
  1. void
DisposableObject.clearVitalData()
Clears the vital data from this object.
  1. void
ClosableObject.close(java.lang.String asReasonForClose)
Closes this object.
  1. void
DisposableObject.completePhaseExecution(java.util.Date aoProposedCutoffDate,boolean abTriggerNextPhase)
Completes the currently executing phase for this object by updating the current phase execution date metadata and cutoff metadata.
  1. void
DisposableObject.completePhaseExecution(java.util.Date aoProposedCutoffDate,boolean abTriggerNextPhase,boolean abHasCutOfAction)
Completes the currently executing phase for this object by updating the current phase execution date and cutoff properties.
  1. ClassificationGuide
RMObjectStore.createClassificationGuide(java.lang.String asGuideName,java.lang.String asClassID,com.filenet.wcm.api.Properties aoGuideProps,com.filenet.wcm.api.Permissions aoGuideACLs)
Creates a new ClassificationGuide object in the /Records Management/ClassificationGuides folder within this object store.
  1. ClassificationScheme
RMObjectStore.createClassificationScheme(java.lang.String asClassificationSchemeName,com.filenet.wcm.api.Properties aoClassificationSchemeProps,com.filenet.wcm.api.Permissions aoClassificationSchemeACLs)
Constructs a ClassificationScheme object with the specified property and permission values, and places the new object in this object store.
  1. DispositionSchedule
RMObjectStore.createDispositionSchedule(com.filenet.wcm.api.Properties aoDispositionScheduleProps,com.filenet.wcm.api.Permissions aoDispositionScheduleACLs)
Constructs a DispositionSchedule object with the specified property and permission values, and places the new object in this object store.
  1. RMCustomObject
RMObjectStore.createLocation(com.filenet.wcm.api.Properties aoProperties,com.filenet.wcm.api.Permissions aoAcls,java.lang.String Guid)
Creates a Location object in the specified folder.
  1. RMCustomObject
RMObjectStore.createPattern(com.filenet.wcm.api.Properties aoProperties,com.filenet.wcm.api.Permissions aoPermissions)
Creates a Pattern object that specifies a naming pattern for file plans in the object store.
  1. RMCustomObject
RMObjectStore.createPatternLevel(com.filenet.wcm.api.Properties aoProperties,com.filenet.wcm.api.Permissions aoPermissions,java.lang.String asPatternGUID)
Creates a PatternLevel object to be associated with the specified Pattern object in this object store.
  1. RMCustomObject
DispositionSchedule.createPhase(com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoACL)
Deprecated. Use the createPhaseWithAlternateRetention method instead.
  1. RMCustomObject
DispositionSchedule.createPhaseWithAlternateRetention(com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoACLS,com.filenet.wcm.api.Properties[] aoArrAltcreatePhaseWithAlternateRetentionernateRetentionProps)
Creates a Phase object using the specified properties and permissions, and adds the new object as the last entry in the Phase collection associated with this DipositionSchedule object.
  1. RecordType
RMObjectStore.createRecordType(com.filenet.wcm.api.Properties aoRecordTypeProps,com.filenet.wcm.api.Permissions aoRecordTypeACLs)
Constructs a RecordType object with the specified property and permission values, and places the new object in this object store.
  1. RMCustomObject
RMObjectStore.createRMCustomObject(int aiCustomClassType,com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoACL)
Constructs an RMCustomObject object of the specified type and places the new object in this object store.
  1. void
Volume.createVolume(RecordFolder aoParent,java.lang.String volumeName,java.lang.String folderUniqueIdentifier,java.lang.String asVolClassID,com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoACLs)
Creates a Volume object with specified properties and permissions in a RecordFolder object.
  1. RecordInfo
RMRecordContainer.declare(DocumentStore aoDocumentStore,java.lang.String[] asDocumentsID,RMFolder[] aoFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname)
Declares the specified documents as a single record and files the new record in the specified folders.
  1. RecordInfo
RMRecordContainer.declare(DocumentStore aoDocumentStore,java.lang.String[] asDocumentsID,RMFolder[] aoFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname,boolean abValidate)
Declares the specified documents as a single record and files the new record in the specified folders.
  1. RecordInfo
RMRecordContainer.declare(java.lang.String asURL,java.lang.String[] asVersion,RMFolder[] aoFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname)
Declares the versions of the specified document as a single record and files the new record in the specified folders.
  1. RecordInfo
RMRecordContainer.declare(java.lang.String asURL,java.lang.String[] asVersion,RMFolder[] aoFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname,boolean abValidate)
Declares the versions of the specified document as a single record and files the new record in the specified folders.
  1. RecordInfos
RMRecordContainer.declareAllVersions(DocumentStore aoDocumentStore,java.lang.String asArrDocumentsID,boolean abAllVersion,RMFolder[] aoArrFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname,java.util.Map aoError)
Declares all versions of the specified documents as either a single record or as separate records, and files the record or records in the specified folders.
  1. RecordInfos
RMRecordContainer.declareAllVersions(DocumentStore aoDocumentStore,java.lang.String asArrDocumentsID,boolean abAllVersion,RMFolder[] aoArrFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname,java.util.Map aoError,boolean abValidate)
Declares all versions of the specified documents as either a single record or as separate records, and files the record or records in the specified folders.
  1. RecordInfos
RMRecordContainer.declareAllVersions(java.lang.String asURL,boolean abAllVersion,RMFolder[] aoFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname,java.util.Map aoErrorMap)
Declares all versions of the documents specified by the asURL parameter as either a single record or as separate records, and files the record or records in the specified folders.
  1. RecordInfos
RMRecordContainer.declareAllVersions(java.lang.String asURL,boolean abAllVersion,RMFolder[] aoFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname,java.util.Map aoErrorMap,boolean abValidate)
Declares all versions of the documents specified by the asURL parameter as either a single record or as separate records, and files the record or records in the specified folders.
  1. RecordInfo
RMRecordContainer.declareAndClassify(DocumentStore aoDocumentStore,java.lang.String[] asArrDocumentsID,RMFolder[] aoArrFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname,boolean abValidate)
Declares the specified document as a record with the security classification specified in the aoRecordProps parameter.
  1. RecordInfo
RMRecordContainer.declareAndClassify(java.lang.String asURL,java.lang.String[] asArrVersion,RMFolder[] aoArrFolder,com.filenet.wcm.api.Properties aoRecordProps,java.lang.String asRecordInfoClassID,com.filenet.wcm.api.Permissions aoRecordACLs,boolean abAutoname,boolean abValidate)
Declares the specified document as a record with the security classification specified in the aoRecordProps parameter.
  1. void
RMConnector.declareDocument(java.lang.String asURLDocument,RecordInfo aoRecordInfo,java.lang.String[] asArrVersion,com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoACLs)
Sets the required properties to the document, which are related to the declaration and finally updates the permission of the document to that of the record as supplied.
  1. void
RMConnector.declareDocument(java.lang.String asURLDocument,java.lang.String asURLRecord,java.lang.String[] asArrVersion,com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoACLs)
Sets the required properties to the document, which are related to the declaration and finally updates the permission of the document to that of the record as supplied.
  1. void
RMConnector.declareDocument(java.lang.String asURLDocument,java.lang.String asURLRecord,java.lang.String[] asArrVersion,com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoACLs,DocumentStore aoDocStore)
Sets the isRecord and RecordLink properties to the document, which are related to the declaration and finally updates the permission of the document to that of the record as supplied.
  1. void
RecordInfo.declassify(com.filenet.wcm.api.Properties aoRecordProps)
Sets the security classification to declassify this RecordInfo object according to the DoD 5015.2-STD Chapter 4 standards.
  1. void
GuideContainer.delete()
Deletes a GuideSection or GuideTopicobject from this GuideContainer object.
  1. void
RecordInfo.delete(boolean abSave,java.lang.String asReasonForDelete)
Deletes this RecordInfo object.
  1. void
RMRecordContainer.delete(boolean abSave,java.lang.String asReasonForDelete)
Deletes this container object provided there is no constraint, such as the object being on hold, that prevents the object from being deleted.
  1. void
DispositionSchedule.deleteAlternateRetention(java.lang.String asAlternateRetentionGuid)
Deletes a specified AlternateRetention object.
  1. void
RecordInfo.deleteFromParent(boolean abSave,java.lang.String asReasonForDelete,RMRecordContainer aoParent)
Called by the specified RMRecordContainerobject to delete this RecordInfo object in response to the destroy operation being invoked on that RMRecordContainer object.
  1. void
DispositionSchedule.deletePhase(java.lang.String asPhaseGuid)
Deletes the specified Phase object and updates the sequence of all associated Phase objects to reflect the change.
  1. void
DisposableObject.destroy(boolean abSave)
Deletes this object either logically or physically from the object store.
  1. void
DisposableObject.destroy(boolean abSave,boolean abUnfileRecordWithRType)
Deletes this object either logically or physically from the object store.
  1. void
RecordInfo.destroyFromParent(boolean abSave,RMRecordContainer aoParent)
Called by the specified RMRecordContainerobject to delete this RecordInfo object in response to the destroy operation being invoked in a workflow on that RMRecordContainer object.
  1. void
DisposableObject.destroyWithoutSchedule(boolean abSave)
Deletes this object either logically or physically from the object store without disposition schedule.
  1. RecordInfo
RecordInfo.detachReceiptFromParent()
Detaches this RecordInfo object from a parent record as a receipt for that parent.
  1. void
RecordInfo.downgrade(com.filenet.wcm.api.Properties aoRecordProps)
Sets the security classification for this RecordInfo object to a less restrictive level according to the DoD 5015.2-STD Chapter 4 standards.
  1. void
Volume.editVolumeProperties(com.filenet.wcm.api.Properties aoProperties,java.lang.String volumeName,java.lang.String folderUniqueIdentifier,RecordFolder aoParent)
Edits the properties of the new instance of a volume that is to be created.
  1. void
VitalableObject.executeVital()
Calculates the vital review date and sets the Vital Record Review Date property for this object to that date.
  1. java.lang.String
RMConnector.exportDocument(java.lang.String asArrURI,java.lang.String asParentXML)
Exports the documents identified by the URL in XML string format.
  1. Volume
RecordFolder.getActiveVolume()
Returns the Volumeobject that is currently active in this RecordFolder object.
  1. int[]
RMFolder.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[]
RMFolder.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
RMFolder.getAllowedContainee()
Returns the Record Manager entity types that can be contained in this RMFolder object regardless of its current state.
  1. int[]
RMFolder.getAllowedContaineeType()
Returns a list of the Record Manager entity types that can be contained in this RMFolder object in its current state.
  1. java.lang.String[]
RMConnector.getAllVersions(java.lang.String asURL)
Retrieves all version numbers of the document specified by the URL.
  1. DispositionSchedule
DispositionAllocatableObject.getAssociatedDisposalSchedule()
Returns the DispositionSchedule object that is associated with this object.
  1. java.lang.String[]
RecordInfo.getAssociatedDocumentIds()
Returns the IDs of all Document objects associated with this RecordInfo object.
  1. Holds
HoldableObject.getAssociatedHolds()
Returns the Holdobjects that are associated with this HoldableObject object.
  1. RecordInfos
RecordType.getAssociatedRecords()
Returns all records associated with this RecordType object.
  1. RecordType
RecordInfo.getAssociatedRecordType()
Returns the RecordTypeobject with which this RecordInfo object is assoicated.
  1. HoldableObjects
Hold.getAssociatedRMobjects()
Returns the Record Manager objects that are associated with this Hold object.
  1. org.w3c.dom.Document
Hold.getAssociatedRMobjects(java.lang.String[] aoFolderProps,java.lang.String[] aoRecordInfoProps,int aiMaxRecords,java.lang.String asFilterString)
Returns a Document object containing the Record Manager objects that are associated with this Hold object.
  1. RMAutoName
RMDriverManager.getAutoName()
Returns the auto-namining implementation that is registered for this object.
  1. com.filenet.wcm.api.ClassDescriptions
RMObjectStore.getClassDescriptions(int[] aiEntityTypes,boolean abInculdeSubClasses,boolean abGetAll)
Returns a collection of the ClassDescription objects, which contain the metadata for the classes of the specified types in this object store.
  1. ClassificationGuide
GuideSection.getClassificationGuide()
Returns the top-level classification guide for this GuideSection object.
  1. ClassificationGuide
GuideTopic.getClassificationGuide()
Retrieves the top-level classification guide for this GuideTopic object.
  1. ClassificationGuides
RMObjectStore.getClassificationGuides()
Returns the ClassificationGuide objects that are contained in this object store.
  1. ClassificationGuides
RMObjectStore.getClassificationGuides(java.lang.String[] asPropNames)
Returns the ClassificationGuide objects, along with their properties, that are contained in this object store.
  1. java.lang.String
RMObjectStore.getClassificationGuidesXML(java.lang.String[] asPropNames)
Returns a String in XML format that represents the collection of ClassificationGuide objects in this object store along with their properties.
  1. ClassificationScheme
RMObjectStore.getClassificationSchemeInterface(com.filenet.wcm.api.Folder aoFolder)
Constructs a ClassificationScheme object based on the specified Folder object and places the new object in this object store.
  1. java.lang.String
RMObjectStore.getClassificationSchemeRootPath()
Returns the path of ClassificationSchemeRoot object for this object store.
  1. ClassificationSchemes
RMObjectStore.getClassificationSchemes()
Returns a collection containing the ClassificationScheme objects in this object store.
  1. java.lang.String
RMObjectStore.getClassificationSchemesXML(java.lang.String[] asPropNames)
Returns a String that contains the XML representation of the ClassificationScheme objects in this object store along with their specified properties.
  1. RMConnector
RMDriverManager.getConnector(RMObjectStore aoRMObjectStore,java.lang.String asRegistration_id)
Returns the connector implementation that is to be invoked for a specified ConnectorRegistration object.
  1. RMConnector
RMDriverManager.getConnector(RMObjectStore aoRMObjectStore,java.lang.String asRegistration_id,com.filenet.wcm.api.Session aoSession)
Returns the connector implementation that is to be invoked for a specified ConnectorRegistration object.
  1. com.filenet.wcm.api.TransportInputStream
RecordInfo.getContent()
Obtains an input stream for the content element of the first Document object associated with this RecordInfo object.
  1. com.filenet.wcm.api.TransportInputStream
RecordInfo.getContent(java.lang.String asDocumentId)
Obtains an input stream for the content element of the specified Document object that is associated with this RecordInfo object.
  1. java.lang.String
RMConnector.getCurrentVersion(java.lang.String asURL)
Retrieves the current or latest version of the document that is specified by the URL.
  1. java.util.List
RMConnector.getDeclareDocuments(java.lang.String asURL,java.lang.String[] asArrVersion)
Retrieves the documents that correspond to the documentID provided in the URL and the version supplied.
  1. com.filenet.wcm.api.BaseObjects
RMFolder.getDeletedObjects()
Returns the RM entities contained in the hierarchy below this RMFolder object that have been logically deleted.
  1. com.filenet.wcm.api.TransportInputStream
RMConnector.getDocumentContent(java.lang.String asURL)
Constructs a TransportInputStream that represents the content of this Document.
  1. java.lang.String
RMConnector.getDocumentID(java.lang.String asURL,java.lang.String asVersion)
Retrieves the DocumentID of the specific version of the given document.
  1. com.filenet.wcm.api.Properties
RecordInfo.getDocumentProperties(java.lang.String asDocId,java.lang.String[] asArrProps)
Returns the properties of a specified document that is associated with this RecordInfo object
  1. com.filenet.wcm.api.Properties
RMConnector.getDocumentProperties(java.lang.String asURL,java.lang.String[] asArrProps)
Returns property values for the specified document.
  1. java.lang.String
DocumentStore.getDomain()
Returns the name of the domain name for this DocumentStore object.
  1. int
RMFolder.getFolderType()
Returns the RMEntityType property value that indicates what type of entity this RMFolder object.
  1. GuideSections
GuideContainer.getGuideSections()
Returns the GuideSection objects at the current level of the hierarchy.
  1. GuideSections
GuideContainer.getGuideSections(java.lang.String[] asPropNames)
Returns the GuideSection objects at the current level of the hierarchy along with the values of the specified properties.
  1. java.lang.String
GuideContainer.getGuideSectionsXML(java.lang.String[] asPropNames)
Returns an XML string containing the GuideSection objects at the current level of the hierarchy along with the values of the specified properties.
  1. GuideTopics
GuideContainer.getGuideTopics()
Returns the GuideTopic objects at the current level of the hierarchy.
  1. GuideTopics
GuideContainer.getGuideTopics(java.lang.String[] asPropNames)
Returns the GuideTopic objects at the current level of the hierarchy along with the values of the specified properties.
  1. java.lang.String
GuideContainer.getGuideTopicsXML(java.lang.String[] asPropNames)
Returns an XML string containing the GuideTopic objects at the current level of the hierarchy along with the values of the specified properties.
  1. int
Hold.getHoldState()
Returns an int value indicating the hold state for this Hold object.
  1. RMFolders
ActivableObject.getInActiveParents(boolean abFirstParentOnly)
Returns a collection of containing either the first inactive parent of this container object or all inactive parents.
  1. Volume
RecordFolder.getLastCreatedVolume()
Returns the Volumeobject that was most recently created within this RecordFolder object.
  1. int
RMFolder.getLevel()
Returns the level at which this RMFolder object exists within its file plan.
  1. java.lang.String
DocumentStore.getLibraryName()
Returns the name of the document library as represented by this DocumentStore object.
  1. RMObject
RMObjectStore.getObject(java.lang.String asRMObjectId)
Returns the specified RMObject object.
  1. com.filenet.wcm.api.ObjectStore
DocumentStore.getObjectStore()
Returns this DocumentStore object.
  1. RMObjectStore
RMObject.getObjectStore()
Returns a reference to the object store to which this object is persisted.
  1. RecordCategories
RecordInfo.getParentRecordCategories()
Returns a collection containing the record categories in which this RecordInfo object is filed.
  1. RecordFolder
Volume.getParentRecordFolder()
Returns a reference to the parent RecordFolder object for this object.
  1. RecordFolders
RecordInfo.getParentRecordFolders()
Returns a collection containing the RecordFolderobjects in which this RecordInfo object is filed.
  1. com.filenet.wcm.api.CustomObject
RMFolder.getPattern()
Returns the pattern associates with this RMFolder object.
  1. RMCustomObject
ClassificationScheme.getPatternValue()
Returns the Pattern object that is associated with this ClassificationScheme object.
  1. RMCustomObjects
DispositionSchedule.getPhases()
Returns all Phase objects that are associated with this DispositionSchedule object.
  1. java.lang.String[]
RMObjectStore.getPropertyNames(int aiEntityType)
Returns an array containing the symbolic names of all properties for objects of the specified entity type.
  1. RecordInfo
RecordInfo.getReceiptParent()
Returns the parent record to which this RecordInfo object is attached as a receipt.
  1. RecordInfos
RecordInfo.getReceipts()
Returns a collection of RecordInfo objects that are attached to this object as receipts.
  1. RecordInfo
RMObjectStore.getRecord(java.lang.String asDocURI)
Returns the RecordInfo object in this object store that has the the specified document URI.
  1. RecordCategory
RMObjectStore.getRecordCategoryInterface(com.filenet.wcm.api.Folder aoFolder)
Constructs a RecordCategory object based on the specified Folder object and places the new object in this object store.
  1. RecordFolder
RMObjectStore.getRecordFolderInterface(com.filenet.wcm.api.Folder aoFolder)
Constructs a RecordFolder object object based on the specified Folder object and places the new object in this object store.
  1. RecordInfo
RMObjectStore.getRecordInfoInterface(com.filenet.wcm.api.Document aoDocument)
Constructs a RecordInfo object based on the specified Document object and places the new object in this object store.
  1. RecordType
RMObjectStore.getRecordTypeInterface(com.filenet.wcm.api.CustomObject aoRecordType)
Constructs a RecordType object based on the specified Folder object and places the new object in this object store.
  1. RecordTypes
RMObjectStore.getRecordTypes()
Returns a collection containing the RecordType objects in this object store.
  1. java.lang.String
DocumentStore.getRepositoryName()
Generates a repository name for this DocumentStore object by combining the domain and library names this object.
  1. java.lang.String
DocumentStore.getRepositoryType()
Returns a value indicating the repository type of this DocumentStore object.
  1. java.lang.String
RecordInfo.getRepositoryType()
Returns a String that indicates the type of repository in which the document corresponding to this RecordInfo object is stored.
  1. java.lang.String
RMConnector.getRepositoryType(java.lang.String asURI)
Returns the Repository type where this instance of Connector points.
  1. RMCustomObject
RMObjectStore.getRMCustomObjectInterface(com.filenet.wcm.api.CustomObject aoCustomObject)
Constructs an RMCustomObject object based on the specified CustomObject object and places the new object in this object store.
  1. RMCustomObjects
RMObjectStore.getRMCustomObjects(int aiRMtype)
Returns a collection of all RMCustomObject objects of the specified type that are contained within this object store for which the user has permission to update the schedule.
  1. RMCustomObjects
RMObjectStore.getRMCustomObjects(int aiRMtype,java.lang.String asWhereClause)
Returns a collection of all RMCustomObject objects of the specified type that are contained within this object store.
  1. int
RMObject.getRMEntityType()
Returns the value of the RMEntityType property for this object.
  1. int
RMObjectStore.getRMEntityType()
Returns the type of this object store.
  1. int
RMObjectStore.getRMEntityType(java.lang.String asGuid)
Returns the type of the specified Records Manager entity.
  1. int
RMObjectStore.getRMFolderType(com.filenet.wcm.api.Folder aoFolder)
Returns the entity type of the specified container object.
  1. int
RMObjectStore.getRMFolderType(java.lang.String asGUID)
Returns the entity type of the container object with the specified GUID.
  1. RMObjects
RMObjectStore.getRMObjects()
Creates an empty RMObjects collection that can contain any type of RMObject object.
  1. RMPagedSearch
RMObjectStore.getRMPagedSearch()
Returns an RMPagedSearch object that can be used to search this object store and to return paged results.
  1. RMSearch
RMObjectStore.getRMSearch()
Returns an RMSearch object that can be used to search this object store.
  1. java.lang.String
RecordInfo.getSecurityParentHierarchicalPropertiesXML(java.lang.String[] asArrProps,int aiRMType)
Returns the properties for either a security parent or the container of a security parent of this RecordInfo object.
  1. java.lang.String
DocumentStore.getServerName()
Returns the URL that is used to connect to the Content Engine server and return.
  1. java.lang.Object
RMObjectStore.getSystemConfigurationValue(java.lang.String asPropertyName)
Returns the value of the specified SystemConfiguration property for the ClassificationSchemes object in this object store.
  1. java.lang.String
DocumentStore.getURI(RMObjectStore aoRMobjectStore,java.lang.String[] asArrDocumentId)
Generates a URI that is passed to RM Declaration API when documents are declared as records.
  1. Volume
RMObjectStore.getVolumeInterface(com.filenet.wcm.api.Folder aoFolder)
Constructs a Volume object based on the specified Folder object and places the new object in this object store.
  1. void
HoldableObject.hold(Hold aoHold)
Associates this HoldableObject object with the specified Hold object.
  1. void
ActivableObject.inActivate(boolean abInactive,java.lang.String asReasonforInActivate)
Inactivates or activates this container object.
  1. java.util.HashMap
DisposableObject.initiateDisposition(filenet.vw.api.VWSession aoVWSession)
Verifies the state of this object and its available children to launch the associated phase workflow with corresponding entities
  1. RMBulkOperationResults
DisposableObject.initiateDisposition(filenet.vw.api.VWSession aoVWSession,boolean abFailOnException)
Verifies the state of this object and its available children to launch the associated phase workflow with corresponding entities
  1. boolean
HoldableObject.isAnyChildonHold()
Indicates whether any child of this HoldableObject object on hold.
  1. boolean
ClosableObject.isAnyParentClosed()
Indicates whether any parent of this object is closed.
  1. boolean
ActivableObject.isAnyParentInActive()
Returns a boolean value indicating whether any parent of this container object is inactive.
  1. boolean
HoldableObject.isAnyParentOnHold()
Indicates whether any parent of this HoldableObject object on hold.
  1. boolean
Hold.isAppliedDynamically()
Indicates whether the disposition hold represented by this Hold object has been placed dynamically.
  1. boolean
ClosableObject.isClosed(boolean abCheckParents)
Indicates whether this object or, optionally, any parent of this object is closed.
  1. boolean
ActivableObject.isInActive(boolean abCheckParents)
Returns a boolean value indicating whether this container object or, optionally, any parent of this object is inactive.
  1. int
RecordInfo.isMinimumMetadataRetained()
Retrieves the RetainMetadata property for the ClassificationSchemeobject to which this RecordInfo object belongs.
  1. int
RMFolder.isMinimumMetadataRetained()
Returns the RetainMetadata property value for the ClassificationSchemeobject to which this RMFolder object belongs.
  1. boolean
HoldableObject.isOnHold(boolean abCheckParents)
Indicates whether this HoldableObject object is on hold.
  1. boolean
ClosableObject.isReOpened()
Indicates whether this object is currently open.
  1. boolean
VitalableObject.isVital()
Indicates whether this object is a VitableObject object.
  1. void
DispositionSchedule.modifyAlternateRetention(java.lang.String asAlternateRetentionGuid,com.filenet.wcm.api.Properties aoProps)
Modifies the Properties collection for a specified AlternateRetention object.
  1. void
RecordCategory.move(RMFolder aoDestinationFolder,java.lang.String asReasonForRelocation,DispositionSchedule aoDispositionSchedule)
Moves this RecordCategory object to a specified classification scheme or a record category.
  1. void
RecordFolder.move(RMFolder aoDestinationFolder,java.lang.String asReasonForRelocation,DispositionSchedule aoDispositionSchedule)
Moves this RecordFolder object to a specified record category or a record folder.
  1. java.lang.String
RMDriverManager.registerConnector(RMObjectStore aoObjectStore,java.lang.String asRepositoryType,java.lang.String asServerName,java.lang.String asRepositoryName,java.lang.String asImplementationclass)
Registers the connector implementation that is to be invoked for the specified combination of repository type, server name and repository name.
  1. void
DispositionAllocatableObject.registerExternalEvent(java.lang.String[] asArrEventIDs,java.util.Date aoExtEventOccuranceDate)
Deprecated. Use RMBulkOperationsUtil.registerExternalEvent(RMObjectStore, String[], Date)
  1. void
RMObject.registerExternalEvent(java.lang.String[] asArrEventIDs,java.util.Date aoExtEventOccurrenceDate)
Deprecated. Use the registerExternalEvent method for the RMBulkOperationsUtil instead.
  1. void
ClosableObject.reOpen(boolean abReopen,java.lang.String asReasonForClose)
Opens this object.
  1. void
DisposableObject.review(com.filenet.wcm.api.Properties asProperties)
Reviews this object and updates the specified properties.
  1. void
DispositionSchedule.runDisposaltrigger(DispositionAllocatableObject aoDisAllObject)
  1. void
DispositionSchedule.runDisposaltrigger(DispositionAllocatableObject aoDisAllObject,RecordInfos aoRecordInfos)
Checks the disposal event for the specified DispositionAllocatableObject object and, if the event has occurred, sets the pre-cutoff date and other disposal-related data for the object or its children.
  1. void
RecordInfo.setLastRetrievalOfRecordOnContainer(RMObjectStore aoRMObjectStore)
Sets the LastRetrievalofRecord property for the container or containers in which this RecordInfo object is filed.
  1. void
ClassificationScheme.setPatternValue(RMCustomObject aoPattern)
Updates the Pattern property for this ClassificationScheme object to the specified value.
  1. void
VitalableObject.setVital(com.filenet.wcm.api.Properties loProperties)
Sets the vital-related properties for this object.
  1. void
RecordInfo.superceed(RecordInfo aoSupersededRecord)
Supersedes this RecordInfo object with the specified RecordInfo object.
  1. void
RMConnector.synchronizeDocument(java.lang.String asURL,com.filenet.wcm.api.Properties asProps)
Synchronizes the document with the properties and the permissions provided by a user.
  1. void
DispositionSchedule.triggerNextPhase(RMObject aoRMObject)
Sets the subsequent phase data on the specified RMObject object according to the schedule object that is associated with the RMObject object or its parent.
  1. void
RecordInfo.undeclare()
Undeclare the record from possible associated documents and delete this record.
  1. void
HoldableObject.unHold(Hold aoHold)
Dissociates this HoldableObject object from the specified Hold object.
  1. void
Hold.unHoldAll()
Releases the disposition hold on all objects associated with this Hold object by dissociating those objects from this Hold object.
  1. void
GuideContainer.update(com.filenet.wcm.api.Properties aoProps)
Updates properties for a guide or a guide section and ensures that the guide name is not duplicated due to the update.
  1. void
GuideTopic.update(com.filenet.wcm.api.Properties aoProps)
Updates the properties for this GuideTopic object and ensures that the topic name is not duplicated as a result of the update.
  1. void
DispositionSchedule.updateCurrentPhaseDataOnEntity(DisposableObject aoDisposableObject)
Recalculates the phase data for the specified DisposableObject object to to cater conditions such as modification of to the phase or the object.
  1. void
DispositionSchedule.updateDateEffectiveModified()
Sets the EffectiveDateModified property of this DipositionSchedule object to the latest modified date on an associated trigger and cutoff action.
  1. void
DispositionSchedule.updatePhase(java.lang.String asPhaseGuid,com.filenet.wcm.api.Properties aoProps,com.filenet.wcm.api.Permissions aoACL)
Updates the specified Phase object using the property and permission values that are passed as parameters.
  1. void
DisposableObject.updatePhaseDataOnEntity()
Recalculates the currently executing phase data based on the schedule for this object or its parent, and updates the metadata for this object.
  1. void
DisposableObject.updatePhaseDataOnEntity(boolean abWithoutValidation)
Updates the current phase execution data for this object without validating the associated schedule.
  1. void
DispositionSchedule.updatePhaseDataOnEntity(DisposableObject aoDisposableObject)
Recalculates the phase data for the specified DisposableObject object to reflect modifications to the phase or the object.
  1. void
DispositionSchedule.updatePhases(java.util.List aoPhasePropCollection,com.filenet.wcm.api.Permissions aoPermissions)
Updates the associated phases with properties collection specified by the aoPhasePropCollection parameter, which provides a collection of collections in sequential order.
  1. void
RecordInfo.updateProperties(com.filenet.wcm.api.Properties aoRecordProps)
Updates the classification data for this RecordInfo object.
  1. void
VitalableObject.updateVitalStatus(java.util.Date aoVitalReviewDate,java.util.Date aoNextVitalReviewDate)
Uses the specified dates to update the Vital Record Next Review Date and Vital Workflow Status properties for this object.
  1. void
RecordInfo.upgrade(com.filenet.wcm.api.Properties aoRecordProps)
Sets the security classification for this RecordInfo object to a more restrictive level according to the DoD 5015.2-STD Chapter 4 standards.

Uses of RMException in com.filenet.rm.api.exception

Modifier and Type Class and Description
  1. class
RMDispositionConflictException
The RMDispositionConflictException class extends the RMException interface.
  1. class
RMUnSupportedOperation
The RMUnSupportedOperation class extends the RMException interface.
Modifier and Type Method and Description
  1. static
  2. RMException
RMException.createRMException(int aiErrorMessageId,int aiMessageType,java.lang.Exception aoException,java.lang.Object[] aoReplaceParams)
Returns for an exception of type ERROR or FATAL an RMException object that contains a localized message derived from the specified Exception object.
  1. static
  2. RMException
RMException.getRMException(int aiErrorMessageId,int aiMessageType,java.lang.Exception aoException,java.lang.Object[] aoReplaceParams)
Returns for an exception of type ERROR, SWEEPERROR, HOLDSWEEPERROR, SWEEPFATAL, HOLDSWEEPFATAL, or FATAL an RMException object that contains a localized message derived from the specified Exception object.

Uses of RMException in com.filenet.rm.api.util

Modifier and Type Method and Description
  1. static
  2. java.lang.String
RMUtil._addNode(java.lang.String asURI,java.util.Map aoMap)
Adds mulitiple nodes to the XML String passed as a parameter.
  1. static
  2. java.lang.String
RMUtil._addNode(java.lang.String asURI,java.lang.String asKeyName,java.lang.String asValue)
Add Nodes to the XML String passed as parameter.
  1. static
  2. RMBulkOperationResults
RMUtil._batchClose(com.filenet.wcm.api.BaseObjects aoBaseObjects,java.lang.String asReasonForClose)
Performs the batch close operation for collection of BaseObjects passed as parameter.
  1. static
  2. RMBulkOperationResults
RMUtil._batchFile(com.filenet.wcm.api.BaseObjects aoBaseObjects,RMRecordContainer aoRecordContainer)
  1. static
  2. RMBulkOperationResults
RMUtil._batchInactivate(boolean abIsInactive,RMObjectStore aoRMOS,com.filenet.wcm.api.BaseObjects aoBaseObjects,java.lang.String asReasonForInactivate)
Performs the batch inactivate operation for collection of BaseObjects passed as parameter.
  1. static
  2. RMBulkOperationResults
RMUtil._batchReopen(boolean abReOpen,com.filenet.wcm.api.BaseObjects aoBaseObjects,java.lang.String asReasonForClose)
Reopens all the baseobject collection instances of ClosableObject (RecordCategory , RecordFolder or Volume).
  1. static
  2. org.w3c.dom.Document
RMUtil._createXMLdoc(org.xml.sax.InputSource aoSource)
Returns an XML document object.
  1. static
  2. org.w3c.dom.Document
RMUtil._createXMLDoc(java.io.InputStream aoInputStream)
Returns an XML document object.
  1. static
  2. org.w3c.dom.Document
RMUtil._createXMLDoc(java.io.Reader aoReader)
Returns an XML document object.
  1. static
  2. org.w3c.dom.Document
RMUtil._createXMLDoc(java.lang.String asString)
Returns an XML document object.
  1. static
  2. java.lang.String
RMUtil._generateDocumentURI(RMObjectStore aoRMObjectStore,java.lang.String asURI)
Returns a String Document URI obtained by modifying the URI (XML String) passed by a user while record declaration.
  1. static
  2. com.filenet.wcm.api.ClassDescriptions
RMUtil._getClassDescriptions(RMObjectStore aoRMObjectStore,int[] aiEntityTypes,boolean abInculdeSubClasses)
Returns the collection of the ClassDescription of all the RM types which are passed in the int array as a parameter.
  1. static
  2. java.lang.String
RMUtil._getClassDescriptionsXML(RMObjectStore aoRMObjectStore,int[] aiEntityTypes,boolean abInculdeSubClasses)
Returns a String in XML that represents the class descriptions for Content Engine classes and their subclasses.
  1. static
  2. java.lang.String[]
RMUtil._getClassIDs(RMObjectStore aoRMObjectStore,int[] aiEntityTypes,boolean abInculdeSubClasses)
Returns a String array of the ClassIds of all the RM entities whose RM type is passed in the int array as a parameter.
  1. static
  2. java.util.Collection
RMUtil._getCollection(java.lang.String[] asArrString)
Returns a collection of String objects for a String array
  1. static
  2. com.filenet.wcm.api.CustomObject
RMUtil._getConnectorRegistrationClass(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL)
Returns a ConnectorRegistration CustomObject retrieved from an RM object store based on the String query passed as parameter
  1. static
  2. int
RMUtil._getCountFromResultSet(java.lang.String asResultSet)
Returns the count of all the z_row elements passed in the ResultSet XML string.
  1. static
  2. DocumentStore
RMUtil._getDocumentStore(java.lang.Object aoObject)
Returns an instance of DocumentStore for the object store, which is passed as a parameter.
  1. static
  2. java.lang.String[]
RMUtil._getFieldFromResultSet(java.lang.String asResultSet,java.lang.String asFieldName)
Returns the FieldName attribute of all the z_row elements passed in the ResultSet XML string.
  1. static
  2. java.lang.String
RMUtil._getFilePlanID(RMFolder aoFolder)
Returns the GUID of the ClassificationScheme object that contains the specified RMFolder object.
  1. static
  2. RMObjectStores
RMUtil._getFilePlanObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores)
Returns an RMObjectStores collection.
  1. static
  2. java.lang.String
RMUtil._getLimitedResultSet(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiMaxRecords)
Returns the String XML result set obtained by executing a query passed as parameter asQuerySQL for an RM object store and retricts the result set as per the input parameter aiMaxRecords.
  1. static
  2. com.filenet.wcm.api.PropertyDescriptions
RMUtil._getPropertyDescriptions(com.filenet.wcm.api.ClassDescription aoClassDescription,java.lang.String asFilterType)
Returns a PropertyDescriptions collection whose elements are property descriptions for the specified classes by filtering out property descriptions based on type.
  1. static
  2. java.lang.String
RMUtil._getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription,java.lang.String asFilterType)
Returns a String in XML that represents property descriptions for the specified classes, by filtering out hidden property descriptions based on type.
  1. static
  2. java.lang.String
RMUtil._getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription,java.lang.String asFilterType,RMRecordContainer aoContainer)
Returns a XML string of the property descriptions filtered out by the type of property descriptions The xml string also includes the Record Pattern associated with the aoContainer.
  1. static
  2. com.filenet.wcm.api.BaseObjects
RMUtil._getQueriedObjects(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiBaseType)
Returns a BaseObjects collection by executing a query passed as parameter asQuerySQL for an RM object store.
  1. static
  2. com.filenet.wcm.api.BaseObjects
RMUtil._getQueriedObjects(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiBaseType,int aiMaxResult)
Returns a BaseObjects collection by executing a query passed as parameter asQuerySQL for an RM object store and retricts the ResultSet as per the input parameter aiMaxResult.
  1. static
  2. java.io.Reader
RMUtil._getReader(java.lang.String asFilePathOrString,java.lang.String asReaderType)
Returns a Reader object.
  1. static
  2. com.filenet.wcm.api.ObjectStores
RMUtil._getRecordObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores)
Returns an ObjectStores collection.
  1. static
  2. java.lang.String
RMUtil._getRecordURI(RMObjectStore aoRMObjectStore,java.lang.String asRecordId)
Returns a URI string for the record
  1. static
  2. com.filenet.wcm.api.CustomObject
RMUtil._getRegistrationClass(RMObjectStore aoRMObjectStore,java.lang.String asRegistraionID)
Returns an RM custom object of type ConnectorRegistration that is retrieved from an RM object store using the ID of this custom object.
  1. static
  2. java.lang.String
RMUtil._getRegistrationID(RMObjectStore aoRMObjectStore,java.lang.String asRepositoryType,java.lang.String asServerName,java.lang.String asRepositoryName,boolean abCreate)
Returns the GUID of a connector registration object.
  1. static
  2. java.lang.String
RMUtil._getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,java.lang.String asQuerySQL,int aiBaseType)
Returns the String XML result set obtained by executing the query passed as parameter asQuerySQL for an object store.
  1. static
  2. java.lang.String
RMUtil._getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,java.lang.String asQuerySQL,int aiBaseType,int aiMaxResults)
Returns a String XML result set obtained by executing a the query passed as parameter asQuerySQL for an object store and retricts the ResultSet as per the input parameter aiMaxResults.
  1. static
  2. java.lang.String
RMUtil._getResultSet(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL)
Returns the String result set obtained by executing a query passed as parameter asQuerySQL in an RM object store.
  1. static
  2. java.lang.String
RMUtil._getResultSet(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiBaseType)
Returns the String XML result set obtained by executing a query passed as parameter asQuerySQL for an RM object store.
  1. static
  2. java.lang.String
RMUtil._getResultSet(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiBaseType,int aiMaxResults)
Returns the String result set obtained by executing a query passed as parameter asQuerySQL in an RM object store and retricts the result set as per the input parameter aiMaxResults.
  1. static
  2. RMObjectStore
RMUtil._getRMObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Returns an instance of RMObjectStore for an object store.
  1. static
  2. java.lang.String
RMUtil._getUserId(RMObjectStore rmObjStore)
Returns the "ShortName" property for the user currently associated with the Buzz Session that is associated with the given RMObjectStore instance.
  1. static
  2. java.lang.String
RMUtil._getUserIdWithDomain(RMObjectStore aoRMObjectStore)
Returns a String specifying the complete domain name of a User who is logged on to the current instance of an object store.
  1. static
  2. boolean
RMUtil._isAnyParentClosed(RMFolder aoRMFolder)
Determines if any parent of the RMFolder is closed.
  1. static
  2. boolean
RMUtil._isFilePlanObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Specifies if an object store is a valid File Plan Object Store.
  1. static
  2. boolean
RMUtil._isRecordObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Specifies if an object store is a valid Records Object Store.
  1. static
  2. void
RMUtil._launchWorkFlow(RMObjectStore aoRMObjectStore,java.util.Map aoMap,java.lang.String asFirstProperty,int aiWorkFlowProperty,filenet.vw.api.VWSession aoVWSession)
Launches the workflow associated with the entities.
  1. static
  2. void
RMUtil._launchWorkFlow(RMObjectStore aoRMObjectStore,java.lang.String[] asGuidArray,java.lang.String asFirstProperty,int aiWorkFlowProperty,filenet.vw.api.VWSession aoVWSession)
Launches the workflow associated with the entities.
  1. static
  2. RecordInfo
RMUtil._locateRecord(java.lang.String asURI)
Retrieves a RecordInfo object corresponding to the URI passed as a parameter.
  1. static
  2. java.util.Map
RMUtil._populateMap(org.w3c.dom.Document aoDocument)
Returns a Map object for the aoDocument, which is an XML String with nodes as key, and the corresponding values as key-value pair.
  1. static
  2. java.util.Map
RMUtil._populateMap(java.lang.String asURL)
Returns a Map object for the asURL, which is an XML String with nodes as key, and the corresponding values as key-value pair.
  1. static
  2. java.lang.String
RMUtil._removeNode(java.lang.String asURI,java.lang.String asKeyName)
Removes the node from the XML String passed as a parameter whose name is specified by the key name.
  1. static
  2. void
RMUtil._validateDestination(RMRecordContainer aoDestination,RecordInfo loRecord)
  1. static
  2. java.lang.String
RMUtil._writeXML(org.w3c.dom.Node aoNode)
Returns an XML string representing the node passed as parameter.
  1. RMBulkOperationResults
RMBulkOperationsUtil.activate(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,java.lang.String asReasonforActivate)
Activates all the RM entities whose IDs are specified in the asArrObjectIDs input parameter.
  1. java.lang.String
RMUtil.addNode(java.lang.String asURI,java.util.Map aoMap)
Deprecated. Use RMUtil._addNode(String asURI, Map aoMap) instead of this method.
  1. java.lang.String
RMUtil.addNode(java.lang.String asURI,java.lang.String asKeyName,java.lang.String asValue)
Deprecated. Use RMUtil._addNode(String asURI, String asKeyName, String asValue) instead of this method.
  1. RMBulkOperationResults
RMBulkOperationsUtil.batchActivate(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,java.lang.String asReasonforActivate)
Activates all the RM entities in batch, whose IDs are specified in the asArrObjectIDs input parameter.
  1. RMBulkOperationResults
RMUtil.batchClose(com.filenet.wcm.api.BaseObjects aoBaseObjects,java.lang.String asReasonForClose)
  1. RMBulkOperationResults
RMUtil.batchFile(com.filenet.wcm.api.BaseObjects aoBaseObjects,RMRecordContainer aoRecordContainer)
  1. RMBulkOperationResults
RMBulkOperationsUtil.batchForcedClose(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,java.lang.String asReasonForClose)
Performs the close operation on all the RM objects whose IDs are specified in the asArrObjectIDs input parameter.
  1. RMBulkOperationResults
RMUtil.batchInactivate(boolean abIsInactive,RMObjectStore aoRMOS,com.filenet.wcm.api.BaseObjects aoBaseObjects,java.lang.String asReasonForInactivate)
  1. RMBulkOperationResults
RMBulkOperationsUtil.batchInactivate(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,java.lang.String asReasonforInActivate)
Inactivates all the RM entities whose Ids are specified in the asArrObjectIDs input parameter.
  1. RMBulkOperationResults
RMUtil.batchReopen(boolean abReOpen,com.filenet.wcm.api.BaseObjects aoBaseObjects,java.lang.String asReasonForClose)
  1. RMBulkOperationResults
RMBulkOperationsUtil.clearDispositionData(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs)
Performs the clear disposition properties operation on all RM entities whose Ids are specified in the asArrObjectIDs input parameter.
  1. RMBulkOperationResults
RMBulkOperationsUtil.close(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,java.lang.String asReasonForClose)
Performs the Close operation on all the RM objects whose IDs are specified in the asArrObjectIDs input parameter.
  1. RMBulkOperationResults
RMBulkOperationsUtil.copy(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,RMRecordContainer aoDestination,com.filenet.wcm.api.Properties aoCopyProps)
Performs the copy operation on all RecordInfo Objects whose Ids are specified in asArrObjectIDs input parameter.
  1. RMBulkOperationResults
RMBulkOperationsUtil.copy(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,RMRecordContainer aoDestination,java.lang.String copyOfPrefix)
Performs the copy operation on all RecordInfo Objects whose Ids are specified in asArrObjectIDs input parameter.
  1. org.w3c.dom.Document
RMUtil.createXMLdoc(org.xml.sax.InputSource aoSource)
Deprecated. Use RMUtil._createXMLdoc(InputSource aoSource) instead of this method.
  1. org.w3c.dom.Document
RMUtil.createXMLDoc(java.io.InputStream aoInputStream)
Deprecated. Use RMUtil._createXMLDoc(InputStream aoInputStream) instead of this method.
  1. org.w3c.dom.Document
RMUtil.createXMLDoc(java.io.Reader aoReader)
Deprecated. Use RMUtil._createXMLDoc(Reader aoReader) instead of this method.
  1. org.w3c.dom.Document
RMUtil.createXMLDoc(java.lang.String asString)
Deprecated. Use RMUtil._createXMLDoc(String asString) instead of this method.
  1. RMBulkOperationResults
RMBulkOperationsUtil.delete(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs)
Performs the delete operation on all RM Entities whose IDs are specified in asArrObjectIDs input parameter.
  1. RMBulkOperationResults
RMBulkOperationsUtil.file(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,RMRecordContainer aoDestination)
Performs the file operations on all RecordInfo Objects whose Ids are specified in asArrObjectIDs input parameter.
  1. RMBulkOperationResults
RMBulkOperationsUtil.forcedClose(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,java.lang.String asReasonForClose)
Performs the close operation on all the RM objects whose IDs are specified in the asArrObjectIDs input parameter.
  1. java.lang.String
RMUtil.generateDocumentURI(RMObjectStore aoRMObjectStore,java.lang.String asURI)
  1. com.filenet.wcm.api.ClassDescriptions
RMUtil.getClassDescriptions(RMObjectStore aoRMObjectStore,int[] aiEntityTypes,boolean abInculdeSubClasses)
  1. java.lang.String
RMUtil.getClassDescriptionsXML(RMObjectStore aoRMObjectStore,int[] aiEntityTypes,boolean abInculdeSubClasses)
  1. java.lang.String[]
RMUtil.getClassIDs(RMObjectStore aoRMObjectStore,int[] aiEntityTypes,boolean abInculdeSubClasses)
  1. java.util.Collection
RMUtil.getCollection(java.lang.String[] asArrString)
Deprecated. Use RMUtil._getCollection(String[] asArrString) instead of this method.
  1. com.filenet.wcm.api.CustomObject
RMUtil.getConnectorRegistrationClass(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL)
  1. int
RMUtil.getCountFromResultSet(java.lang.String asResultSet)
Deprecated. Use RMUtil._getCountFromResultSet(String asResultSet) instead of this method.
  1. DocumentStore
RMUtil.getDocumentStore(java.lang.Object aoObject)
Deprecated. Use RMUtil._getDocumentStore(Object aoObject) instead of this method.
  1. java.lang.String[]
RMUtil.getFieldFromResultSet(java.lang.String asResultSet,java.lang.String asFieldName)
  1. java.lang.String
RMUtil.getFilePlanID(RMFolder aoFolder)
Deprecated. Use RMUtil._getFilePlanID(RMFolder aoFolder) instead of this method.
  1. RMObjectStores
RMUtil.getFilePlanObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores)
Deprecated. Use RMUtil._getFilePlanObjectStores(ObjectStores aoObjectStores) instead of this method.
  1. java.lang.String
RMBulkOperationResult.getLabel()
Returns the member variable msObjectId.
  1. java.lang.String
RMUtil.getLimitedResultSet(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiMaxRecords)
  1. java.lang.String
RMBulkOperationResult.getMessage()
Returns a String value that represents the result of a bulk operation.
  1. com.filenet.wcm.api.PropertyDescriptions
RMUtil.getPropertyDescriptions(com.filenet.wcm.api.ClassDescription aoClassDescription,java.lang.String asFilterType)
  1. java.lang.String
RMUtil.getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription,java.lang.String asFilterType)
  1. java.lang.String
RMUtil.getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription,java.lang.String asFilterType,RMRecordContainer aoContainer)
  1. com.filenet.wcm.api.BaseObjects
RMUtil.getQueriedObjects(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiBaseType)
  1. com.filenet.wcm.api.BaseObjects
RMUtil.getQueriedObjects(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiBaseType,int aiMaxResult)
  1. java.io.Reader
RMUtil.getReader(java.lang.String asFilePathOrString,java.lang.String asReaderType)
  1. static
  2. java.io.Reader
RMUtil.getReader(java.lang.String asFilePathOrString,java.lang.String asReaderType,java.lang.String asEncoding)
  1. com.filenet.wcm.api.ObjectStores
RMUtil.getRecordObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores)
Deprecated. Use RMUtil._getRecordObjectStores(ObjectStores aoObjectStores) instead of this method.
  1. java.lang.String
RMUtil.getRecordURI(RMObjectStore aoRMObjectStore,java.lang.String asRecordId)
  1. com.filenet.wcm.api.CustomObject
RMUtil.getRegistrationClass(RMObjectStore aoRMObjectStore,java.lang.String asRegistraionID)
  1. java.lang.String
RMUtil.getRegistrationID(RMObjectStore aoRMObjectStore,java.lang.String asRepositoryType,java.lang.String asServerName,java.lang.String asRepositoryName,boolean abCreate)
  1. java.lang.String
RMUtil.getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,java.lang.String asQuerySQL,int aiBaseType)
  1. java.lang.String
RMUtil.getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,java.lang.String asQuerySQL,int aiBaseType,int aiMaxResults)
  1. java.lang.String
RMUtil.getResultSet(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL)
  1. java.lang.String
RMUtil.getResultSet(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiBaseType)
  1. java.lang.String
RMUtil.getResultSet(RMObjectStore aoRMObjectStore,java.lang.String asQuerySQL,int aiBaseType,int aiMaxResults)
  1. RMObjectStore
RMUtil.getRMObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Deprecated. Use RMUtil._getRMObjectStore(ObjectStore aoObjectStore) instead of this method.
  1. java.lang.String
RMUtil.getUserId(RMObjectStore aoRMObjectStore)
Deprecated. Use RMUtil._getUserId(RMObjectStore aoRMObjectStore) instead of this method.
  1. java.lang.String
RMUtil.getUserIdWithDomain(RMObjectStore aoRMObjectStore)
Deprecated. Use RMUtil._getUserIdWithDomain(RMObjectStore aoRMObjectStore) instead of this method.
  1. RMBulkOperationResults
RMBulkOperationsUtil.hold(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,Hold aoHold)
Performs hold operation on all RM entities whose Ids are specified in the asArrObjectIDs input parameter.
  1. RMBulkOperationResults
RMBulkOperationsUtil.hold(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,Holds aoHolds)
Performs the hold operation on all the RM entities whose Ids are specified in the asArrObjectIDs input parameter.
  1. RMBulkOperationResults
RMBulkOperationsUtil.hold(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,RMObjects aoHolds)
  1. RMBulkOperationResults
RMBulkOperationsUtil.inActivate(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,java.lang.String asReasonforInActivate)
Inactivates all the RM entities whose Ids are specified in the asArrObjectIDs input parameter.
  1. RMBulkOperationResults
RMBulkOperationsUtil.initiateDisposition(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,filenet.vw.api.VWSession aoVWSession)
Performs initiateDisposition operation on all RM entities whose Ids are specified in the asArrObjectIDs input parameter.
  1. boolean
RMUtil.isAnyParentClosed(RMFolder aoRMFolder)
Deprecated. Use RMUtil._isAnyParentClosed(RMFolder aoRMFolder) instead of this method.
  1. boolean
RMUtil.isFilePlanObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Deprecated. Use RMUtil._isFilePlanObjectStore(ObjectStore aoObjectStore) instead of this method.
  1. boolean
RMUtil.isRecordObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Deprecated. Use RMUtil._isRecordObjectStore(ObjectStore aoObjectStore) instead of this method.
  1. boolean
RMBulkOperationResult.isSuccess()
Specifies whether the bulk operations that have been performed on an RMObject are successful or not.
  1. void
RMUtil.launchWorkFlow(RMObjectStore aoRMObjectStore,java.lang.String[] asGuidArray,java.lang.String asFirstProperty,int aiWorkFlowProperty,filenet.vw.api.VWSession aoVWSession)
  1. RecordInfo
RMUtil.locateRecord(java.lang.String asURI)
Deprecated. Use RMUtil._locateRecord(String asURI) instead of this method.
  1. RMBulkOperationResults
RMBulkOperationsUtil.move(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,RMRecordContainer aoSource,RMFolder aoDestination,java.lang.String asReasonForMove,DispositionSchedule aoDispositionSchedule)
Performs the move operation on all RM entities whose Ids are specified in the asArrObjectIDs input parameter.
  1. java.util.Map
RMUtil.populateMap(org.w3c.dom.Document aoDocument)
Deprecated. Use RMUtil._populateMap(Document aoDocument) instead of this method.
  1. java.util.Map
RMUtil.populateMap(java.lang.String asURL)
Deprecated. Use RMUtil._populateMap(String asURL) instead of this method.
  1. RMBulkOperationResults
RMBulkOperationsUtil.registerExternalEvent(RMObjectStore aoRMOS,java.lang.String[] asArrEventIDs,java.util.Date aoExtEventOccuranceDate)
Updates the ExternalEventOccurrenceDate metadata of the Events represented by the GUIDs specified in input parameter for a particular RMObjectStore.
  1. java.lang.String
RMUtil.removeNode(java.lang.String asURI,java.lang.String asKeyName)
Deprecated. Use RMUtil._removeNode(String asURI, String asKeyName) instead of this method.
  1. RMBulkOperationResults
RMBulkOperationsUtil.reOpen(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,boolean abReOpen,java.lang.String asReasonForClose)
Performs the reOpen operation on all RM objects whose IDs are specified in the asArrObjectIDs input parameter.
  1. void
RMBulkOperationResult.setLabel(java.lang.String asObjId)
Sets the value of the member variable msObjectId equal to the value provided in the input parameter.
  1. void
RMBulkOperationResult.setResult(java.lang.String asMsg,boolean abSuccess)
Sets the value of the member variables msMsg and mbSuccess equal to the values provided in the input parameters.
  1. void
RMXSLUtil.setXSLContent(java.lang.String asXSLContent)
Sets the value of the pathToXSL member variable to the value of the TempFile.
  1. void
RMXSLUtil.setXSLParameter(java.lang.String asKey,java.lang.Object aoValue)
Creates an entry for key and value pair specified as input parameters in member variable parameters of type Map.
  1. static
  2. void
RMUtil.tranferPhaseWithoutAction(RMObjectStore aoRMObjectStore,RMObject aoObject)
This method is used to transfer the phase (having no Current Phase Action )to the next phase.
  1. org.w3c.dom.Document
RMXSLUtil.transformToDom()
Writes the results of transformation (as specified in the XSL file) to XML DOM
  1. RMBulkOperationResults
RMBulkOperationsUtil.undeclare(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs)
Performs the undeclare operation on all RM records whose IDs are specified in asArrObjectIDs input parameter.
  1. RMBulkOperationResults
RMBulkOperationsUtil.unHold(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,Hold aoHold)
Performs the unHold operation on all RM entities whose Ids are specified in input parameter asArrObjectIDs.The Hold object that is specified is disassociated from each RM object.
  1. RMBulkOperationResults
RMBulkOperationsUtil.unHold(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,Holds aoHolds)
Performs the unHold operation on all RM entities whose Ids are specified in the asArrObjectIDs input parameter.
  1. RMBulkOperationResults
RMBulkOperationsUtil.unHold(RMObjectStore aoRMOS,java.lang.String[] asArrObjectIDs,RMObjects aoHolds)
Deprecated. Use instead of this method.
  1. static
  2. void
RMUtil.validateCustomObjectName(RMObjectStore aoRMOS,java.lang.String asCustomObjectClassName,java.lang.String asCustomObjectNameProperty,java.lang.String asName,java.lang.String asCustomObjectTypeProperty,int aiType)
Validates the values of the name property and type property of a CustomObject of specified type.
  1. void
RMUtil.validateDestination(RMRecordContainer aoDestination,RecordInfo loRecord)
  1. java.lang.String
RMUtil.writeXML(org.w3c.dom.Node aoNode)
Deprecated. Use RMUtil._writeXML(Node aoNode) instead of this method.