public interface IDfXMLUtils
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getApplication(java.lang.String applicationName,
boolean returnSingleApp)
Deprecated.
DFC 5.2
|
java.lang.String |
getApplicationByDTD(java.lang.String dtdSystemId,
java.lang.String dtdPublicId,
java.lang.String namespace,
java.lang.String rootElement,
boolean returnSingleApp)
Deprecated.
DFC 5.2.
|
IDfList |
getApplicationList(IDfXMLDocType doctype)
Returns a list strings containing object IDs and object names.
|
IDfList |
getApplicationList(IDfXMLDocType doctype,
IDfFile file)
Returns a list strings containing object IDs and object names.
|
IDfList |
getApplicationList(IDfXMLDocType doctype,
IDfFormat formatObj)
Returns a list strings containing object IDs and object names.
|
IDfList |
getApplicationList(IDfXMLDocType doctype,
IDfSysObject object)
Returns a list strings containing object IDs and object names.
|
IDfList |
getApplicationList(IDfXMLDocType doctype,
java.lang.String fileOrFormatName)
Returns a list strings containing object IDs and object names.
|
IDfList |
getApplicationList(java.lang.String applicationName)
Return a list of object IDs.
|
IDfList |
getApplicationListByDTD(java.lang.String dtdSystemId,
java.lang.String dtdPublicId,
java.lang.String namespace,
java.lang.String rootElement,
boolean returnSingleApp)
Deprecated.
DFC 5.2
|
IDfId |
getObjectIdFromDRL(java.lang.String drl)
Returns the object id corresponding to the DRL.
|
IDfList |
getObjectTypes(java.lang.String xmlApplication)
getObjectTypes - RESERVED FOR FUTURE USE.
|
IDfXMLDocType |
getXMLDoctypeFromFile(java.lang.String filename)
Returns an IDfXMLDocType which encapsulates information from the given XML document: public ID, system ID,
schemaLocation, root element and XML application (if a processing instruction was found that indicates the XML application.
|
IDfList |
getZones(java.lang.String xmlApplication)
getZones - RESERVED FOR FUTURE USE.
|
boolean |
isHTML(java.lang.Object fileOrFormatObj)
isHTML - RESERVED FOR FUTURE USE.
|
boolean |
isXML(java.lang.Object fileOrFormatObject)
Returns a boolean value to indicate whether the given
file or format is XML, in terms of XML processing (i.e. chunking).
|
void |
setSession(IDfSession session)
Set the session that will be used by the class.
|
void setSession(IDfSession session)
session
- IDfSession
boolean isXML(java.lang.Object fileOrFormatObject) throws DfException
fileOrFormatObject
- Can either be IDfFile object,IDfFormat object, file name (including the full path)
or a Documentum format name.DfException
boolean isHTML(java.lang.Object fileOrFormatObj) throws DfException
DfException
IDfList getObjectTypes(java.lang.String xmlApplication) throws DfException
DfException
IDfList getZones(java.lang.String xmlApplication) throws DfException
DfException
IDfXMLDocType getXMLDoctypeFromFile(java.lang.String filename) throws DfException
filename
- Contains the filename of the XML document to be parsed.DfException
java.lang.String getApplication(java.lang.String applicationName, boolean returnSingleApp) throws DfException
applicationName
- Name of an XML application.returnSingleApp
- Indicates whether the caller only wants a single XML
application object ID returned.DfException
getApplicationList(com.documentum.operations.IDfXMLDocType, java.lang.String)
java.lang.String getApplicationByDTD(java.lang.String dtdSystemId, java.lang.String dtdPublicId, java.lang.String namespace, java.lang.String rootElement, boolean returnSingleApp) throws DfException
dtdSystemId
- Filename of the DTD, if one is used, by the XML document.dtdPublicId
- Public identifier used by the XML documentnamespace
- Namespace of the root element, if one is used.rootElement
- Tag name of the root element.returnSingleApp
- Indicates whether the caller only wants a single XML
application object ID returned.DfException
getApplicationList(com.documentum.operations.IDfXMLDocType, java.lang.String)
IDfList getApplicationListByDTD(java.lang.String dtdSystemId, java.lang.String dtdPublicId, java.lang.String namespace, java.lang.String rootElement, boolean returnSingleApp) throws DfException
dtdSystemId
- Filename of the DTD, if one is used, by the XML document.dtdPublicId
- Public identifier used by the XML documentnamespace
- Namespace of the root element, if one is used.rootElement
- Tag name of the root element.returnSingleApp
- Indicates whether the caller only wants a single XML
application object ID returned.objectId,objectName
, where 'objectId' is
the object ID of the XML application folder and 'objectName' is the name of the XML application folder.DfException
getApplicationList(com.documentum.operations.IDfXMLDocType, java.lang.String)
IDfId getObjectIdFromDRL(java.lang.String drl) throws DfException
drl
- DRL string.DfException
IDfList getApplicationList(IDfXMLDocType doctype, java.lang.String fileOrFormatName) throws DfException
doctype
- IDfXMLDocType that contains DTD system id, etc.fileOrFormatName
- String containing a file name or format name. The name will be used to determine the
format (if needed) and name of the default XML application.objectId,objectName
, where 'objectId' is
the object ID of the XML application folder and 'objectName' is the name of the XML application folder.DfException
IDfList getApplicationList(IDfXMLDocType doctype, IDfSysObject object) throws DfException
doctype
- IDfXMLDocType that contains DTD system id, etc.object
- IDfSysObject whose a_content_type value is used to determine the name of the default XML application.objectId,objectName
, where 'objectId' is
the object ID of the XML application folder and 'objectName' is the name of the XML application folder.DfException
IDfList getApplicationList(IDfXMLDocType doctype, IDfFormat formatObj) throws DfException
doctype
- IDfXMLDocType that contains DTD system id, etc.formatObj
- IDfFormat that will be used to determine the name of the default XML application.objectId,objectName
, where 'objectId' is
the object ID of the XML application folder and 'objectName' is the name of the XML application folder.DfException
IDfList getApplicationList(IDfXMLDocType doctype, IDfFile file) throws DfException
doctype
- IDfXMLDocType that contains DTD system id, etc.file
- The format of the IDfFile will be used to determine the name of the default XML application.objectId,objectName
, where 'objectId' is
the object ID of the XML application folder and 'objectName' is the name of the XML application folder.DfException
IDfList getApplicationList(IDfXMLDocType doctype) throws DfException
doctype
- IDfXMLDocType that contains DTD system id, etc.objectId,objectName
, where 'objectId' is
the object ID of the XML application folder and 'objectName' is the name of the XML application folder.DfException
IDfList getApplicationList(java.lang.String applicationName) throws DfException
applicationName
- Name of an XML application.DfException
Copyright 1994-2023 OpenText Corporation. All rights reserved.