public class RMUtil
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CEMP_PREFIX
Determines the cemp prefix string
|
static int |
DISPOSAL
The int value represents the Disposition Workflow associated to be launched.
|
static int |
MAX_SUBJECT_INCLUDED_ENTITIES |
static int |
MAX_SUBJECT_LENGTH |
static int |
SCREENING
The int value represents the Vital workflow associated with the entities to be launched.
|
static int |
VITAL
The int value represents the Vital workflow associated with the entities to be launched.
|
Constructor and Description |
---|
RMUtil()
This is the default public constructor of the RMUtil class that initializes a newly created
RMUtil . |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
_addNode(java.lang.String asURI,
java.util.Map aoMap)
Adds mulitiple nodes to the XML String passed as a parameter.
|
static java.lang.String |
_addNode(java.lang.String asURI,
java.lang.String asKeyName,
java.lang.String asValue)
Add Nodes to the XML String passed as parameter.
|
static java.lang.String |
_addPropertiestoSearchXml(java.lang.String asSearchXml,
java.lang.String[] asSymbolicName,
java.lang.String lsClass)
Adds the symbolic name of the Properties to the search XML depending upon the value of lsclass.
|
static void |
_addRMLog(RMObjectStore aoRMObjectStore,
com.filenet.wcm.api.Properties aoProps,
com.filenet.wcm.api.Permissions aoPermissions)
Creates an RMLog object as an instance of RMCustomObject.
|
static java.util.Date |
_addToDate(java.util.Date aoBaseDate,
int aiYear,
int aiMonth,
int aiDay)
Adds the year, month, and day passed as integers to the
Date and returns the Modified Date.
|
static void |
_auditEvent(RMObject aoRMObject,
java.lang.String asReason,
java.lang.String asActionType,
java.lang.String asDescription,
java.lang.String asLastReviewedBy,
int aiEventStatus)
Audits the event based upon the value of Action type.
|
static RMBulkOperationResults |
_batchClose(com.filenet.wcm.api.BaseObjects aoBaseObjects,
java.lang.String asReasonForClose)
Performs the batch close operation for collection of BaseObjects passed as parameter.
|
static RMBulkOperationResults |
_batchFile(com.filenet.wcm.api.BaseObjects aoBaseObjects,
RMRecordContainer aoRecordContainer) |
static RMBulkOperationResults |
_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.
|
static RMBulkOperationResults |
_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).
|
static com.filenet.wcm.api.BatchResultItems |
_bulkUpdateEntities(com.filenet.wcm.api.Session aoSession,
com.filenet.wcm.api.BaseObjects aoEntitiestobeUpdated,
com.filenet.wcm.api.Properties aoProperties,
boolean abAsTransaction,
boolean abDiscardResults,
boolean abStopOnException)
Updates the entities in a batch of 10 entities.
|
static boolean |
_checkPattern(java.lang.String asBaseName,
java.lang.String asPattern)
Validates whether a string name that is passed in the asBaseName parameter is
valid as per the pattern specified by the asPattern paramter.
|
static boolean |
_containsValue(int[] aiArrValue,
int aiValue) |
static org.w3c.dom.Document |
_createXMLdoc(org.xml.sax.InputSource aoSource)
Returns an XML document object.
|
static org.w3c.dom.Document |
_createXMLDoc(java.io.InputStream aoInputStream)
Returns an XML document object.
|
static org.w3c.dom.Document |
_createXMLDoc(java.io.Reader aoReader)
Returns an XML document object.
|
static org.w3c.dom.Document |
_createXMLDoc(java.lang.String asString)
Returns an XML document object.
|
static boolean |
_doMultipleFilePlanExist(RMObjectStore aoRMObjectStore)
Checks whether the given object store contains more then one file plan.
|
static java.lang.String |
_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.
|
static DispositionAllocatableObject |
_getActingDisposalSchedule(RMObject aoRMObject)
Returns the entity with which a disposal schedule is associated or cut-off data is inherited.
|
static java.util.Vector |
_getAllDateProperties(RMObjectStore aoRMObjectStore)
Retrieves the symbolic names of all the date-type properties
of the Folder and Document classes.
|
static com.filenet.wcm.api.ClassDescriptions |
_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.
|
static java.lang.String |
_getClassDescriptionsXML(RMObjectStore aoRMObjectStore,
int[] aiEntityTypes,
boolean abInculdeSubClasses)
Returns a String in XML that represents the class descriptions for Content
Engine classes and their subclasses.
|
static java.lang.String[] |
_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.
|
static java.util.Collection |
_getCollection(java.lang.String[] asArrString)
Returns a collection of String objects for a String array
|
static java.lang.String |
_getConnectorQueryString(java.lang.String asRepositoryType,
java.lang.String asRepositoryName,
java.lang.String asServerName)
Returns a query string to retrieve the connector registration object.
|
static com.filenet.wcm.api.CustomObject |
_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
|
static int |
_getCountFromResultSet(java.lang.String asResultSet)
Returns the count of all the z_row elements passed in the
ResultSet XML string.
|
static int |
_getCountFromSingleObjectType(java.lang.String asResultSet)
This method returns the count tag value from the ResultSet.
|
static java.util.Date |
_getCurrentPhaseExecutionDate(DisposableObject aoRMObject)
Calculates the current phase executution date for an entity
|
static DocumentStore |
_getDocumentStore(java.lang.Object aoObject)
Returns an instance of DocumentStore for the object store, which is passed
as a parameter.
|
static java.lang.String[] |
_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.
|
static java.lang.String |
_getFilePlanID(RMFolder aoFolder)
Returns the GUID of the ClassificationScheme object that contains the specified RMFolder object.
|
static RMObjectStores |
_getFilePlanObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores)
Returns an RMObjectStores collection.
|
static java.lang.String |
_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.
|
static com.filenet.wcm.api.BaseObjects |
_getMerged(java.util.ArrayList aoIDCheck,
com.filenet.wcm.api.BaseObjects aoToBeReplacedRecord)
Filters those documents from the aoToBeReplacedRecord BaseObjects collection that are not contained in the aoIDCheck collection.
|
static java.util.ArrayList |
_getMergedROSOR(java.util.ArrayList aoRecordID1,
java.util.ArrayList aoRecordID2)
Returns a union of the record IDs as specified in the input parameters.
|
static java.lang.String |
_getMergedXML(java.lang.String aoReaderXMLIDCheck,
java.lang.String aoReaderXMLToBeReplaced,
java.lang.String aoXSLFile)
Invokes the XSLT transformation on the XML DOM document represented by the aoReaderXMLIDCheck string.
|
static org.w3c.dom.Document |
_getNewDocument()
Returns an empty Document object that is obtained from the Document Builder factory
|
static java.lang.String |
_getObjectStoreXML(com.filenet.wcm.api.ObjectStores aoObjectStores)
Returns a String that contains an XML representation of the object stores
The XML representation includes only those object stores that are valid FPOS.
|
static java.lang.String |
_getObjectStoreXML(com.filenet.wcm.api.ObjectStores aoObjectStores,
java.lang.String[] asArrProps)
Returns a string that contains an XML representation of the object stores (and their properties, specified as symbolic names).
|
static com.filenet.wcm.api.PropertyDescriptions |
_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.
|
static java.lang.String |
_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.
|
static java.lang.String |
_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.
|
static com.filenet.wcm.api.BaseObjects |
_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.
|
static com.filenet.wcm.api.BaseObjects |
_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.
|
static java.io.Reader |
_getReader(java.lang.String asFilePathOrString,
java.lang.String asReaderType)
Returns a Reader object.
|
static com.filenet.wcm.api.ObjectStores |
_getRecordObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores)
Returns an ObjectStores collection.
|
static java.lang.String |
_getRecordURI(RMObjectStore aoRMObjectStore,
java.lang.String asRecordId)
Returns a URI string for the record
|
static com.filenet.wcm.api.CustomObject |
_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.
|
static java.lang.String |
_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.
|
static java.lang.String |
_getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,
java.lang.String asQuery)
Returns a string in XML that represents the results of a query in an object store.
|
static java.lang.String |
_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.
|
static java.lang.String |
_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.
|
static java.lang.String |
_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.
|
static java.lang.String |
_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.
|
static java.lang.String |
_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.
|
static RMObjectStore |
_getRMObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Returns an instance of RMObjectStore for an object store.
|
static java.lang.String |
_getUserId(RMObjectStore rmObjStore)
Returns the "ShortName" property for the user currently associated with
the Buzz Session that is associated with the given RMObjectStore instance.
|
static java.lang.String |
_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.
|
static boolean |
_isAnyParentClosed(RMFolder aoRMFolder)
Determines if any parent of the RMFolder is closed.
|
static boolean |
_isFilePlanObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Specifies if an object store is a valid File Plan Object Store.
|
static boolean |
_isRecordObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Specifies if an object store is a valid Records Object Store.
|
static void |
_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.
|
static void |
_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.
|
static RecordInfo |
_locateRecord(java.lang.String asURI)
Retrieves a RecordInfo object corresponding to the URI passed as a parameter.
|
static java.util.Map |
_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.
|
static java.util.Map |
_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.
|
static java.lang.String |
_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.
|
static boolean |
_useInSubFolder(RMObjectStore aoObjectStore,
java.lang.String aoFolderPath) |
static boolean |
_validateDate(java.lang.String asDate,
java.lang.String asFormat)
Returns true or false if the Date passed as String is as per the format
passed as parameter
|
static void |
_validateDestination(RMRecordContainer aoDestination,
RecordInfo loRecord) |
static void |
_validateDisposition(DisposableObject aoDisposableObject)
Validates whether the entity passed as input parameter can be disposed or
not.
|
static java.lang.String |
_writeXML(org.w3c.dom.Node aoNode)
Returns an XML string representing the node passed as parameter.
|
java.lang.String |
addNode(java.lang.String asURI,
java.util.Map aoMap)
Deprecated.
Use
_addNode(String asURI, Map aoMap) instead of this method. |
java.lang.String |
addNode(java.lang.String asURI,
java.lang.String asKeyName,
java.lang.String asValue)
Deprecated.
Use
_addNode(String asURI, String asKeyName, String asValue) instead of this method. |
java.lang.String |
addPropertiestoSearchXml(java.lang.String asSearchXml,
java.lang.String[] asSymbolicName,
java.lang.String lsClass)
Deprecated.
Use
_addPropertiestoSearchXml(String asSearchXml, String[] asSymbolicName, String lsClass) instead of this method. |
void |
addRMLog(RMObjectStore aoRMObjectStore,
com.filenet.wcm.api.Properties aoProps,
com.filenet.wcm.api.Permissions aoPermissions)
Deprecated.
Use
_addRMLog(RMObjectStore aoRMObjectStore, Properties aoProps, Permissions aoPermissions) instead of this method. |
java.util.Date |
addToDate(java.util.Date aoBaseDate,
int aiYear,
int aiMonth,
int aiDay)
Deprecated.
Use
_addToDate(Date aoBaseDate, int aiYear, int aiMonth, int aiDay) instead of this method. |
void |
auditEvent(RMObject aoRMObject,
java.lang.String asReason,
java.lang.String asActionType,
java.lang.String asDescription,
java.lang.String asLastReviewedBy,
int aiEventStatus)
Deprecated.
|
RMBulkOperationResults |
batchClose(com.filenet.wcm.api.BaseObjects aoBaseObjects,
java.lang.String asReasonForClose)
Deprecated.
Use
_batchClose(BaseObjects aoBaseObjects, String asReasonForClose) instead of this method. |
RMBulkOperationResults |
batchFile(com.filenet.wcm.api.BaseObjects aoBaseObjects,
RMRecordContainer aoRecordContainer) |
RMBulkOperationResults |
batchInactivate(boolean abIsInactive,
RMObjectStore aoRMOS,
com.filenet.wcm.api.BaseObjects aoBaseObjects,
java.lang.String asReasonForInactivate)
Deprecated.
|
RMBulkOperationResults |
batchReopen(boolean abReOpen,
com.filenet.wcm.api.BaseObjects aoBaseObjects,
java.lang.String asReasonForClose)
Deprecated.
Use
_batchReopen(boolean abReOpen, BaseObjects aoBaseObjects, String asReasonForClose) instead of this method. |
com.filenet.wcm.api.BatchResultItems |
bulkUpdateEntities(com.filenet.wcm.api.Session aoSession,
com.filenet.wcm.api.BaseObjects aoEntitiestobeUpdated,
com.filenet.wcm.api.Properties aoProperties,
boolean abAsTransaction,
boolean abDiscardResults,
boolean abStopOnException)
|
static java.lang.String |
checkNull(java.lang.String asString)
Validates if passed String is null.
|
boolean |
checkPattern(java.lang.String asBaseName,
java.lang.String asPattern)
Deprecated.
Use
_checkPattern(String asBaseName, String asPattern) instead of this method. |
boolean |
containsValue(int[] aiArrValue,
int aiValue) |
org.w3c.dom.Document |
createXMLdoc(org.xml.sax.InputSource aoSource)
Deprecated.
Use
_createXMLdoc(InputSource aoSource) instead of this method. |
org.w3c.dom.Document |
createXMLDoc(java.io.InputStream aoInputStream)
Deprecated.
Use
_createXMLDoc(InputStream aoInputStream) instead of this method. |
org.w3c.dom.Document |
createXMLDoc(java.io.Reader aoReader)
Deprecated.
Use
_createXMLDoc(Reader aoReader) instead of this method. |
org.w3c.dom.Document |
createXMLDoc(java.lang.String asString)
Deprecated.
Use
_createXMLDoc(String asString) instead of this method. |
static java.lang.String |
DecodeFormattedString(java.lang.String asStringValue)
Decode the passed String by replacing strings like &,<,> with filter operators.
|
boolean |
doMultipleFilePlanExist(RMObjectStore aoRMObjectStore)
Deprecated.
Use
_doMultipleFilePlanExist(RMObjectStore aoRMObjectStore) instead of this method. |
java.lang.String |
generateDocumentURI(RMObjectStore aoRMObjectStore,
java.lang.String asURI)
Deprecated.
Use
_generateDocumentURI(RMObjectStore aoRMObjectStore, String asURI) instead of this method. |
DispositionAllocatableObject |
getActingDisposalSchedule(RMObject aoRMObject)
Deprecated.
Use
_getActingDisposalSchedule(RMObject aoRMObject) instead of this method. |
static java.util.List |
getAllAssociatedROS(RMObjectStore rmFPOS) |
static java.util.Map |
getAllImplementataions(RMObjectStore aoRMObjectStore)
This method search for the connector registration and returns the Map containing the implementation class name as the key and the value is the ArrayList that in turn contains the ArrayList containing the parameters like server name, repository name and the repository type
|
static com.filenet.wcm.api.ObjectStores |
getAllObjectStores(com.filenet.wcm.api.EntireNetwork loEntireNetwork)
Returns a collection that contains all the object stores in the EntireNetwork.
|
static java.lang.String |
getAllObjectStoresXML(com.filenet.wcm.api.EntireNetwork loEntireNetwork,
java.lang.String[] propNames)
Returns all the object stores properties in XML form from the EntireNetwork Object
|
static com.filenet.api.core.Connection |
getCEConnection(com.filenet.wcm.api.Session session)
Retrieves a CE 4.0 Connection aka DaphneConnection object from the current Buzz Session
|
com.filenet.wcm.api.ClassDescriptions |
getClassDescriptions(RMObjectStore aoRMObjectStore,
int[] aiEntityTypes,
boolean abInculdeSubClasses)
Deprecated.
Use
_getClassDescriptions(RMObjectStore aoRMObjectStore,
int[] aiEntityTypes,
boolean abInculdeSubClasses
) instead of this method. |
java.lang.String |
getClassDescriptionsXML(RMObjectStore aoRMObjectStore,
int[] aiEntityTypes,
boolean abInculdeSubClasses)
Deprecated.
Use
_getClassDescriptionsXML(RMObjectStore aoRMObjectStore,
int[] aiEntityTypes,
boolean abInculdeSubClasses
) instead of this method. |
java.lang.String[] |
getClassIDs(RMObjectStore aoRMObjectStore,
int[] aiEntityTypes,
boolean abInculdeSubClasses)
Deprecated.
Use
_getClassIDs(RMObjectStore aoRMObjectStore,
int[] aiEntityTypes,
boolean abInculdeSubClasses
) instead of this method. |
java.util.Collection |
getCollection(java.lang.String[] asArrString)
Deprecated.
Use
_getCollection(String[] asArrString) instead of this method. |
java.lang.String |
getConnectorQueryString(java.lang.String asRepositoryType,
java.lang.String asRepositoryName,
java.lang.String asServerName)
Deprecated.
Use
_getConnectorQueryString(String asRepositoryType,
String asRepositoryName,
String asServerName
) instead of this method. |
com.filenet.wcm.api.CustomObject |
getConnectorRegistrationClass(RMObjectStore aoRMObjectStore,
java.lang.String asQuerySQL)
Deprecated.
Use
_getConnectorRegistrationClass(RMObjectStore
aoRMObjectStore,
String asQuerySQL
) instead of this method. |
static java.lang.String |
getConnectorSearchURL(RMObjectStore aoRMObjectStore,
java.lang.String asRMConn,
java.util.Map aoImplClassMap)
Generates the search URL that needs to be passed to the RMConnector implementation for the search related methods
|
int |
getCountFromResultSet(java.lang.String asResultSet)
Deprecated.
Use
_getCountFromResultSet(String asResultSet) instead of this method. |
int |
getCountFromSingleObjectType(java.lang.String asResultSet)
Deprecated.
Use
_getCountFromSingleObjectType(String asResultSet) instead of this method. |
java.util.Date |
getCurrentPhaseExecutionDate(DisposableObject aoRMObject)
Deprecated.
Use
_getCurrentPhaseExecutionDate(DisposableObject aoRMObject) instead of this method. |
DocumentStore |
getDocumentStore(java.lang.Object aoObject)
Deprecated.
Use
_getDocumentStore(Object aoObject) instead of this method. |
java.lang.String[] |
getFieldFromResultSet(java.lang.String asResultSet,
java.lang.String asFieldName)
Deprecated.
Use
_getFieldFromResultSet(String asResultSet, String asFieldName) instead of this method. |
java.lang.String |
getFilePlanID(RMFolder aoFolder)
Deprecated.
Use
_getFilePlanID(RMFolder aoFolder) instead of this method. |
RMObjectStores |
getFilePlanObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores)
Deprecated.
Use
_getFilePlanObjectStores(ObjectStores aoObjectStores) instead of this method. |
static java.lang.String |
getFormattedString(java.lang.String asStringValue)
Formats the passed String by replacing characters like &,',<,> with filter operators.
|
static java.lang.String[] |
getIdsFromEntityClass(RMObjectStore aoObjectStore,
java.lang.String asFrom,
java.lang.String asWhereClause)
Returns a String array whose elements specify the IDs of objects that match the given criteria.
|
java.lang.String |
getLimitedResultSet(RMObjectStore aoRMObjectStore,
java.lang.String asQuerySQL,
int aiMaxRecords)
Deprecated.
Use
_getLimitedResultSet(RMObjectStore aoRMObjectStore,
String asQuerySQL, int aiMaxRecords) instead of this method. |
static java.util.Locale |
getLocale(com.filenet.wcm.api.Session session)
Returns a Locale object from the Session
|
com.filenet.wcm.api.BaseObjects |
getMerged(java.util.ArrayList aoIDCheck,
com.filenet.wcm.api.BaseObjects aoToBeReplacedRecord)
Deprecated.
Use
_getMerged(ArrayList aoIDCheck,
BaseObjects aoToBeReplacedRecord) instead of this method. |
java.util.ArrayList |
getMergedROSOR(java.util.ArrayList aoRecordID1,
java.util.ArrayList aoRecordID2)
Deprecated.
Use
_getMergedROSOR(ArrayList aoRecordID1, ArrayList aoRecordID2) instead of this method. |
java.lang.String |
getMergedXML(java.lang.String aoReaderXMLIDCheck,
java.lang.String aoReaderXMLToBeReplaced,
java.lang.String aoXSLFile)
Deprecated.
Use
_getMergedXML(String aoReaderXMLIDCheck,
String aoReaderXMLToBeReplaced,
String aoXSLFile
) instead of this method. |
static java.lang.String |
getModifiedConditionXML(RMObjectStore aoRMObjectStore,
java.lang.String asConditionXML)
This method returns the XML after modidfying the Sql tag.
|
org.w3c.dom.Document |
getNewDocument()
Deprecated.
Use
_getNewDocument() instead of this method. |
java.lang.String |
getObjectStoreXML(com.filenet.wcm.api.ObjectStores aoObjectStores)
Deprecated.
Use
_getObjectStoreXML(ObjectStores aoObjectStores) instead of this method. |
java.lang.String |
getObjectStoreXML(com.filenet.wcm.api.ObjectStores aoObjectStores,
java.lang.String[] asArrProps)
Deprecated.
Use
_getObjectStoreXML(ObjectStores aoObjectStores,
String[] asArrProps) instead of this method. |
static java.lang.String |
getPreviewListingOfEntites(RMObjectStore aoRMObjectStore,
java.lang.String[] asSelectClauseProperty,
java.lang.String asConditionXML,
java.lang.String asFilterCriteria,
int aiMaxRecords)
This method returns the XML containig information about the entites depending upon the properties tag contained in the asConditionXML.
|
com.filenet.wcm.api.PropertyDescriptions |
getPropertyDescriptions(com.filenet.wcm.api.ClassDescription aoClassDescription,
java.lang.String asFilterType)
Deprecated.
Use
_getPropertyDescriptions(ClassDescription
aoClassDescription,
String asFilterType
) instead of this method. |
java.lang.String |
getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription,
java.lang.String asFilterType)
Deprecated.
Use
_getPropertyDescriptionXML(ClassDescription aoClassDescription,
String asFilterType) instead of this method. |
java.lang.String |
getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription,
java.lang.String asFilterType,
RMRecordContainer aoContainer)
Deprecated.
|
com.filenet.wcm.api.BaseObjects |
getQueriedObjects(RMObjectStore aoRMObjectStore,
java.lang.String asQuerySQL,
int aiBaseType)
Deprecated.
Use
_getQueriedObjects(RMObjectStore aoRMObjectStore,
String asQuerySQL, int aiBaseType) instead of this method. |
com.filenet.wcm.api.BaseObjects |
getQueriedObjects(RMObjectStore aoRMObjectStore,
java.lang.String asQuerySQL,
int aiBaseType,
int aiMaxResult)
Deprecated.
Use
_getQueriedObjects(RMObjectStore aoRMObjectStore,
String asQuerySQL, int aiBaseType,
int aiMaxResult
) instead of this method. |
java.io.Reader |
getReader(java.lang.String asFilePathOrString,
java.lang.String asReaderType)
Deprecated.
Use
_getReader(String asFilePathOrString, String asReaderType) instead of this method. |
static java.io.Reader |
getReader(java.lang.String asFilePathOrString,
java.lang.String asReaderType,
java.lang.String asEncoding)
Deprecated.
Use
_getReader(String asFilePathOrString, String asReaderType) instead of this method. |
com.filenet.wcm.api.ObjectStores |
getRecordObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores)
Deprecated.
Use
_getRecordObjectStores(ObjectStores aoObjectStores) instead of this method. |
java.lang.String |
getRecordURI(RMObjectStore aoRMObjectStore,
java.lang.String asRecordId)
Deprecated.
Use
_getRecordURI(RMObjectStore aoRMObjectStore, String asRecordId) instead of this method. |
com.filenet.wcm.api.CustomObject |
getRegistrationClass(RMObjectStore aoRMObjectStore,
java.lang.String asRegistraionID)
Deprecated.
Use
_getRegistrationClass(RMObjectStore aoRMObjectStore,
String asRegistraionID) instead of this method. |
java.lang.String |
getRegistrationID(RMObjectStore aoRMObjectStore,
java.lang.String asRepositoryType,
java.lang.String asServerName,
java.lang.String asRepositoryName,
boolean abCreate)
Deprecated.
|
java.lang.String |
getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,
java.lang.String asQuery)
Deprecated.
Use
_getResultSet(ObjectStore aoObjectStore, String asQuery) instead of this method. |
java.lang.String |
getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,
java.lang.String asQuerySQL,
int aiBaseType)
Deprecated.
Use
_getResultSet(ObjectStore aoObjectStore, String asQuerySQL,
int aiBaseType) instead of this method. |
java.lang.String |
getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore,
java.lang.String asQuerySQL,
int aiBaseType,
int aiMaxResults)
Deprecated.
Use
_getResultSet(ObjectStore aoObjectStore, String asQuerySQL,
int aiBaseType, int aiMaxResults) instead of this method. |
java.lang.String |
getResultSet(RMObjectStore aoRMObjectStore,
java.lang.String asQuerySQL)
Deprecated.
Use
_getResultSet(RMObjectStore aoRMObjectStore, String asQuerySQL) instead of this method. |
java.lang.String |
getResultSet(RMObjectStore aoRMObjectStore,
java.lang.String asQuerySQL,
int aiBaseType)
Deprecated.
Use
_getResultSet(RMObjectStore aoRMObjectStore, String asQuerySQL,
int aiBaseType) instead of this method. |
java.lang.String |
getResultSet(RMObjectStore aoRMObjectStore,
java.lang.String asQuerySQL,
int aiBaseType,
int aiMaxResults)
Deprecated.
Use
_getResultSet(RMObjectStore aoRMObjectStore, String asQuerySQL,
int aiBaseType, int aiMaxResults) instead of this method. |
static RMObjects |
getRMObjects(RMObjectStore aoObjectStore,
java.lang.String asFrom,
java.lang.String asWhereClause)
Returns a collection of RMObjects that match the given criteria.
|
RMObjectStore |
getRMObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Deprecated.
Use
_getRMObjectStore(ObjectStore aoObjectStore) instead of this method. |
com.filenet.wcm.api.ObjectStore |
getROSObjectStore(RecordInfo loInfo,
com.filenet.wcm.api.Session sess) |
static java.lang.String[] |
GetROSURL(org.w3c.dom.NodeList loURLNode) |
java.lang.String |
getUserId(RMObjectStore aoRMObjectStore)
Deprecated.
Use
_getUserId(RMObjectStore aoRMObjectStore) instead of this method. |
java.lang.String |
getUserIdWithDomain(RMObjectStore aoRMObjectStore)
Deprecated.
Use
_getUserIdWithDomain(RMObjectStore aoRMObjectStore) instead of this method. |
static java.lang.String |
getUsernameFromFullName(java.lang.String fullName)
Get the short username from possible full username.
|
boolean |
isAnyParentClosed(RMFolder aoRMFolder)
Deprecated.
Use
_isAnyParentClosed(RMFolder aoRMFolder) instead of this method. |
boolean |
isFilePlanObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Deprecated.
Use
_isFilePlanObjectStore(ObjectStore aoObjectStore) instead of this method. |
boolean |
isRecordObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore)
Deprecated.
Use
_isRecordObjectStore(ObjectStore aoObjectStore) instead of this method. |
static RMBulkOperationResults |
lauchWorkflow(filenet.vw.api.VWSession aoVWSession,
java.lang.String[] aoObjects,
RMObjectStore aoObjectStore,
java.lang.String workflowVersionId,
java.lang.String[] paramNames,
java.lang.String[] paramValues)
Launches the workflow with a given version directly
|
void |
launchWorkFlow(RMObjectStore aoRMObjectStore,
java.lang.String[] asGuidArray,
java.lang.String asFirstProperty,
int aiWorkFlowProperty,
filenet.vw.api.VWSession aoVWSession)
Deprecated.
|
RecordInfo |
locateRecord(java.lang.String asURI)
Deprecated.
Use
_locateRecord(String asURI) instead of this method. |
java.util.Map |
populateMap(org.w3c.dom.Document aoDocument)
Deprecated.
Use
_populateMap(Document aoDocument) instead of this method. |
java.util.Map |
populateMap(java.lang.String asURL)
Deprecated.
Use
_populateMap(String asURL) instead of this method. |
java.lang.String |
removeNode(java.lang.String asURI,
java.lang.String asKeyName)
Deprecated.
Use
_removeNode(String asURI, String asKeyName) instead of this method. |
static java.lang.String |
replaceAll(java.lang.String acSpecialCh,
java.lang.String asReplaceBy,
java.lang.String asMainStr)
Returns String after replacing characters with the provided characters.
|
static java.lang.String |
replaceALLInstance(java.lang.String asFindStr,
java.lang.String asReplaceBy,
java.lang.String asMainStr)
This method replace all the occurance of asFindStr with asReplaceBy in as MainStr
|
static java.util.Date |
settingTimeComponentasZero(java.util.Date aoDate)
Sets the time component of the date as zero
|
static java.lang.String |
toStringFromStringArray(java.lang.String[] asArrString)
Converts the string elements in the string array to a string
|
static void |
tranferPhaseWithoutAction(RMObjectStore aoRMObjectStore,
RMObject aoObject)
This method is used to transfer the phase (having no Current Phase Action )to the next phase.
|
boolean |
useInSubFolder(RMObjectStore aoObjectStore,
java.lang.String aoFolderPath) |
static void |
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.
|
boolean |
validateDate(java.lang.String asDate,
java.lang.String asFormat)
Deprecated.
Use
_validateDate(String asDate, String asFormat) instead of this method. |
void |
validateDestination(RMRecordContainer aoDestination,
RecordInfo loRecord) |
void |
validateDisposition(DisposableObject aoDisposableObject)
Deprecated.
Use
_validateDisposition(DisposableObject aoDisposableObject) instead of this method. |
java.lang.String |
writeXML(org.w3c.dom.Node aoNode)
Deprecated.
Use
_writeXML(Node aoNode) instead of this method. |
public static final int DISPOSAL
public static final int VITAL
public static final int SCREENING
public static final int MAX_SUBJECT_INCLUDED_ENTITIES
public static final int MAX_SUBJECT_LENGTH
public static final java.lang.String CEMP_PREFIX
public RMUtil()
RMUtil
.public static RMObjects getRMObjects(RMObjectStore aoObjectStore, java.lang.String asFrom, java.lang.String asWhereClause)
aoObjectStore
- An object store on which action is to be performed.asFrom
- A class name from which the RMObjects are to be fetched.asWhereClause
- A string that represents the conditions based on which the RMObjects are to be fetched.public static java.lang.String[] getIdsFromEntityClass(RMObjectStore aoObjectStore, java.lang.String asFrom, java.lang.String asWhereClause)
aoObjectStore
- An object store on which action is to be performed.asFrom
- A class name from which the object IDs are to be fetched.asWhereClause
- A String that represents the conditions based on which the object IDs are to be fetched.public void launchWorkFlow(RMObjectStore aoRMObjectStore, java.lang.String[] asGuidArray, java.lang.String asFirstProperty, int aiWorkFlowProperty, filenet.vw.api.VWSession aoVWSession) throws RMException
_launchWorkFlow(RMObjectStore aoRMObjectStore,
String[] asGuidArray,
String asFirstProperty, int aiWorkFlowProperty,
VWSession aoVWSession
)
instead of this method.aoRMObjectStore
- An object store where RM entities exist.asGuidArray
- A String array whose elements specify the IDs of RM entities.asFirstProperty
- A Property on which sorting is to be performed.aiWorkFlowProperty
- An int value represents the workflow to be launchedaoVWSession
- A VWSession object.RMException
- In case of any error, an RMException will be thrown.public static void _launchWorkFlow(RMObjectStore aoRMObjectStore, java.lang.String[] asGuidArray, java.lang.String asFirstProperty, int aiWorkFlowProperty, filenet.vw.api.VWSession aoVWSession) throws RMException
aoRMObjectStore
- An object store where RM entities exist.asGuidArray
- A String array whose elements specify the IDs of RM entities.asFirstProperty
- A Property on which sorting is to be performed.aiWorkFlowProperty
- An int value represents the workflow to be launchedaoVWSession
- A VWSession object.RMException
- In case of any error, an RMException will be thrown.public static void _launchWorkFlow(RMObjectStore aoRMObjectStore, java.util.Map aoMap, java.lang.String asFirstProperty, int aiWorkFlowProperty, filenet.vw.api.VWSession aoVWSession) throws RMException
aoRMObjectStore
- An object store where RM entities exist.aoMap
- A Map containing the asFirstProperty
- A Property on which sorting is to be performed.aiWorkFlowProperty
- An int value represents the workflow to be launchedaoVWSession
- A VWSession object.RMException
- In case of any error, an RMException will be thrown.public static RMBulkOperationResults lauchWorkflow(filenet.vw.api.VWSession aoVWSession, java.lang.String[] aoObjects, RMObjectStore aoObjectStore, java.lang.String workflowVersionId, java.lang.String[] paramNames, java.lang.String[] paramValues)
aoVWSession
- - a valid VW sessionaoObjects
- aoObjectStore
- workflowVersionId
- paramNames
- paramValues
- public com.filenet.wcm.api.ObjectStores getRecordObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores) throws RMException
_getRecordObjectStores(ObjectStores aoObjectStores)
instead of this method.aoObjectStores
- A collection of object stores.RMException
- if collection is empty or null, an RMException is thrown.public static com.filenet.wcm.api.ObjectStores _getRecordObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores) throws RMException
aoObjectStores
- A collection of object stores.RMException
- if collection is empty or null, an RMException is thrown.public RMObjectStores getFilePlanObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores) throws RMException
_getFilePlanObjectStores(ObjectStores aoObjectStores)
instead of this method.aoObjectStores
- A collection of object stores.RMException
- If the collection is empty or null, an RMException is thrown.public static RMObjectStores _getFilePlanObjectStores(com.filenet.wcm.api.ObjectStores aoObjectStores) throws RMException
aoObjectStores
- A collection of object stores.RMException
- If the collection is empty or null, an RMException is thrown.public java.lang.String getFilePlanID(RMFolder aoFolder) throws RMException
_getFilePlanID(RMFolder aoFolder)
instead of this method.aoFolder
- An RMFolder object.RMException
- In case of any error, an RMException will be thrown.public static java.lang.String _getFilePlanID(RMFolder aoFolder) throws RMException
aoFolder
- An RMFolder object.RMException
- In case of any error, an RMException will be thrown.public boolean isFilePlanObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore) throws RMException
_isFilePlanObjectStore(ObjectStore aoObjectStore)
instead of this method.aoObjectStore
- An object store.RMException
- In case of any error, an RMException will be thrown.public static boolean _isFilePlanObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore) throws RMException
aoObjectStore
- An object store.RMException
- In case of any error, an RMException will be thrown.public java.lang.String getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore, java.lang.String asQuery)
_getResultSet(ObjectStore aoObjectStore, String asQuery)
instead of this method.aoObjectStore
- An object store where a query is to be executed.asQuery
- A String that represents the SQL query.RMException
- In case of any error, an RMException will be thrown.public static java.lang.String _getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore, java.lang.String asQuery)
aoObjectStore
- An object store where a query is to be executed.asQuery
- A String that represents the SQL query.RMException
- In case of any error, an RMException will be thrown.public static void validateCustomObjectName(RMObjectStore aoRMOS, java.lang.String asCustomObjectClassName, java.lang.String asCustomObjectNameProperty, java.lang.String asName, java.lang.String asCustomObjectTypeProperty, int aiType) throws RMException
aoRMOS
- An object store where the validation is to be performed.asCustomObjectClassName
- Symbolic name of the CustomObject class, for example, DisposalTrigger.asCustomObjectNameProperty
- Symbolic name of the name property of the CustomObject class, for example, DisposalTriggerName.asName
- A String that specifies the value of the name property of a custom object.asCustomObjectTypeProperty
- Symbolic name of the custom object type property of the CustomObject class. This
parameter specifies the type of a custom object with respect to the CustomObject class specified in
asCustomObjectClassName, for example, EventType.aiType
- An int that specifies the value of the custom object type property of a custom object.RMException
- If any error occurs, an RMException is thrown.public boolean isRecordObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore) throws RMException
_isRecordObjectStore(ObjectStore aoObjectStore)
instead of this method.aoObjectStore
- An object store.RMException
- In case of any error, an RMException will be thrown.public static boolean _isRecordObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore) throws RMException
aoObjectStore
- An object store.RMException
- In case of any error, an RMException will be thrown.public java.lang.String getRegistrationID(RMObjectStore aoRMObjectStore, java.lang.String asRepositoryType, java.lang.String asServerName, java.lang.String asRepositoryName, boolean abCreate) throws RMException
_getRegistrationID(RMObjectStore aoRMObjectStore,
String asRepositoryType,
String asServerName, String asRepositoryName,
boolean abCreate
)
instead of this method.aoRMObjectStore
- A FPOS where a connector registration object is to be located or created.asRepositoryType
- A String that represents the documents repository type.
For this release it can only be CE.asServerName
- A String that represents the documents repository server URL.
If the asRepositoryType is CE, asServerName has to be the remote server URL of CE.
For this release this variable will be ignored in this method, so you can pass in null value.asRepositoryName
- A String that represents the records repository domain name and the ROS name. If the asRepositoryType is CE,
the asRepositoryName has to be the combination of CE domain name and ROS name. For example, myCEDomain.myROS.abCreate
- A boolean that indicates whether to create a new connector registration object if no existing object matches the given parameters.RMException
- In case of any error, an RMException will be thrown.public static java.lang.String _getRegistrationID(RMObjectStore aoRMObjectStore, java.lang.String asRepositoryType, java.lang.String asServerName, java.lang.String asRepositoryName, boolean abCreate) throws RMException
aoRMObjectStore
- A FPOS where a connector registration object is to be located or created.asRepositoryType
- A String that represents the documents repository type.
For this release it can only be CE.asServerName
- A String that represents the documents repository server URL.
If the asRepositoryType is CE, asServerName has to be the remote server URL of CE.
For this release this variable will be ignored in this method, so you can pass in null value.asRepositoryName
- A String that represents the records repository domain name and the ROS name. If the asRepositoryType is CE,
the asRepositoryName has to be the combination of CE domain name and ROS name. For example, myCEDomain.myROS.abCreate
- A boolean that indicates whether to create a new connector registration object if no existing object matches the given parameters.RMException
- In case of any error, an RMException will be thrown.public java.lang.String[] getFieldFromResultSet(java.lang.String asResultSet, java.lang.String asFieldName) throws RMException
_getFieldFromResultSet(String asResultSet, String asFieldName)
instead of this method.asResultSet
- The ResultSetXML StringasFieldName
- The field name to be retrievedRMException
- If any error occurs, an RMException is thrown.public static java.lang.String[] _getFieldFromResultSet(java.lang.String asResultSet, java.lang.String asFieldName) throws RMException
asResultSet
- The ResultSetXML StringasFieldName
- The field name to be retrievedRMException
- If any error occurs, an RMException is thrown.public int getCountFromResultSet(java.lang.String asResultSet) throws RMException
_getCountFromResultSet(String asResultSet)
instead of this method.asResultSet
- The ResultSetXML StringRMException
- If any error occurs, an RMException is thrown.public static int _getCountFromResultSet(java.lang.String asResultSet) throws RMException
asResultSet
- The ResultSetXML StringRMException
- If any error occurs, an RMException is thrown.public RMBulkOperationResults batchClose(com.filenet.wcm.api.BaseObjects aoBaseObjects, java.lang.String asReasonForClose) throws RMException
_batchClose(BaseObjects aoBaseObjects, String asReasonForClose)
instead of this method.aoBaseObjects
- Collection of base objectsasReasonForClose
- A string value specifying the reason for closing an RM entity.RMException
- If an error occurs, an RMException is thrown.public static RMBulkOperationResults _batchClose(com.filenet.wcm.api.BaseObjects aoBaseObjects, java.lang.String asReasonForClose) throws RMException
aoBaseObjects
- Collection of base objectsasReasonForClose
- A string value specifying the reason for closing an RM entity.RMException
- If an error occurs, an RMException is thrown.public RMBulkOperationResults batchReopen(boolean abReOpen, com.filenet.wcm.api.BaseObjects aoBaseObjects, java.lang.String asReasonForClose) throws RMException
_batchReopen(boolean abReOpen, BaseObjects aoBaseObjects, String asReasonForClose)
instead of this method.abReOpen
- true/false to reopen or close an entity.aoBaseObjects
- Collection of Baseobjects to be reopened.asReasonForClose
- A String value specifying reason for reopening an entity.RMException
- In case of any error, an RMException will be thrown.public static RMBulkOperationResults _batchReopen(boolean abReOpen, com.filenet.wcm.api.BaseObjects aoBaseObjects, java.lang.String asReasonForClose) throws RMException
abReOpen
- true/false to reopen or close an entity.aoBaseObjects
- Collection of Baseobjects to be reopened.asReasonForClose
- A String value specifying reason for reopening an entity.RMException
- In case of any error, an RMException will be thrown.public RMBulkOperationResults batchInactivate(boolean abIsInactive, RMObjectStore aoRMOS, com.filenet.wcm.api.BaseObjects aoBaseObjects, java.lang.String asReasonForInactivate) throws RMException
_batchInactivate(boolean abIsInactive, RMObjectStore aoRMOS, BaseObjects aoBaseObjects, String asReasonForInactivate)
instead of this method.abIsInactive
- true or false to inactivate or activate the current instance.aoRMOS
- This represents an instance of RMObjectStore.aoBaseObjects
- This represents the collection of baseobjects which need to be inactivated.asReasonForInactivate
- String specifying the reason for inactivation of base objects. The reason for the inactive state cannot be null, if a user intends
to inactivate the current instance.RMException
- If an error occurs, an RMException is thrown.public static RMBulkOperationResults _batchInactivate(boolean abIsInactive, RMObjectStore aoRMOS, com.filenet.wcm.api.BaseObjects aoBaseObjects, java.lang.String asReasonForInactivate) throws RMException
abIsInactive
- true or false to inactivate or activate the current instance.aoRMOS
- This represents an instance of RMObjectStore.aoBaseObjects
- This represents the collection of baseobjects which need to be inactivated.asReasonForInactivate
- String specifying the reason for inactivation of base objects. The reason for the inactive state cannot be null, if a user intends
to inactivate the current instance.RMException
- If an error occurs, an RMException is thrown.public boolean isAnyParentClosed(RMFolder aoRMFolder) throws RMException
_isAnyParentClosed(RMFolder aoRMFolder)
instead of this method.aoRMFolder
- The RMFolder whose parents' closed state is to be determined.RMException
- If an error occurs, an RMException is thrown.public static boolean _isAnyParentClosed(RMFolder aoRMFolder) throws RMException
aoRMFolder
- The RMFolder whose parents' closed state is to be determined.RMException
- If an error occurs, an RMException is thrown.public com.filenet.wcm.api.BatchResultItems bulkUpdateEntities(com.filenet.wcm.api.Session aoSession, com.filenet.wcm.api.BaseObjects aoEntitiestobeUpdated, com.filenet.wcm.api.Properties aoProperties, boolean abAsTransaction, boolean abDiscardResults, boolean abStopOnException)
_bulkUpdateEntities(Session aoSession,
BaseObjects aoEntitiestobeUpdated,
Properties aoProperties,
boolean abAsTransaction,
boolean abDiscardResults,
boolean abStopOnException)
instead of this method.aoSession
- The value of the CE Session object.aoEntitiestobeUpdated
- Collection of entities to be updated.aoProperties
- Property collection to be updated.abAsTransaction
- This parameter is ignored.abDiscardResults
- If true, result objects that would normally be returned
to the caller are simply discarded. If false, result objects are returned.abStopOnException
- If true, the remote server halts attempts to perform operations if any one operation returns an exception. An exception in this context means a condition that would normally result in an exception being thrown if the operations were not part of a batch.public static com.filenet.wcm.api.BatchResultItems _bulkUpdateEntities(com.filenet.wcm.api.Session aoSession, com.filenet.wcm.api.BaseObjects aoEntitiestobeUpdated, com.filenet.wcm.api.Properties aoProperties, boolean abAsTransaction, boolean abDiscardResults, boolean abStopOnException)
aoSession
- The value of the CE Session object.aoEntitiestobeUpdated
- Collection of entities to be updated.aoProperties
- Property collection to be updated.abAsTransaction
- This parameter is ignored.abDiscardResults
- If true, result objects that would normally be returned
to the caller are simply discarded. If false, result objects are returned.abStopOnException
- If true, the remote server halts attempts to perform operations if any one operation returns an exception. An exception in this context means a condition that would normally result in an exception being thrown if the operations were not part of a batch.public static java.lang.String checkNull(java.lang.String asString)
asString
- The string to be validatedpublic java.util.Map populateMap(java.lang.String asURL) throws RMException
_populateMap(String asURL)
instead of this method.asURL
- An XML StringRMException
- If an error occurs, an RMException is thrown.public static java.util.Map _populateMap(java.lang.String asURL) throws RMException
asURL
- An XML StringRMException
- If an error occurs, an RMException is thrown.public java.util.Map populateMap(org.w3c.dom.Document aoDocument) throws RMException
_populateMap(Document aoDocument)
instead of this method.aoDocument
- A Document object.RMException
- In case of any error, an RMException will be thrown.public static java.util.Map _populateMap(org.w3c.dom.Document aoDocument) throws RMException
aoDocument
- A Document object.RMException
- In case of any error, an RMException will be thrown.public static java.io.Reader getReader(java.lang.String asFilePathOrString, java.lang.String asReaderType, java.lang.String asEncoding) throws RMException
_getReader(String asFilePathOrString, String asReaderType)
instead of this method.asFilePathOrString
- The String content or the path of the file to be read.asReaderType
- String specifying the type of Reader to be initializedasEncoding,
- The encoding technique that will be used for the Reader object.
The encoding technique can be UTF-8, Unicode or ANSI etc.RMException
- In case of any error, an RMException will be raised.public java.io.Reader getReader(java.lang.String asFilePathOrString, java.lang.String asReaderType) throws RMException
_getReader(String asFilePathOrString, String asReaderType)
instead of this method.asFilePathOrString
- The String content or the path of the file to be read.asReaderType
- String specifying the type of Reader to be initializedRMException
- In case of any error, an RMException will be raised.public static java.io.Reader _getReader(java.lang.String asFilePathOrString, java.lang.String asReaderType) throws RMException
asFilePathOrString
- The String content or the path of the file to be read.asReaderType
- String specifying the type of Reader to be initializedRMException
- In case of any error, an RMException will be raised.public org.w3c.dom.Document createXMLdoc(org.xml.sax.InputSource aoSource) throws RMException
_createXMLdoc(InputSource aoSource)
instead of this method.aoSource
- An InputSource wrapped around the XML content.RMException
- If any error occurs, an RMException is raised.public static org.w3c.dom.Document _createXMLdoc(org.xml.sax.InputSource aoSource) throws RMException
aoSource
- An InputSource wrapped around the XML content.RMException
- If any error occurs, an RMException is raised.public org.w3c.dom.Document createXMLDoc(java.io.Reader aoReader) throws RMException
_createXMLDoc(Reader aoReader)
instead of this method.aoReader
- A Reader object obtained by reading the XML content.RMException
- If any error occurs, an RMException is raised.public static org.w3c.dom.Document _createXMLDoc(java.io.Reader aoReader) throws RMException
aoReader
- A Reader object obtained by reading the XML content.RMException
- If any error occurs, an RMException is raised.public org.w3c.dom.Document createXMLDoc(java.lang.String asString) throws RMException
_createXMLDoc(String asString)
instead of this method.asString
- A String wrapped around the XML content.RMException
- In case any error occurs, an RMException is raised.public static org.w3c.dom.Document _createXMLDoc(java.lang.String asString) throws RMException
asString
- A String wrapped around the XML content.RMException
- In case any error occurs, an RMException is raised.public org.w3c.dom.Document createXMLDoc(java.io.InputStream aoInputStream) throws RMException
_createXMLDoc(InputStream aoInputStream)
instead of this method.aoInputStream
- An InputStream wrapped around the XML content.RMException
- In case any error occurs, an RMException is raised.public static org.w3c.dom.Document _createXMLDoc(java.io.InputStream aoInputStream) throws RMException
aoInputStream
- An InputStream wrapped around the XML content.RMException
- In case any error occurs, an RMException is raised.public boolean doMultipleFilePlanExist(RMObjectStore aoRMObjectStore)
_doMultipleFilePlanExist(RMObjectStore aoRMObjectStore)
instead of this method.aoObjectStore
- An RMObjectStore where this check need to perform.public static boolean _doMultipleFilePlanExist(RMObjectStore aoRMObjectStore)
aoObjectStore
- An RMObjectStore where this check need to perform.public boolean useInSubFolder(RMObjectStore aoObjectStore, java.lang.String aoFolderPath)
public static boolean _useInSubFolder(RMObjectStore aoObjectStore, java.lang.String aoFolderPath)
public java.lang.String generateDocumentURI(RMObjectStore aoRMObjectStore, java.lang.String asURI) throws RMException
_generateDocumentURI(RMObjectStore aoRMObjectStore, String asURI)
instead of this method.aoRMObjectStore
- The object store where ConnectorRegistration existsasURI
- URI, XML String send by user to declare a DocumentRMException
- If any error occurs, an RMException is raised.public static java.lang.String _generateDocumentURI(RMObjectStore aoRMObjectStore, java.lang.String asURI) throws RMException
aoRMObjectStore
- The object store where ConnectorRegistration existsasURI
- URI, XML String send by user to declare a DocumentRMException
- If any error occurs, an RMException is raised.public com.filenet.wcm.api.CustomObject getRegistrationClass(RMObjectStore aoRMObjectStore, java.lang.String asRegistraionID) throws RMException
_getRegistrationClass(RMObjectStore aoRMObjectStore,
String asRegistraionID)
instead of this method.aoRMObjectStore
- The object store where ConnectorRegistration existsasRegistraionID
- The GUID of the ConnectorRegistration ObjectRMException
- If any error occurs, an RMException is raised.public static com.filenet.wcm.api.CustomObject _getRegistrationClass(RMObjectStore aoRMObjectStore, java.lang.String asRegistraionID) throws RMException
aoRMObjectStore
- The object store where ConnectorRegistration existsasRegistraionID
- The GUID of the ConnectorRegistration ObjectRMException
- If any error occurs, an RMException is raised.public com.filenet.wcm.api.CustomObject getConnectorRegistrationClass(RMObjectStore aoRMObjectStore, java.lang.String asQuerySQL) throws RMException
_getConnectorRegistrationClass(RMObjectStore
aoRMObjectStore,
String asQuerySQL
)
instead of this method.aoRMObjectStore
- The object store where ConnectorRegistration existsasQuerySQL
- The SQL StringRMException
- If any error occurs, an RMException is raised.public static com.filenet.wcm.api.CustomObject _getConnectorRegistrationClass(RMObjectStore aoRMObjectStore, java.lang.String asQuerySQL) throws RMException
aoRMObjectStore
- The object store where ConnectorRegistration existsasQuerySQL
- The SQL StringRMException
- If any error occurs, an RMException is raised.public java.lang.String getResultSet(RMObjectStore aoRMObjectStore, java.lang.String asQuerySQL) throws RMException
_getResultSet(RMObjectStore aoRMObjectStore, String asQuerySQL)
instead of this method.aoRMObjectStore
- The RM object store where a query is to be executed.asQuerySQL
- The Sql query String.RMException
- In case of any error, an RMException will be raised.public static java.lang.String _getResultSet(RMObjectStore aoRMObjectStore, java.lang.String asQuerySQL) throws RMException
aoRMObjectStore
- The RM object store where a query is to be executed.asQuerySQL
- The Sql query String.RMException
- In case of any error, an RMException will be raised.public java.lang.String getLimitedResultSet(RMObjectStore aoRMObjectStore, java.lang.String asQuerySQL, int aiMaxRecords) throws RMException
_getLimitedResultSet(RMObjectStore aoRMObjectStore,
String asQuerySQL, int aiMaxRecords)
instead of this method.aoRMObjectStore
- The RM object store where a query is to be executed.asQuerySQL
- The Sql query String.aiMaxRecords
- Limits the result set to be returned by the sql query.RMException
- In case of any error, an RMException will be raised.public static java.lang.String _getLimitedResultSet(RMObjectStore aoRMObjectStore, java.lang.String asQuerySQL, int aiMaxRecords) throws RMException
aoRMObjectStore
- The RM object store where a query is to be executed.asQuerySQL
- The Sql query String.aiMaxRecords
- Limits the result set to be returned by the sql query.RMException
- In case of any error, an RMException will be raised.public java.lang.String getResultSet(RMObjectStore aoRMObjectStore, java.lang.String asQuerySQL, int aiBaseType) throws RMException
_getResultSet(RMObjectStore aoRMObjectStore, String asQuerySQL,
int aiBaseType)
instead of this method.aoRMObjectStore
- The RM ObjectStore where a query is to be executed.asQuerySQL
- The Sql query String.aiBaseType
- An int value that represents the base object type to be searched.RMException
- In case of any error, an RMException will be raised.public static java.lang.String _getResultSet(RMObjectStore aoRMObjectStore, java.lang.String asQuerySQL, int aiBaseType) throws RMException
aoRMObjectStore
- The RM ObjectStore where a query is to be executed.asQuerySQL
- The Sql query String.aiBaseType
- An int value that represents the base object type to be searched.RMException
- In case of any error, an RMException will be raised.public java.lang.String getResultSet(RMObjectStore aoRMObjectStore, java.lang.String asQuerySQL, int aiBaseType, int aiMaxResults) throws RMException
_getResultSet(RMObjectStore aoRMObjectStore, String asQuerySQL,
int aiBaseType, int aiMaxResults)
instead of this method.aoRMObjectStore
- The RM object store where a query is to be executed.asQuerySQL
- The Sql query String.aiBaseType
- An int that represents the base object type to be searched.aiMaxResults
- Limits the result set to be returned by the sql query.RMException
- In case of any error, an RMException will be raised.public static java.lang.String _getResultSet(RMObjectStore aoRMObjectStore, java.lang.String asQuerySQL, int aiBaseType, int aiMaxResults) throws RMException
aoRMObjectStore
- The RM object store where a query is to be executed.asQuerySQL
- The Sql query String.aiBaseType
- An int that represents the base object type to be searched.aiMaxResults
- Limits the result set to be returned by the sql query.RMException
- In case of any error, an RMException will be raised.public java.lang.String getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore, java.lang.String asQuerySQL, int aiBaseType) throws RMException
_getResultSet(ObjectStore aoObjectStore, String asQuerySQL,
int aiBaseType)
instead of this method.aoObjectStore
- The object store where a query is to be executed.asQuerySQL
- The Sql query StringaiBaseType
- An int that represents the base object type to be searched.RMException
- In case of any error, an RMException will be raised.public static java.lang.String _getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore, java.lang.String asQuerySQL, int aiBaseType) throws RMException
aoObjectStore
- The object store where a query is to be executed.asQuerySQL
- The Sql query StringaiBaseType
- An int that represents the base object type to be searched.RMException
- In case of any error, an RMException will be raised.public java.lang.String getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore, java.lang.String asQuerySQL, int aiBaseType, int aiMaxResults) throws RMException
_getResultSet(ObjectStore aoObjectStore, String asQuerySQL,
int aiBaseType, int aiMaxResults)
instead of this method.aoObjectStore
- The object store where a query is to be executed.asQuerySQL
- The Sql query String.aiBaseType
- An int that represents the base object type to be searched.aiMaxResults
- Limits the result set to be returned by the sql query.RMException
- In case of any error, an RMException will be raised.public static java.lang.String _getResultSet(com.filenet.wcm.api.ObjectStore aoObjectStore, java.lang.String asQuerySQL, int aiBaseType, int aiMaxResults) throws RMException
aoObjectStore
- The object store where a query is to be executed.asQuerySQL
- The Sql query String.aiBaseType
- An int that represents the base object type to be searched.aiMaxResults
- Limits the result set to be returned by the sql query.RMException
- In case of any error, an RMException will be raised.public com.filenet.wcm.api.BaseObjects getQueriedObjects(RMObjectStore aoRMObjectStore, java.lang.String asQuerySQL, int aiBaseType) throws RMException
_getQueriedObjects(RMObjectStore aoRMObjectStore,
String asQuerySQL, int aiBaseType)
instead of this method.aoRMObjectStore
- The RM object store where a query is to be executed.asQuerySQL
- The Sql query String.aiBaseType
- An int that represents the base object type to be searched.RMException
- In case of any error, an RMException will be raised.public static com.filenet.wcm.api.BaseObjects _getQueriedObjects(RMObjectStore aoRMObjectStore, java.lang.String asQuerySQL, int aiBaseType) throws RMException
aoRMObjectStore
- The RM object store where a query is to be executed.asQuerySQL
- The Sql query String.aiBaseType
- An int that represents the base object type to be searched.RMException
- In case of any error, an RMException will be raised.public com.filenet.wcm.api.BaseObjects getQueriedObjects(RMObjectStore aoRMObjectStore, java.lang.String asQuerySQL, int aiBaseType, int aiMaxResult) throws RMException
_getQueriedObjects(RMObjectStore aoRMObjectStore,
String asQuerySQL, int aiBaseType,
int aiMaxResult
)
instead of this method.aoRMObjectStore
- The RM object store where a query is to be executed.asQuerySQL
- The Sql query String.aiBaseType
- An int that representing the base object type to be searched.aiMaxResult
- Limits the result set to be returned by the sql query.RMException
- In case of any error, an RMException will be thrown.public static com.filenet.wcm.api.BaseObjects _getQueriedObjects(RMObjectStore aoRMObjectStore, java.lang.String asQuerySQL, int aiBaseType, int aiMaxResult) throws RMException
aoRMObjectStore
- The RM object store where a query is to be executed.asQuerySQL
- The Sql query String.aiBaseType
- An int that representing the base object type to be searched.aiMaxResult
- Limits the result set to be returned by the sql query.RMException
- In case of any error, an RMException will be thrown.public java.lang.String getRecordURI(RMObjectStore aoRMObjectStore, java.lang.String asRecordId) throws RMException
_getRecordURI(RMObjectStore aoRMObjectStore, String asRecordId)
instead of this method.aoRMObjectStore
- The object store where a record is to be found.asRecordId
- The ID of a record to be added.RMException
- If any error occurs, an RMException is thrown.public static java.lang.String _getRecordURI(RMObjectStore aoRMObjectStore, java.lang.String asRecordId) throws RMException
aoRMObjectStore
- The object store where a record is to be found.asRecordId
- The ID of a record to be added.RMException
- If any error occurs, an RMException is thrown.public java.lang.String writeXML(org.w3c.dom.Node aoNode) throws RMException
_writeXML(Node aoNode)
instead of this method.aoNode
- The Node object to be obtained as string.RMException
- If any error occurs, an RMException is thrown.public static java.lang.String _writeXML(org.w3c.dom.Node aoNode) throws RMException
aoNode
- The Node object to be obtained as string.RMException
- If any error occurs, an RMException is thrown.public boolean checkPattern(java.lang.String asBaseName, java.lang.String asPattern)
_checkPattern(String asBaseName, String asPattern)
instead of this method.asBaseName
- The base name to be validatedasPattern
- The pattern on which the base name is to be validatedpublic static boolean _checkPattern(java.lang.String asBaseName, java.lang.String asPattern)
asBaseName
- The base name to be validatedasPattern
- The pattern on which the base name is to be validatedpublic RecordInfo locateRecord(java.lang.String asURI) throws RMException
_locateRecord(String asURI)
instead of this method.asURI
- An XML URI string that contains record specific information. It must be in valid XML as specified by the Record URI XMl format.RMException
- if any error occurs, an RMException is thrown.public static RecordInfo _locateRecord(java.lang.String asURI) throws RMException
asURI
- An XML URI string that contains record specific information. It must be in valid XML as specified by the Record URI XMl format.RMException
- if any error occurs, an RMException is thrown.public java.lang.String[] getClassIDs(RMObjectStore aoRMObjectStore, int[] aiEntityTypes, boolean abInculdeSubClasses) throws RMException
_getClassIDs(RMObjectStore aoRMObjectStore,
int[] aiEntityTypes,
boolean abInculdeSubClasses
)
instead of this method.aoRMObjectStore
- The RMObjectStore where Classes are definedaiEntityTypes
- An int array of entities whose GUIDs are to be retrievedabInculdeSubClasses
- A boolean flag to indicate whether subclasses are to be includedRMException
- If any error occurs, an RMException is thrown.public static java.lang.String[] _getClassIDs(RMObjectStore aoRMObjectStore, int[] aiEntityTypes, boolean abInculdeSubClasses) throws RMException
aoRMObjectStore
- The RMObjectStore where Classes are definedaiEntityTypes
- An int array of entities whose GUIDs are to be retrievedabInculdeSubClasses
- A boolean flag to indicate whether subclasses are to be includedRMException
- If any error occurs, an RMException is thrown.public com.filenet.wcm.api.ClassDescriptions getClassDescriptions(RMObjectStore aoRMObjectStore, int[] aiEntityTypes, boolean abInculdeSubClasses) throws RMException
_getClassDescriptions(RMObjectStore aoRMObjectStore,
int[] aiEntityTypes,
boolean abInculdeSubClasses
)
instead of this method.aoRMObjectStore
- The RMObjectStore from where ClassDescriptions are to be retrieved.aiEntityTypes
- An int array of RM types. The collection of the ClassDescription of those RM types is to be fetched.abInculdeSubClasses
- A boolean flag to indicate whether subclasses are to be included.RMException
- If any error occurs, an RMException is thrown.public static com.filenet.wcm.api.ClassDescriptions _getClassDescriptions(RMObjectStore aoRMObjectStore, int[] aiEntityTypes, boolean abInculdeSubClasses) throws RMException
aoRMObjectStore
- The RMObjectStore from where ClassDescriptions are to be retrieved.aiEntityTypes
- An int array of RM types. The collection of the ClassDescription of those RM types is to be fetched.abInculdeSubClasses
- A boolean flag to indicate whether subclasses are to be included.RMException
- If any error occurs, an RMException is thrown.public java.lang.String getClassDescriptionsXML(RMObjectStore aoRMObjectStore, int[] aiEntityTypes, boolean abInculdeSubClasses) throws RMException
_getClassDescriptionsXML(RMObjectStore aoRMObjectStore,
int[] aiEntityTypes,
boolean abInculdeSubClasses
)
instead of this method.aoRMObjectStore
- The RMObjectStore from where ClassDescriptions are
to be retrieved.aiEntityTypes
- An int array of RM types. The collection of the ClassDescription of those RM types is to be fetched.abInculdeSubClasses
- A boolean flag to indicate whether subclasses are to be included.RMException
- If any error occurs, an RMException is thrown.public static java.lang.String _getClassDescriptionsXML(RMObjectStore aoRMObjectStore, int[] aiEntityTypes, boolean abInculdeSubClasses) throws RMException
aoRMObjectStore
- The RMObjectStore from where ClassDescriptions are
to be retrieved.aiEntityTypes
- An int array of RM types. The collection of the ClassDescription of those RM types is to be fetched.abInculdeSubClasses
- A boolean flag to indicate whether subclasses are to be included.RMException
- If any error occurs, an RMException is thrown.public java.lang.String getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription, java.lang.String asFilterType) throws RMException
_getPropertyDescriptionXML(ClassDescription aoClassDescription,
String asFilterType)
instead of this method.aoClassDescription
- The ClassDescription whose property descriptions need to be retrievedasFilterType
- The string representing the type of PropertyDescription.RMException
- If an error occurs, an RMException is thrown.public static java.lang.String _getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription, java.lang.String asFilterType) throws RMException
aoClassDescription
- The ClassDescription whose property descriptions need to be retrievedasFilterType
- The string representing the type of PropertyDescription.RMException
- If an error occurs, an RMException is thrown.public java.lang.String getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription, java.lang.String asFilterType, RMRecordContainer aoContainer) throws RMException
_getPropertyDescriptionXML(ClassDescription aoClassDescription,
String asFilterType,
RMRecordContainer aoContainer
)
instead of this method.aoClassDescription
- The ClassDescription whose property descriptions need to be retrievedasFilterType
- The string representing the type of PropertyDescription.aoContainer
- The RecordContainer on which the Record Pattern has been applied.RMException
- If an error occurs, an RMException is thrown.public static java.lang.String _getPropertyDescriptionXML(com.filenet.wcm.api.ClassDescription aoClassDescription, java.lang.String asFilterType, RMRecordContainer aoContainer) throws RMException
aoClassDescription
- The ClassDescription whose property descriptions need to be retrievedasFilterType
- The string representing the type of PropertyDescription.aoContainer
- The RecordContainer on which the Record Pattern has been applied.RMException
- If an error occurs, an RMException is thrown.public com.filenet.wcm.api.PropertyDescriptions getPropertyDescriptions(com.filenet.wcm.api.ClassDescription aoClassDescription, java.lang.String asFilterType) throws RMException
_getPropertyDescriptions(ClassDescription
aoClassDescription,
String asFilterType
)
instead of this method.aoClassDescription
- A ClassDescriptions collection containing the ClassDescription objects for which
PropertyDescription objects are requested.asFilterType
- The string representing the type of PropertyDescriptionRMException
- If an error occurs, an RMException is thrown.public static com.filenet.wcm.api.PropertyDescriptions _getPropertyDescriptions(com.filenet.wcm.api.ClassDescription aoClassDescription, java.lang.String asFilterType) throws RMException
aoClassDescription
- A ClassDescriptions collection containing the ClassDescription objects for which
PropertyDescription objects are requested.asFilterType
- The string representing the type of PropertyDescriptionRMException
- If an error occurs, an RMException is thrown.public java.lang.String addNode(java.lang.String asURI, java.lang.String asKeyName, java.lang.String asValue) throws RMException
_addNode(String asURI, String asKeyName, String asValue)
instead of this method.asURI
- The XML String to be modifiedasKeyName
- The name of the node to be addedasValue
- The value of the node to be addedRMException
public static java.lang.String _addNode(java.lang.String asURI, java.lang.String asKeyName, java.lang.String asValue) throws RMException
asURI
- The XML String to be modifiedasKeyName
- The name of the node to be addedasValue
- The value of the node to be addedRMException
public java.lang.String addNode(java.lang.String asURI, java.util.Map aoMap) throws RMException
_addNode(String asURI, Map aoMap)
instead of this method.asURI
- The XML String to be modifiedaoMap
- The map containing the keys to be addedRMException
- If an error occurs, an RMException is thrown.public static java.lang.String _addNode(java.lang.String asURI, java.util.Map aoMap) throws RMException
asURI
- The XML String to be modifiedaoMap
- The map containing the keys to be addedRMException
- If an error occurs, an RMException is thrown.public java.lang.String removeNode(java.lang.String asURI, java.lang.String asKeyName) throws RMException
_removeNode(String asURI, String asKeyName)
instead of this method.asURI
- The XML String to be modifiedasKeyName
- The name of the node to be removedRMException
- If an error occurs, an RMException is thrown.public static java.lang.String _removeNode(java.lang.String asURI, java.lang.String asKeyName) throws RMException
asURI
- The XML String to be modifiedasKeyName
- The name of the node to be removedRMException
- If an error occurs, an RMException is thrown.public boolean validateDate(java.lang.String asDate, java.lang.String asFormat)
_validateDate(String asDate, String asFormat)
instead of this method.asDate
- The String value for dateasFormat
- The String representing the formatpublic static boolean _validateDate(java.lang.String asDate, java.lang.String asFormat)
asDate
- The String value for dateasFormat
- The String representing the formatpublic java.util.Collection getCollection(java.lang.String[] asArrString) throws RMException
_getCollection(String[] asArrString)
instead of this method.asArrString
- A StringArrayRMException
- If an error occurs, an RMException is thrown.public static java.util.Collection _getCollection(java.lang.String[] asArrString) throws RMException
asArrString
- A StringArrayRMException
- If an error occurs, an RMException is thrown.public java.lang.String getUserId(RMObjectStore aoRMObjectStore) throws RMException
_getUserId(RMObjectStore aoRMObjectStore)
instead of this method.aoRMObjectStore
- The RMObjectStore to which a user is logged on.RMException
- If an error occurs, an RMException is thrown.public static java.lang.String getUsernameFromFullName(java.lang.String fullName)
fullName.
- For Tivoli, the credential will return the username in "uid=Administrator,ou=FileNet,dc=hqpsidcdom,dc=com" format.public static java.lang.String _getUserId(RMObjectStore rmObjStore) throws RMException
rmObjStore
- The RMObjectStore to extract a Buzz Session from.RMException
public java.lang.String getUserIdWithDomain(RMObjectStore aoRMObjectStore) throws RMException
_getUserIdWithDomain(RMObjectStore aoRMObjectStore)
instead of this method.aoRMObjectStore
- The RMObjectStore to which a user is logged on.RMException
- If an error occurs, an RMException is thrown.public static java.lang.String _getUserIdWithDomain(RMObjectStore aoRMObjectStore) throws RMException
aoRMObjectStore
- The RMObjectStore to which a user is logged on.RMException
- If an error occurs, an RMException is thrown.public java.lang.String getObjectStoreXML(com.filenet.wcm.api.ObjectStores aoObjectStores)
_getObjectStoreXML(ObjectStores aoObjectStores)
instead of this method.aoObjectStores
- An ObjectStore collectionpublic static java.lang.String _getObjectStoreXML(com.filenet.wcm.api.ObjectStores aoObjectStores)
aoObjectStores
- An ObjectStore collectionpublic java.lang.String getObjectStoreXML(com.filenet.wcm.api.ObjectStores aoObjectStores, java.lang.String[] asArrProps)
_getObjectStoreXML(ObjectStores aoObjectStores,
String[] asArrProps)
instead of this method.aoObjectStores
- An ObjectStore collection.asArrProps
- A String array whose elements specify the symbolic names of the properties to return.public static java.lang.String _getObjectStoreXML(com.filenet.wcm.api.ObjectStores aoObjectStores, java.lang.String[] asArrProps)
aoObjectStores
- An ObjectStore collection.asArrProps
- A String array whose elements specify the symbolic names of the properties to return.public RMObjectStore getRMObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore) throws RMException
_getRMObjectStore(ObjectStore aoObjectStore)
instead of this method.aoObjectStore
- The object store for which the RMobjectStore handle is to be obtained.RMException
- if object is not a valid FPOS, an RMException is thrown.public static RMObjectStore _getRMObjectStore(com.filenet.wcm.api.ObjectStore aoObjectStore) throws RMException
aoObjectStore
- The object store for which the RMobjectStore handle is to be obtained.RMException
- if object is not a valid FPOS, an RMException is thrown.public java.lang.String getConnectorQueryString(java.lang.String asRepositoryType, java.lang.String asRepositoryName, java.lang.String asServerName)
_getConnectorQueryString(String asRepositoryType,
String asRepositoryName,
String asServerName
)
instead of this method.asRepositoryType
- A String that represents the documents repository type.
For this release it can only be CE.asServerName
- A String that represents the documents repository server URL.
If the asRepositoryType is CE, asServerName has to be the remote server URL of CE.
For this release this variable will be ignored in this method, so you can pass in null value.asRepositoryName
- A String that represents the records repository domain name and the ROS name. If the asRepositoryType is CE,
the asRepositoryName has to be the combination of CE domain name and ROS name. For example, myCEDomain.myROS.public static java.lang.String _getConnectorQueryString(java.lang.String asRepositoryType, java.lang.String asRepositoryName, java.lang.String asServerName)
asRepositoryType
- A String that represents the documents repository type.
For this release it can only be CE.asServerName
- A String that represents the documents repository server URL.
If the asRepositoryType is CE, asServerName has to be the remote server URL of CE.
For this release this variable will be ignored in this method, so you can pass in null value.asRepositoryName
- A String that represents the records repository domain name and the ROS name. If the asRepositoryType is CE,
the asRepositoryName has to be the combination of CE domain name and ROS name. For example, myCEDomain.myROS.public java.lang.String getMergedXML(java.lang.String aoReaderXMLIDCheck, java.lang.String aoReaderXMLToBeReplaced, java.lang.String aoXSLFile)
_getMergedXML(String aoReaderXMLIDCheck,
String aoReaderXMLToBeReplaced,
String aoXSLFile
)
instead of this method.aoReaderXMLIDCheck
- An XML document in String format on which the XSLT transformation is to be invoked.aoReaderXMLToBeReplaced
- An XML document in String format to be used in the XSLT transformation and is passed as a parameter to the transformer.aoXSLFile
- The XSL file name with path, which signifies the transformation to be applied.public static java.lang.String _getMergedXML(java.lang.String aoReaderXMLIDCheck, java.lang.String aoReaderXMLToBeReplaced, java.lang.String aoXSLFile)
aoReaderXMLIDCheck
- An XML document in String format on which the XSLT transformation is to be invoked.aoReaderXMLToBeReplaced
- An XML document in String format to be used in the XSLT transformation and is passed as a parameter to the transformer.aoXSLFile
- The XSL file name with path, which signifies the transformation to be applied.public com.filenet.wcm.api.BaseObjects getMerged(java.util.ArrayList aoIDCheck, com.filenet.wcm.api.BaseObjects aoToBeReplacedRecord)
_getMerged(ArrayList aoIDCheck,
BaseObjects aoToBeReplacedRecord)
instead of this method.aoIDCheck
- An array list containing the record IDs.aoToBeReplacedRecord
- BaseObjects A collection that needs to be filtered for those documents that are not present in aoIDCheck.public static com.filenet.wcm.api.BaseObjects _getMerged(java.util.ArrayList aoIDCheck, com.filenet.wcm.api.BaseObjects aoToBeReplacedRecord)
aoIDCheck
- An array list containing the record IDs.aoToBeReplacedRecord
- BaseObjects A collection that needs to be filtered for those documents that are not present in aoIDCheck.public java.util.ArrayList getMergedROSOR(java.util.ArrayList aoRecordID1, java.util.ArrayList aoRecordID2)
_getMergedROSOR(ArrayList aoRecordID1, ArrayList aoRecordID2)
instead of this method.aoRecordID1
- A collection that contains the record IDs.aoRecordID2
- A collection that contains the record IDs.public static java.util.ArrayList _getMergedROSOR(java.util.ArrayList aoRecordID1, java.util.ArrayList aoRecordID2)
aoRecordID1
- A collection that contains the record IDs.aoRecordID2
- A collection that contains the record IDs.public org.w3c.dom.Document getNewDocument() throws javax.xml.parsers.ParserConfigurationException
_getNewDocument()
instead of this method.javax.xml.parsers.ParserConfigurationException
- if an error occurs, the ParserConfigurationException is thrown.public static org.w3c.dom.Document _getNewDocument() throws javax.xml.parsers.ParserConfigurationException
javax.xml.parsers.ParserConfigurationException
- if an error occurs, the ParserConfigurationException is thrown.public DocumentStore getDocumentStore(java.lang.Object aoObject) throws RMException
_getDocumentStore(Object aoObject)
instead of this method.aoObject
- The object store for which the DocumentStore handle
is to be obtained.RMException
- In case of any error an RMException will be thrown.public static DocumentStore _getDocumentStore(java.lang.Object aoObject) throws RMException
aoObject
- The object store for which the DocumentStore handle
is to be obtained.RMException
- In case of any error an RMException will be thrown.public void auditEvent(RMObject aoRMObject, java.lang.String asReason, java.lang.String asActionType, java.lang.String asDescription, java.lang.String asLastReviewedBy, int aiEventStatus)
_auditEvent(RMObject aoRMObject, String asReason, String asActionType, String asDescription, String asLastReviewedBy, int aiEventStatus)
instead of this method.aoRMObject
- An RMObject with which an Audit is to be associated.asReason
- Reason for the Audit action performed.asActionType
- Type of audit action performed. The action type can be Review, Relocate, Export, Transfer, Interim Transfer, Delete or Destroy.asDescription
- A String that represents the description for the audit operation.public static void _auditEvent(RMObject aoRMObject, java.lang.String asReason, java.lang.String asActionType, java.lang.String asDescription, java.lang.String asLastReviewedBy, int aiEventStatus)
aoRMObject
- An RMObject with which an Audit is to be associated.asReason
- Reason for the Audit action performed.asActionType
- Type of audit action performed. The action type can be Review, Relocate, Export, Transfer, Interim Transfer, Delete or Destroy.asDescription
- A String that represents the description for the audit operation.public void validateDisposition(DisposableObject aoDisposableObject)
_validateDisposition(DisposableObject aoDisposableObject)
instead of this method.aoDisposableObject
- A DisposableObject object on which disposition is
to be initiated.public static void _validateDisposition(DisposableObject aoDisposableObject)
aoDisposableObject
- A DisposableObject object on which disposition is
to be initiated.public static java.lang.String getFormattedString(java.lang.String asStringValue)
asStringValue
- String which is to be formattedpublic static java.lang.String DecodeFormattedString(java.lang.String asStringValue)
asStringValue
- String which is to be decoded.public static java.lang.String replaceAll(java.lang.String acSpecialCh, java.lang.String asReplaceBy, java.lang.String asMainStr)
acSpecialCh
- String reperesenting characters to be replaced.asReplaceBy
- String reperesenting new characters to be replaced with.asMainStr
- String on which the action is to be performed.public java.util.Date getCurrentPhaseExecutionDate(DisposableObject aoRMObject)
_getCurrentPhaseExecutionDate(DisposableObject aoRMObject)
instead of this method.aoRMObject
- DisposableObject An entity for which the current phase execution date is to be calculated.public static java.util.Date _getCurrentPhaseExecutionDate(DisposableObject aoRMObject)
aoRMObject
- DisposableObject An entity for which the current phase execution date is to be calculated.public DispositionAllocatableObject getActingDisposalSchedule(RMObject aoRMObject)
_getActingDisposalSchedule(RMObject aoRMObject)
instead of this method.aoRMObject
- An entity for which DispositionAllocatableObject is to be fetched.public static DispositionAllocatableObject _getActingDisposalSchedule(RMObject aoRMObject)
aoRMObject
- An entity for which DispositionAllocatableObject is to be fetched.public java.util.Date addToDate(java.util.Date aoBaseDate, int aiYear, int aiMonth, int aiDay)
_addToDate(Date aoBaseDate, int aiYear, int aiMonth, int aiDay)
instead of this method.aoBaseDate
- The base date to which time is to be addedaiYear
- Years to be addedaiMonth
- Months to be addedaiDay
- Days to be addedpublic static java.util.Date _addToDate(java.util.Date aoBaseDate, int aiYear, int aiMonth, int aiDay)
aoBaseDate
- The base date to which time is to be addedaiYear
- Years to be addedaiMonth
- Months to be addedaiDay
- Days to be addedpublic static java.util.Date settingTimeComponentasZero(java.util.Date aoDate)
aoDate
- The date to be modifiedpublic static java.util.Vector _getAllDateProperties(RMObjectStore aoRMObjectStore)
aoRMObjectStore
- An RMObjectStorepublic void addRMLog(RMObjectStore aoRMObjectStore, com.filenet.wcm.api.Properties aoProps, com.filenet.wcm.api.Permissions aoPermissions)
_addRMLog(RMObjectStore aoRMObjectStore, Properties aoProps, Permissions aoPermissions)
instead of this method.aoRMObjectStore
- An RM object store in which an RMLog object is to be created.aoProps
- The properties collection for the object to be created.aoPermissions
- The permissions collection for the object to be created.public static void _addRMLog(RMObjectStore aoRMObjectStore, com.filenet.wcm.api.Properties aoProps, com.filenet.wcm.api.Permissions aoPermissions)
aoRMObjectStore
- An RM object store in which an RMLog object is to be created.aoProps
- The properties collection for the object to be created.aoPermissions
- The permissions collection for the object to be created.public static final java.lang.String toStringFromStringArray(java.lang.String[] asArrString)
asArrString
- String Array containing string elements.public java.lang.String addPropertiestoSearchXml(java.lang.String asSearchXml, java.lang.String[] asSymbolicName, java.lang.String lsClass)
_addPropertiestoSearchXml(String asSearchXml, String[] asSymbolicName, String lsClass)
instead of this method.asSearchXml
- An XML String representation of the values that a user provides at runtime prior to executing the search.asSymbolicName
- Symbolic name of the properties to be added in the exeselectprops tag of the asSearchXml.lsClass
- lsClass can be either ‘document’ or ‘folder’.public static java.lang.String _addPropertiestoSearchXml(java.lang.String asSearchXml, java.lang.String[] asSymbolicName, java.lang.String lsClass)
asSearchXml
- An XML String representation of the values that a user provides at runtime prior to executing the search.asSymbolicName
- Symbolic name of the properties to be added in the exeselectprops tag of the asSearchXml.lsClass
- lsClass can be either ‘document’ or ‘folder’.public static java.lang.String getPreviewListingOfEntites(RMObjectStore aoRMObjectStore, java.lang.String[] asSelectClauseProperty, java.lang.String asConditionXML, java.lang.String asFilterCriteria, int aiMaxRecords)
aoRMObjectStore,
- A FPOS where asConditionXML is executed.asConditionXML,
- The ConditionXML can contain the tag of only one of the Entity. The entity can be either RecordCategory,RecordFolder,Volume or Record.
All date type property values should be in the w3c format.asFilterCriteria,
- A extra clause in the Query is Added.aiMaxRecords,
- The maximum number of objects returned.asSelectClauseProperty,
- String array that contain the extra properties need to be specified in the select clause of query.public static java.lang.String getModifiedConditionXML(RMObjectStore aoRMObjectStore, java.lang.String asConditionXML)
aoRMObjectStore,
- A FPOS where asConditionXML is executed.asConditionXML,
- The ConditionXML can contain one or more Aggregation tag.
All date type property values should be in the w3c format.public int getCountFromSingleObjectType(java.lang.String asResultSet)
_getCountFromSingleObjectType(String asResultSet)
instead of this method.asResultSet,
- The string value represents the ResultSetpublic static int _getCountFromSingleObjectType(java.lang.String asResultSet)
asResultSet,
- The string value represents the ResultSetpublic void validateDestination(RMRecordContainer aoDestination, RecordInfo loRecord) throws RMException
RMException
public static void _validateDestination(RMRecordContainer aoDestination, RecordInfo loRecord) throws RMException
RMException
public boolean containsValue(int[] aiArrValue, int aiValue)
public static boolean _containsValue(int[] aiArrValue, int aiValue)
public RMBulkOperationResults batchFile(com.filenet.wcm.api.BaseObjects aoBaseObjects, RMRecordContainer aoRecordContainer) throws RMException
RMException
public static java.lang.String replaceALLInstance(java.lang.String asFindStr, java.lang.String asReplaceBy, java.lang.String asMainStr)
asFindStr,
- The string value to be searched in the main string.asReplaceBy,
- The string value to be replaced in the main string.asMainStr,
- The main string in which all the occurance of asFindStr is replaced by the asReplaceBy value.public static RMBulkOperationResults _batchFile(com.filenet.wcm.api.BaseObjects aoBaseObjects, RMRecordContainer aoRecordContainer) throws RMException
RMException
public static void tranferPhaseWithoutAction(RMObjectStore aoRMObjectStore, RMObject aoObject) throws RMException
aoRMObjectStore
- RMObjectStoreaoObject
- RMObject which have all the disposition data without Current Phase Action.RMException
- throws Exception in case any problem.public com.filenet.wcm.api.ObjectStore getROSObjectStore(RecordInfo loInfo, com.filenet.wcm.api.Session sess)
public static com.filenet.wcm.api.ObjectStores getAllObjectStores(com.filenet.wcm.api.EntireNetwork loEntireNetwork)
loEntireNetwork
- an instantiated EntireNetwork Objectpublic static java.lang.String getAllObjectStoresXML(com.filenet.wcm.api.EntireNetwork loEntireNetwork, java.lang.String[] propNames)
loEntireNetwork
- an instantiated EntireNetwork ObjectpropNames
- the property names used to retrieve the appropiate values of the objectorespublic static java.util.Locale getLocale(com.filenet.wcm.api.Session session)
session
- - a Session Objectpublic static com.filenet.api.core.Connection getCEConnection(com.filenet.wcm.api.Session session)
session
- java.lang.Exception
public static java.util.Map getAllImplementataions(RMObjectStore aoRMObjectStore)
public static java.lang.String getConnectorSearchURL(RMObjectStore aoRMObjectStore, java.lang.String asRMConn, java.util.Map aoImplClassMap)
asRMConn
- A String that contains the implementation class name for which the search Url needs to be createdaoImplClassMap
- A Map object that holds the implementation class name as the key and the value contains the ArrayList that in turn contains the set of the parameters like Repository name, server name and the repository typepublic static java.lang.String[] GetROSURL(org.w3c.dom.NodeList loURLNode)
public static java.util.List getAllAssociatedROS(RMObjectStore rmFPOS)
© Copyright IBM Corp. 2003, 2013. All Rights Reserved.