|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IEMCDocumentumContentRepositoryConnectorServiceClient
EMC Documentum Content Repository Connector service client interface:
This interface contains all methods that can be invoked on the service using the service client
Method Summary | |
---|---|
String |
createFolders(ILoginSettings loginSettings,
String repositoryName,
String folderPath)
This method creates folders in the Documentum Docbase. |
String |
createFoldersWithTypeAndAttributes(ILoginSettings loginSettings,
String repositoryName,
String parentFolderPath,
String folderName,
String folderType,
Map attributeNameValueMap)
Creates folders in the Documentum Docbase of given folder type, and sets folder attributes. |
void |
createRelationship(ILoginSettings loginSettings,
String repositoryName,
String relationshipType,
String parentDocumentIDOrPath,
String childDocumentIDOrPath,
String childVersionLabel,
boolean isPermanentLink,
String description)
Creates a relationship of a given type between two Documentum objects. |
void |
deleteContent(ILoginSettings loginSettings,
String repositoryName,
String documentGUIDOrPath)
Deletes a document or folder from the Documentum Docbase. |
List |
executeDQLQuery(ILoginSettings loginSettings,
String repositoryName,
String query)
Executes the DQL query that is passed as a parameter. |
List |
executeDQLQuery2(ILoginSettings loginSettings,
String repositoryName,
String query)
Executes the DQL query that is passed as a parameter. |
List |
getAllItemsList(String repositoryName,
String path,
boolean showOnlyFolders)
Returns a list containing all the contents at a given path in the Docbase. |
List |
getClassAttributeList(String repositoryName,
String className,
boolean includeReadOnlyAttributes)
Returns a list of attributes for the given className in the given repositoryName . |
List |
getClassTypeList(String repositoryName)
Returns a list of class types supported by the given Docbase.repositoryName value. |
List |
getDocumentContentTypeList(String repositoryName)
Returns a list of all unhidden content-type values supported by the given repositoryName . |
List |
getFolderClassTypeList(String repositoryName)
Returns a list of class types that are subtypes of dm_folder supported by the given repositoryName value. |
IGetLinkedLCAssetsLocationResult |
getLinkedLCAssetsLocation(ILoginSettings loginSettings,
String repositoryName,
String ecmObjectPath,
String assetLinkObjectRelationship)
Fetches a form template repository URL from the native repository, for the given form data object in Documentum Docbase. |
List |
getRelated(ILoginSettings loginSettings,
String repositoryName,
String relationshipType,
String documentIDOrPath,
boolean isParent)
Returns a list of IDs of documents, related to a specified Document by the given relationship type. |
List |
getRelationshipTypeList(String repositoryName)
Returns a list of relationship types, which have non-system level security,
supported by the given repositoryName . |
List |
getRepositoryNameList()
Returns a list of repositories for the presently configured Documentum connection broker. |
IRetrieveContentResult |
retrieveContent(ILoginSettings loginSettings,
String repositoryName,
String documentIDOrPath,
List inAttributeNameList)
Retrieves a document from the EMC Documentum Docbase. |
void |
setLinkToLCAssets(ILoginSettings loginSettings,
String repositoryName,
String ecmObjectPath,
String formTemplateURL,
String assetLinkObjectRelationship,
String relationshipDescription)
Used to link objects, files, or data lying in Documentum Docbase to an asset lying in a native repository. |
IStoreContentResult |
storeContent(ILoginSettings loginSettings,
String repositoryName,
String folderPath,
String documentClassType,
String documentContentType,
String documentName,
String documentTitle,
String documentSubject,
List documentKeywords,
Document documentContents,
UpdateVersionType updateVersionType,
Map attributeNameValueMap)
Stores a document with the given contents into the EMC Documentum Docbase, in the specified folder. |
Method Detail |
---|
void createRelationship(ILoginSettings loginSettings, String repositoryName, String relationshipType, String parentDocumentIDOrPath, String childDocumentIDOrPath, String childVersionLabel, boolean isPermanentLink, String description) throws RepositoryException
loginSettings
- Required. Configuration settings required to connect to the EMC Documentum Docbase. You can authenticate using:
repositoryName
- Required. Name of the Docbase where the documents exist.relationshipType
- Required. Type of relationship to be created between parent document and child document.parentDocumentIDOrPath
- Required. ID or path (relative to the docbase) of the object that will constitute as the parent in the relationship.
For example, /CabinetName/FolderPath/documentName
or 3700008d8000010b
. Note: If a path name is specified,
it must not include the repositoryName
. Also, the path name
must use a forward slash [/] to denote the path.childDocumentIDOrPath
- Required. ID or path (relative to the docbase) of the object that will constitute as the child in the relationship.
For example, /CabinetName/FolderPath/documentName
or 3700008d8000010b
. Note: If a path name is specified,
it must not include the repositoryName
. Also, the path name
must use a forward slash [/] to denote the path.childVersionLabel
- Optional. Version Label of the specified child document. If set, the chronicle ID of the child document
will be used for childDocumentIDOrPath
.isPermanentLink
- Required. Indicates whether the relationship should be maintained across versions of the parent document.description
- Optional. Text description of the relationship. If NULL
is passed, no description is saved.
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- If the specified relationship type is invalid.
RepositoryException
- In all other cases when Documentum throws a run-time error.List getClassAttributeList(String repositoryName, String className, boolean includeReadOnlyAttributes) throws RepositoryException
className
in the given repositoryName
.
repositoryName
- Required. Name of the Docbase in which the class exists.className
- Required. Name of the class whose attributes are required.includeReadOnlyAttributes
- Required. If false
, read-only attributes are not returned in the list.
list
containing attributes for the given class.
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- If the specified class name is invalid.
RepositoryException
- In all other cases when Documentum throws a run-time error.List getClassTypeList(String repositoryName) throws RepositoryException
Docbase.repositoryName
value. Repository
credentials are obtained from the configuration page for EMC Documentum, on the Services page of LiveCycle
Administration Console.
repositoryName
- Required. Name of the Docbase where the classes exist.
list
of supported class types.
RepositoryException
- If the required repositoryName
parameter is NULL
.
RepositoryException
- In all other cases when Documentum throws a run-time error.List getFolderClassTypeList(String repositoryName) throws RepositoryException
dm_folder
supported by the given repositoryName
value.
repositoryName
- Required. Name of the Docbase where the classes exist.
list
of supported class types for dm_folder
.
RepositoryException
- If the required repositoryName
parameter is NULL
.
RepositoryException
- In all other cases when Documentum throws a run-time error.List getDocumentContentTypeList(String repositoryName) throws RepositoryException
repositoryName
.
repositoryName
- Required. Name of the Docbase whose content types need be returned.
list
of content-type values.
RepositoryException
- If the required repositoryName
parameter is NULL
.
RepositoryException
- In all other cases when EMC Documentum throws a run-time error.List getRelated(ILoginSettings loginSettings, String repositoryName, String relationshipType, String documentIDOrPath, boolean isParent) throws RepositoryException
loginSettings
- Required. Configuration settings required to connect to the EMC Documentum Docbase. You can authenticate using:
repositoryName
- Required. Name of the Docbase where the document exists.relationshipType
- Relationship type between the document and its related documents.documentIDOrPath
- Required. Document whose related document IDs are required. For example,
/CabinetName/FolderPath/documentName
or 3700008d8000010b
. Note: If a path name is specified,
it must not include the repositoryName
. Also, the path name
must use a forward slash [/] to denote the path.isParent
- Required. If true
, IDs for all documents that participate as children
(in the given relationship) are returned. If false
, IDs for all documents
that participate as parent
(in the given relationship) are returned.
list
containing IDs of documents related to the given document
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- In all other cases when EMC Documentum throws a run-time error.List getRelationshipTypeList(String repositoryName) throws RepositoryException
non-system level
security,
supported by the given repositoryName
. Each repositoryName
in
Documentum, is associated with or contains a given set of relationships denoted by attribute
dm_relation_type_s. This method fetches those dm_relation_type_s for which security
is not equal to SYSTEM
.
repositoryName
- Required. Name of the Docbase.
list
of relationship types.
RepositoryException
- If the required repositoryName
parameter is NULL
.
RepositoryException
- In all other cases when Documentum throws a run-time error.List getRepositoryNameList() throws RepositoryException
list
containing names of repositories.
RepositoryException
- If Documentum throws a run-time error.IRetrieveContentResult retrieveContent(ILoginSettings loginSettings, String repositoryName, String documentIDOrPath, List inAttributeNameList) throws RepositoryException
loginSettings
- Required. Configuration settings required to connect to the EMC Documentum Docbase. You can authenticate using:
repositoryName
- Required. Name of the Docbase where the document exists.documentIDOrPath
- Required. Document ID or path of the stored document. For example,
/CabinetName/FolderPath/documentName
or 3700008d8000010b
. Note: If a path name is specified,
it must not include the repositoryName
. Also, the path name
must use a forward slash [/] to denote the path.inAttributeNameList
- Optional. List containing document attributes and their values. If any of the attribute
names are not correct, an exception is thrown.
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- If the document does not exist.
RepositoryException
- If user credentials cannot be authenticated.
RepositoryException
- If the user does have read permissions on the document.
RepositoryException
- If the user does not have permissions to check out the document.
RepositoryException
- If the document is already checked out.
RepositoryException
- In all other cases when Documentum throws a run-time error.IStoreContentResult storeContent(ILoginSettings loginSettings, String repositoryName, String folderPath, String documentClassType, String documentContentType, String documentName, String documentTitle, String documentSubject, List documentKeywords, Document documentContents, UpdateVersionType updateVersionType, Map attributeNameValueMap) throws RepositoryException
updateVersionType
flag is set. The stored document is stored as the current version. EMC Documentum does not allow creation of
documents directly in the Docbase. Instead select a cabinet for the same.
loginSettings
- Required. Configuration settings required to connect to the EMC Documentum Docbase. You can authenticate using:
repositoryName
- Required. Name of the Docbase where the document exists/will be stored.folderPath
- Required. Folder path where the document will be stored.
For example, /CabinetName/Folder
.
Note: The folder must exist. The supplied folder path must not include the
repositoryName
. Folder paths must use a forward slash [/]
to denote the path. Folder paths are used as provided.documentClassType
- Required. Documentum class for the document. It is used only in case a new document is
created.documentContentType
- Required. Content type of the document. For example "PDF".documentName
- Required. Name of the document. This name is used to check whether the document already exists.documentTitle
- Optional. Title of the document.documentSubject
- Optional. Subject of the document.documentKeywords
- Optional. Keywords for the document. Keywords are set in the order they are passed to the
method. For an existing document, all previous keywords are deleted. This is
an optional parameter.documentContents
- Required. Contents of the document.updateVersionType
- Optional. In case a document is being updated, this parameter sets the version type to be used.attributeNameValueMap
- Optional. Map containing document attributes and their values. These attributes
are set on the document. All correct attribute values are set. If an incorrect attribute value
is specified, it is not set. This method does not throw an exception if an incorrect attribute value is specified.
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- If a forward slash [/] is passed as folderPath.
RepositoryException
- If user credentials cannot be authenticated.
RepositoryException
- If the folderPath
does not exist.
RepositoryException
- If the user does have write permissions for the folder.
RepositoryException
- If an I/O Exception occurs during the operation.
RepositoryException
- In all other cases when Documentum throws a run-time error.String createFolders(ILoginSettings loginSettings, String repositoryName, String folderPath) throws RepositoryException
mkdir -p
command.
loginSettings
- Required. Configuration settings required to connect to the EMC Documentum Docbase. You can authenticate using:
repositoryName
- Required. Name of the Repository where the document exists, or will be stored.folderPath
- Required. Path of the folder. If any of the folders in the path do not exist, they will be created.
ObjectId
of the leaf folder in the path
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- If user credentials cannot be authenticated.
RepositoryException
- If the user does have write permissions for the folder.
RepositoryException
- If an I/O Exception occurs during the operation.
RepositoryException
- In all other cases when Documentum throws a run-time error.void setLinkToLCAssets(ILoginSettings loginSettings, String repositoryName, String ecmObjectPath, String formTemplateURL, String assetLinkObjectRelationship, String relationshipDescription) throws RepositoryException
ecmObjectPath
is specified, a relationship between
ecmObjectPath
(lying in Documentum Docbase)and the ALO is created. If an ALO corresponding to a
formTemplateURL
already exists, a relationship between the ecmObjectPath
and an ALO is created.
An ALO, once created, cannot be modified later (Users cannot change the properties of an ALO object, once created).
loginSettings
- Required. Configuration settings required to connect to the EMC Documentum Docbase. You can authenticate using:
repositoryName
- Required. Name of the Docbase where the document exists, or will be stored.ecmObjectPath
- Optional. Path for the corresponding form data. Use a forward slash [/] to denote
the path. Folder paths are used as is. If the ecmObjectPath
is NULL
, only an asset object will be created, and no relationship
will be established.formTemplateURL
- Required. Form Template URL. (Preferably, path of an XDP in the native repository).
This path is not cross checked for its existence at the time of ALO creation.assetLinkObjectRelationship
- Optional. The name of the relationship between the template and form data.relationshipDescription
- Optional. The description of the relationship.
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- If a forward slash [/] is passed as formDataFolderPath.
RepositoryException
- If user credentials cannot be authenticated.
RepositoryException
- If formDataPath does not exist.
RepositoryException
- If the user does have write permissions for the folder.
RepositoryException
- If an I/O Exception occurs during the operation.
RepositoryException
- If relationshipName does not exist.
RepositoryException
- In all other cases when Documentum throws a run-time error.IGetLinkedLCAssetsLocationResult getLinkedLCAssetsLocation(ILoginSettings loginSettings, String repositoryName, String ecmObjectPath, String assetLinkObjectRelationship) throws RepositoryException
loginSettings
- Required. Configuration settings required to connect to the EMC Documentum Docbase. You can authenticate using:
repositoryName
- Required. Name of the Docbase where form data is kept.ecmObjectPath
- Required. Form data file path. For example, /Folder/FormData.xml
.
Use a forward slash [/] to denote the path. Folder paths are used as is.assetLinkObjectRelationship
- Optional. Relationship between the form data and the asset link object.
formTemplateURL
: Absolute URL of the form templateformTemplateFolderPath
: Parent folder path of the form templateformTemplateName
: Template nameRepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- If a forward slash [/] is passed as formDataFolderPath.
RepositoryException
- If user credentials cannot be authenticated.
RepositoryException
- If formDataPath does not exist.
RepositoryException
- If an I/O Exception occurs during the operation.
RepositoryException
- In all other cases when Documentum throws a run-time error.List getAllItemsList(String repositoryName, String path, boolean showOnlyFolders) throws RepositoryException
repositoryName
- Required. Name of the Docbase that contains the list of items.path
- Optional. Path to the location in the Docbase that contains the items.showOnlyFolders
- Required. Sets what is returned in the list
. If set to True
,
only folders are returned. If set to False
,
all contents are returned.
list
containing all the items at the given path.
RepositoryException
- If any of the required parameters are NULL
. repositoryName
is a required parameter.
RepositoryException
- If the path does not exist.
RepositoryException
- In all other cases when Documentum throws a run-time error.String createFoldersWithTypeAndAttributes(ILoginSettings loginSettings, String repositoryName, String parentFolderPath, String folderName, String folderType, Map attributeNameValueMap) throws RepositoryException
loginSettings
- Required. Configuration settings required to connect to the EMC Documentum Docbase. You can authenticate using:
repositoryName
- Required. Name of the Docbase where the document exists, or will be stored.parentFolderPath
- Required. Path of the parent folder. If any of the folders in the path do not exist, they will be created.folderName
- Required. Name of the new folder to be created.folderType
- Optional. Type of the folder. If the path is NULL
, a folder of type
dm_folder
is created.attributeNameValueMap
- Optional. Map containing attributes of the folder. If the given type does not
contain any of these attributes then it will throw an exception.
RepositoryException
- If user credentials cannot be authenticated.
RepositoryException
- If the user does have write permissions for the folder.
RepositoryException
- If the given type does not contain any of the attributes.
RepositoryException
- If folder exists and its type is not as same as given type.
Or if the folder type is not a sub-type or super-type of the given type.
RepositoryException
- If an I/O Exception occurs during the operation.
RepositoryException
- In all other cases when Documentum throws a run-time error.void deleteContent(ILoginSettings loginSettings, String repositoryName, String documentGUIDOrPath) throws RepositoryException
loginSettings
- Required. Configuration settings required to connect to the EMC Documentum Docbase. You can authenticate using:
repositoryName
- Required. Name of the Docbase where the document is stored.documentGUIDOrPath
- Required. Document path or GUID of the document. For example,
/CabinetName/FolderPath/documentName
or 3700008d8000010b
. Note: If a path name is specified,
it must not include the repositoryName
. Also, the path name
must use a forward slash [/] to denote the path.
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- If an invalid path or GUID is passed.
RepositoryException
- If user credentials cannot be authenticated.
RepositoryException
- If the user does have delete permissions on the document.
RepositoryException
- In all other cases when Documentum throws a run-time error.List executeDQLQuery(ILoginSettings loginSettings, String repositoryName, String query) throws RepositoryException
loginSettings
- Required. Configuration settings required to connect to the EMC Documentum Docbase. You can authenticate using:
repositoryName
- Required. Name of the Docbase where the query is to be executed.query
- Required. DQL Query String to be executed.
list
for each row returned, containing map of attribute names and values.
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- If user credentials cannot be authenticated.
RepositoryException
- If the user does not have permissions to execute the specified query.
RepositoryException
- If an I/O Exception occurs during the operation.
RepositoryException
- In all other cases when Documentum throws a run-time error.List executeDQLQuery2(ILoginSettings loginSettings, String repositoryName, String query) throws RepositoryException
loginSettings
- Required. Configuration settings required to connect to the EMC Documentum Docbase. You can authenticate using:
repositoryName
- Required. Name of the Docbase where the query is to be executed.query
- Required. DQL Query String to be executed.
list
of ExecuteDQLResult corresponding to each row.
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- If user credentials cannot be authenticated.
RepositoryException
- If the user does not have permissions to execute the specified query.
RepositoryException
- If an I/O Exception occurs during the operation.
RepositoryException
- In all other cases when Documentum throws a run-time error.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |