com.adobe.livecycle.ibmfilenetcontentrepositoryconnector.client
Class IBMFileNetContentRepositoryConnectorServiceClient

java.lang.Object
  com.adobe.livecycle.ibmfilenetcontentrepositoryconnector.client.IBMFileNetContentRepositoryConnectorServiceClient

All Implemented Interfaces:

IIBMFileNetContentRepositoryConnectorServiceClient

public class IBMFileNetContentRepositoryConnectorServiceClient
extends java.lang.Object
implements IIBMFileNetContentRepositoryConnectorServiceClient

The IBMFileNetContentRepositoryConnectorServiceClient class enables you to create a Java object that can invoke operations supported by the IBM FileNet Content Repository Connector service.

Constructor Summary

IBMFileNetContentRepositoryConnectorServiceClient(ServiceClientFactory serviceFactory)
Create a IBMFileNetContentRepositoryConnectorServiceClient using the given service factory

IBMFileNetContentRepositoryConnectorServiceClient(ServiceClientFactory serviceFactory, java.lang.String serviceName)
Create a IBMFileNetContentRepositoryConnectorServiceClient using the given service factory and specified service name

Method Summary

java.lang.String	createFolders(ILoginSettings loginSettings, java.lang.String objectStoreName, java.lang.String folderPath) /** This method creates folders in the FileNet object store.
IStoreContentResult	createOrUpdateContent(ILoginSettings loginSettings, java.lang.String objectStoreName, java.lang.String folderPath, java.lang.String documentClassType, java.lang.String documentMimeType, java.lang.String documentTitleOrGuid, Document documentContents, DocumentClassificationType classificationType, java.util.Map propertyNameValueMap) Stores and updates a document with the given contents into the IBM FileNet repository in the specified folder.
void	createRelationship(ILoginSettings loginSettings, java.lang.String objectStoreName, java.lang.String relationshipType, java.lang.String headDocumentGUIDOrPath, java.lang.String tailDocumentGUIDOrPath, java.util.Map propertyNameValueMap) Creates a relationship between two IBM FileNet Documents or Custom Type objects.
void	deleteContent(ILoginSettings loginSettings, java.lang.String objectStoreName, java.lang.String documentGUIDOrPath) Deletes a document/Folder from the IBM FileNet repository.
java.util.List	getAllItemsList(java.lang.String objectStoreName, java.lang.String path, boolean showOnlyFolders) Returns a list of all sub-folders and documents inside a given object store and path.
java.util.List	getAllVersionsList(ILoginSettings loginSettings, java.lang.String objectStoreName, java.lang.String documentGUIDOrPath) Retrieves all versions of a document from the IBM FileNet repository.
java.util.List	getClassPropertyList(java.lang.String objectStoreName, java.lang.String className, boolean includeReadOnlyProperties) Returns a list of properties for the given class (className) in the given object store (objectStore).
java.util.List	getClassTypeList(java.lang.String objectStoreName) Returns a list of supported class types from the given IBM object store.
IGetLinkedLCAssetsLocationResult	getLinkedLCAssetsLocation(ILoginSettings loginSettings, java.lang.String objectStoreName, java.lang.String ecmObjectPath, java.lang.String assetLinkObjectRelationship) Fetches the form template repository URL from the native repository for the given form data object in the IBM FileNet repository.
java.util.List	getObjectStoreNameList() Returns a list of object stores for the currently configured IBM FileNet Content Engine.
java.util.List	getRelated(ILoginSettings loginSettings, java.lang.String objectStoreName, java.lang.String relationshipType, java.lang.String documentGUIDOrPath, boolean isHead) Returns a list containing GUIDs of documents or custom objects related to a specified document or custom object by the given relationship type.
java.util.List	getRelationshipTypeList(java.lang.String objectStoreName) Returns a list of relationship type classes from the given objectStore.
IRetrieveContentResult	retrieveContent(ILoginSettings loginSettings, java.lang.String objectStoreName, java.lang.String documentGUIDOrPath, java.util.List inPropertyNameList) Retrieves a document from the IBM FileNet repository.
java.util.List	searchDocumentsByProperty(java.util.List objectStoreName, java.lang.String documentClassType, java.lang.String path, java.lang.String whereClause, java.lang.Integer maxRecords) Returns a list of all documents inside given objectStores.
void	setLinkToLCAssets(ILoginSettings loginSettings, java.lang.String objectStoreName, java.lang.String ecmObjectPath, java.lang.String formTemplateURL, java.lang.String assetLinkObjectRelationship, java.util.Map propertyNameValueMap) Links objects, files, or data in the native repository to an asset in the FileNet repository.
IStoreContentResult	storeContent(ILoginSettings loginSettings, java.lang.String objectStoreName, java.lang.String folderPath, java.lang.String documentClassType, java.lang.String documentMimeType, java.lang.String documentTitle, Document documentContents, UpdateVersionType updateVersionType, java.util.Map propertyNameValueMap) Stores a document with the given contents into the IBM FileNet repository in the specified folder.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IBMFileNetContentRepositoryConnectorServiceClient

public IBMFileNetContentRepositoryConnectorServiceClient(ServiceClientFactory serviceFactory)

Create a IBMFileNetContentRepositoryConnectorServiceClient using the given service factory

Parameters:

serviceFactory - A ServiceClientFactory that contains connection properties. For information about connection properties, see Invoking LiveCycle Services.

IBMFileNetContentRepositoryConnectorServiceClient

public IBMFileNetContentRepositoryConnectorServiceClient(ServiceClientFactory serviceFactory,
                                                         java.lang.String serviceName)

Create a IBMFileNetContentRepositoryConnectorServiceClient using the given service factory and specified service name

Parameters:

serviceFactory - A ServiceClientFactory that contains connection properties.

serviceName - The name of the IBM FileNet Content Repository Connector service.

Method Detail

createRelationship

public void createRelationship(ILoginSettings loginSettings,
                               java.lang.String objectStoreName,
                               java.lang.String relationshipType,
                               java.lang.String headDocumentGUIDOrPath,
                               java.lang.String tailDocumentGUIDOrPath,
                               java.util.Map propertyNameValueMap)
                        throws RepositoryException

Description copied from interface: IIBMFileNetContentRepositoryConnectorServiceClient

Creates a relationship between two IBM FileNet Documents or Custom Type objects. Note: The created relationship is weak, in that if you delete either the head or tail resource, the relationship itself is not deleted.

Specified by:

createRelationship in interface IIBMFileNetContentRepositoryConnectorServiceClient

Parameters:

loginSettings - Required. Configuration settings required to connect to IBM FileNet Repository. You can authenticate using:

• Process Context (In this mode no other details are required from the user)
• User Credentials (Username and Password)
• Token (IBM FileNet ticket)

objectStoreName - Required. Object store in the IBM FileNet Content Engine.

relationshipType - Required. Class describing the relationship between head and tail documents.

headDocumentGUIDOrPath - Required. GUID or Path for the document that constitutes the head in the relationship. For example, E9B46C4F-B75C-46BD-87C3-037A38E6BDF3} or /FolderPath/documentTitle) of the document or custom object. Note: Paths should use a forward slash [/], and must not include the name of the object store (objectStoreName).

tailDocumentGUIDOrPath - Required. GUID or Path for the document that constitutes the tail in the relationship. For example, E9B46C4F-B75C-46BD-87C3-037A38E6BDF3} or /FolderPath/documentTitle) of the document or custom object. Note: Paths should use a forward slash [/], and must not include the name of the object store (objectStoreName).

propertyNameValueMap - Optional. Map containing relationship property names and their values. These properties are set on the relationship. If any of the property names are not correct, an exception is thrown.

Throws:

RepositoryException - If any of the required parameters are NULL.

See Also:

createRelationship(com.adobe.livecycle.ibmfilenetcontentrepositoryconnector.client.type.ILoginSettings, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.util.Map)

getClassPropertyList

public java.util.List getClassPropertyList(java.lang.String objectStoreName,
                                           java.lang.String className,
                                           boolean includeReadOnlyProperties)
                                    throws RepositoryException

Description copied from interface: IIBMFileNetContentRepositoryConnectorServiceClient

Returns a list of properties for the given class (className) in the given object store (objectStore). Authentication is performed using the credentials specified at the Admin UI for IBM FileNet.

Specified by:

getClassPropertyList in interface IIBMFileNetContentRepositoryConnectorServiceClient

Parameters:

objectStoreName - Required. Object store in the IBM FileNet Content Engine.

className - Required. Name of the class whose property list is required.

includeReadOnlyProperties - Required. If false, read-only properties are not returned in the list.

Returns:

A list containing properties for the given class.

Throws:

RepositoryException - If any of the required parameters are NULL.

See Also:

getClassPropertyList(java.lang.String, java.lang.String, boolean)

getClassTypeList

public java.util.List getClassTypeList(java.lang.String objectStoreName)
                                throws RepositoryException

Description copied from interface: IIBMFileNetContentRepositoryConnectorServiceClient

Returns a list of supported class types from the given IBM object store. These classes obey the following criteria:

• They are of type Document class in FileNet
• They are instantiable by the user
• They are not hidden

Specified by:

getClassTypeList in interface IIBMFileNetContentRepositoryConnectorServiceClient

Parameters:

objectStoreName - Required. Object store in the IBM FileNet Content Engine.

Returns:

A list of supported class types.

Throws:

RepositoryException - If the required objectStoreName parameter is NULL.

See Also:

getClassTypeList(java.lang.String)

getRelated

public java.util.List getRelated(ILoginSettings loginSettings,
                                 java.lang.String objectStoreName,
                                 java.lang.String relationshipType,
                                 java.lang.String documentGUIDOrPath,
                                 boolean isHead)
                          throws RepositoryException

Description copied from interface: IIBMFileNetContentRepositoryConnectorServiceClient

Returns a list containing GUIDs of documents or custom objects related to a specified document or custom object by the given relationship type.

Specified by:

getRelated in interface IIBMFileNetContentRepositoryConnectorServiceClient

Parameters:

loginSettings - Required. Configuration settings required to connect to IBM FileNet Repository. You can authenticate using:

• Process Context (In this mode no other details are required from the user)
• User Credentials (Username and Password)
• Token (IBM FileNet ticket)

objectStoreName - Required. Object store in the IBM FileNet Content Engine.

relationshipType - Required. Relationship type between a document and its related documents.

documentGUIDOrPath - Required. Document or custom object whose related documents' GUIDS must be returned. For example, E9B46C4F-B75C-46BD-87C3-037A38E6BDF3} or /FolderPath/documentTitle) of the document or custom object. Note: Paths should use a forward slash [/], and must not include the name of the object store (objectStoreName).

isHead - Required. If true, GUIDs for all documents or custom objects that participate as the tail(in the given relationship) are returned. If false, GUIDs for all documents that participate as head (in the given relationship) are returned.

Returns:

A list containing GUIDs of documents or custom objects related to the given document or custom object.

Throws:

RepositoryException - If any of the required parameters are NULL.

See Also:

getRelated(com.adobe.livecycle.ibmfilenetcontentrepositoryconnector.client.type.ILoginSettings, java.lang.String, java.lang.String, java.lang.String, boolean)

getRelationshipTypeList

public java.util.List getRelationshipTypeList(java.lang.String objectStoreName)
                                       throws RepositoryException

Description copied from interface: IIBMFileNetContentRepositoryConnectorServiceClient

Returns a list of relationship type classes from the given objectStore. These classes obey the following criteria:

• They are of type Link class in FileNet
• They are instantiable by the user
• They are not hidden

Specified by:

getRelationshipTypeList in interface IIBMFileNetContentRepositoryConnectorServiceClient

Parameters:

objectStoreName - Required. Object store in the IBM FileNet Content Engine.

Returns:

A list of supported class types.

Throws:

RepositoryException - If the required objectStore parameter is NULL.

See Also:

getRelationshipTypeList(java.lang.String)

getObjectStoreNameList

public java.util.List getObjectStoreNameList()
                                      throws RepositoryException

Description copied from interface: IIBMFileNetContentRepositoryConnectorServiceClient

Returns a list of object stores for the currently configured IBM FileNet Content Engine. Repository credentials are obtained from the configuration page for EMC Documentum, on the Services page of Adobe Experience Manager forms Administration Console.

Specified by:

getObjectStoreNameList in interface IIBMFileNetContentRepositoryConnectorServiceClient

Returns:

A list of object store names.

Throws:

RepositoryException - When IBM FileNet throws a run-time error.

See Also:

getObjectStoreNameList()

retrieveContent

public IRetrieveContentResult retrieveContent(ILoginSettings loginSettings,
                                              java.lang.String objectStoreName,
                                              java.lang.String documentGUIDOrPath,
                                              java.util.List inPropertyNameList)
                                       throws RepositoryException

Description copied from interface: IIBMFileNetContentRepositoryConnectorServiceClient

Retrieves a document from the IBM FileNet repository.

Specified by:

retrieveContent in interface IIBMFileNetContentRepositoryConnectorServiceClient

Parameters:

loginSettings - Required. Configuration settings required to connect to IBM FileNet Repository. You can authenticate using:

• Process Context (In this mode no other details are required from the user)
• User Credentials (Username and Password)
• Token (IBM FileNet ticket)

objectStoreName - Required. Object store in the IBM FileNet Content Engine.

documentGUIDOrPath - Required. GUID or path of the required document. For example, E9B46C4F-B75C-46BD-87C3-037A38E6BDF3} or /FolderPath/documentTitle) of the document or custom object. Note: Paths should use a forward slash [/], and must not include the name of the object store (objectStoreName).

inPropertyNameList - Optional. Map containing document properties and their values. If any of the property names are not correct, an exception is thrown. This is an optional parameter.

Returns:

An IRetrieveContentResult object with the contents of the document.

Throws:

RepositoryException - If any of the required parameters are NULL.

See Also:

retrieveContent(com.adobe.livecycle.ibmfilenetcontentrepositoryconnector.client.type.ILoginSettings, java.lang.String, java.lang.String, java.util.List)

getAllVersionsList

public java.util.List getAllVersionsList(ILoginSettings loginSettings,
                                         java.lang.String objectStoreName,
                                         java.lang.String documentGUIDOrPath)
                                  throws RepositoryException

Description copied from interface: IIBMFileNetContentRepositoryConnectorServiceClient

Retrieves all versions of a document from the IBM FileNet repository.

Specified by:

getAllVersionsList in interface IIBMFileNetContentRepositoryConnectorServiceClient

Parameters:

loginSettings - The login settings required to connect to the IBM FileNet Repository.

objectStoreName - The object store where the Document/Custom object is stored

documentGUIDOrPath - The GUID (e.g. {E9B46C4F-B75C-46BD-87C3-037A38E6BDF3}) or path (e.g. /FolderPath/documentTitle) of the Document/Custom object. Note: Paths should use a forward slash [/] and must not include the objectStoreName.

Returns:

List of map of string values.

Throws:

RepositoryException - If any of the required parameters are NULL.

See Also:

getAllVersionsList(com.adobe.livecycle.ibmfilenetcontentrepositoryconnector.client.type.ILoginSettings, java.lang.String, java.lang.String)

storeContent

public IStoreContentResult storeContent(ILoginSettings loginSettings,
                                        java.lang.String objectStoreName,
                                        java.lang.String folderPath,
                                        java.lang.String documentClassType,
                                        java.lang.String documentMimeType,
                                        java.lang.String documentTitle,
                                        Document documentContents,
                                        UpdateVersionType updateVersionType,
                                        java.util.Map propertyNameValueMap)
                                 throws RepositoryException

Description copied from interface: IIBMFileNetContentRepositoryConnectorServiceClient

Stores a document with the given contents into the IBM FileNet repository in the specified folder. If there is only 1 existing document with the same "DocumentTitle" then it will be updated. The update type depends on how the flag updateVersionType flag is set. The stored document is stored as the current version. If there is more than 1 existing documents with the same "DocumentTitle" then an exception will be thrown and this scenario should be handled with the new API createOrUpdateContent.

Specified by:

storeContent in interface IIBMFileNetContentRepositoryConnectorServiceClient

Parameters:

loginSettings - The login settings required to connect to the IBM FileNet Repository.

objectStoreName - The object store to store the document in

folderPath - The path for the folder in which the document will be stored, for example, /Folder. Note: The folder must exist. It must not include the objectStoreName. It must use a forward slash [/] to denote the path. Folder paths are used as is.

documentClassType - The FileNet class for the document. It is used only in case a new document is created.

documentMimeType - The mime type of the document, for example "text/plain".

documentTitle - The title of the document under which the document will be stored. This name is used to check whether the document already exists.

documentContents - The contents of the document.

updateVersionType - In case a document is being updated, this parameter sets the version type to be used

propertyNameValueMap - The map containing document properties and their values. These properties are set on the document. If any of the property names are not correct, an exception is thrown (this is an optional parameter value).

Returns:

Information for the created or updated document.

Throws:

RepositoryException - If any of the required parameters are NULL.

See Also:

storeContent(com.adobe.livecycle.ibmfilenetcontentrepositoryconnector.client.type.ILoginSettings, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.adobe.idp.Document, com.adobe.livecycle.ibmfilenetcontentrepositoryconnector.client.type.UpdateVersionType, java.util.Map)

createOrUpdateContent

public IStoreContentResult createOrUpdateContent(ILoginSettings loginSettings,
                                                 java.lang.String objectStoreName,
                                                 java.lang.String folderPath,
                                                 java.lang.String documentClassType,
                                                 java.lang.String documentMimeType,
                                                 java.lang.String documentTitleOrGuid,
                                                 Document documentContents,
                                                 DocumentClassificationType classificationType,
                                                 java.util.Map propertyNameValueMap)
                                          throws RepositoryException

Description copied from interface: IIBMFileNetContentRepositoryConnectorServiceClient

Stores and updates a document with the given contents into the IBM FileNet repository in the specified folder. Existing documents are updated. The update type depends on how the flag updateVersionType flag is set. The stored document is stored as the current version.

Specified by:

createOrUpdateContent in interface IIBMFileNetContentRepositoryConnectorServiceClient

Parameters:

loginSettings - The login settings required to connect to the IBM FileNet Repository.

objectStoreName - The object store to store the document in

folderPath - The path for the folder in which the document will be stored, for example, /Folder. Note: The folder must exist. It must not include the objectStoreName. It must use a forward slash [/] to denote the path. Folder paths are used as is.

documentClassType - The FileNet class for the document. It is used only in case a new document is created.

documentMimeType - The mime type of the document, for example "text/plain".

documentTitleOrGuid - The title of the document in case a new document is to be created. The guid needs to be passed in case the existing document needs to be updated.

documentContents - The contents of the document.

classificationType - This defines whether a new document needs to be created or an existing one to be updated.

propertyNameValueMap - The map containing document properties and their values. These properties are set on the document. If any of the property names are not correct, an exception is thrown (this is an optional parameter value).

Returns:

Information for the created or updated document.

Throws:

RepositoryException - If any of the required parameters are NULL.

See Also:

storeContent(com.adobe.livecycle.ibmfilenetcontentrepositoryconnector.client.type.ILoginSettings, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.adobe.idp.Document, com.adobe.livecycle.ibmfilenetcontentrepositoryconnector.client.type.UpdateVersionType, java.util.Map)

createFolders

public java.lang.String createFolders(ILoginSettings loginSettings,
                                      java.lang.String objectStoreName,
                                      java.lang.String folderPath)
                               throws RepositoryException

Description copied from interface: IIBMFileNetContentRepositoryConnectorServiceClient

/** This method creates folders in the FileNet object store. If a folder in the given path does not exist, the folder is created. This functionality is equivalent to the UNIX mkdir -p command.

Specified by:

createFolders in interface IIBMFileNetContentRepositoryConnectorServiceClient

Parameters:

loginSettings - Required. Configuration settings required to connect to IBM FileNet Repository. You can authenticate using:

• Process Context (In this mode no other details are required from the user)
• User Credentials (Username and Password)
• Token (IBM FileNet ticket)

objectStoreName - Required. Object store in the IBM FileNet Content Engine, where folders will be created.

folderPath - Required. The path of the new folders. If any of the folders in the path do not exist, they will be created. In this operation, all folder paths should start with a forward slash [/].

Returns:

The GUID of the leaf folder.

Throws:

RepositoryException - If any of the required parameters are NULL.

See Also:

createFolders(ILoginSettings loginSettings, String objectStoreName, String folderPath)

getAllItemsList

public java.util.List getAllItemsList(java.lang.String objectStoreName,
                                      java.lang.String path,
                                      boolean showOnlyFolders)
                               throws RepositoryException

Description copied from interface: IIBMFileNetContentRepositoryConnectorServiceClient

Returns a list of all sub-folders and documents inside a given object store and path.

Specified by:

getAllItemsList in interface IIBMFileNetContentRepositoryConnectorServiceClient

Parameters:

objectStoreName - Required. Object store in IBM FileNet Content Engine.

path - Required. Path in IBM FileNet Content Engine.

showOnlyFolders - Required. If true only sub-folders are fetched. If false both documents and sub-folders are fetched.

Returns:

A list of all sub-folders and documents, or only sub-folders inside a folder. Each list item is a map representing a document or sub-folder. This map contains the keys: name, path, isFolder, mimetype, and hasChildren.

Throws:

RepositoryException - If the required objectStore parameter is NULL.

See Also:

getAllItemsList(java.lang.String, java.lang.String, java.lang.boolean)

searchDocumentsByProperty

public java.util.List searchDocumentsByProperty(java.util.List objectStoreName,
                                                java.lang.String documentClassType,
                                                java.lang.String path,
                                                java.lang.String whereClause,
                                                java.lang.Integer maxRecords)
                                         throws RepositoryException

Description copied from interface: IIBMFileNetContentRepositoryConnectorServiceClient

Returns a list of all documents inside given objectStores. Use whereClause parameter to specify the condition. It obeys the following criteria:

Specified by:

searchDocumentsByProperty in interface IIBMFileNetContentRepositoryConnectorServiceClient

Parameters:

objectStoreName - An Object store in IBM FileNet Content Engine.

documentClassType - The FileNet class for the document.

path - folder path. If path is not null, then [Document.This INFOLDER '/TestFolder' AND ] gets added to the query statement.

whereClause - where clause of the query statement.

maxRecords - Maximum records to be returned in result. Default to 100.

Returns:

A list of all documents matching the properties.

Throws:

RepositoryException - If the required objectStore parameter is NULL.

See Also:

getAllItemsList(java.lang.String, java.util.Map)

setLinkToLCAssets

public void setLinkToLCAssets(ILoginSettings loginSettings,
                              java.lang.String objectStoreName,
                              java.lang.String ecmObjectPath,
                              java.lang.String formTemplateURL,
                              java.lang.String assetLinkObjectRelationship,
                              java.util.Map propertyNameValueMap)
                       throws RepositoryException

Description copied from interface: IIBMFileNetContentRepositoryConnectorServiceClient

Links objects, files, or data in the native repository to an asset in the FileNet repository. This method creates a new object "Asset Link Object" (ALO)(if it does not exist) in FileNet repository corresponding to the form template URL information (present in the Native Repository). However, the form template URL path is not cross checked for its existence at the time of ALO creation. An ALO does not necessarily represent a form template in the native repository. It means that an ALO object can also be created for any resource lying in native repository. If the ecmObjectPath is specified, a relationship between ecmObjectPath (in FileNet repository) and an ALO is created. If an ALO corresponding to a form template URL already exists, a relationship between ecmObjectPath and ALO is created. Once created, an ALO cannot be modified, and the properties of an ALO object cannot be altered.

Specified by:

setLinkToLCAssets in interface IIBMFileNetContentRepositoryConnectorServiceClient

Parameters:

loginSettings - Required. Configuration settings required to connect to IBM FileNet Repository. You can authenticate using:

• Process Context (In this mode no other details are required from the user)
• User Credentials (Username and Password)
• Token (IBM FileNet ticket)

objectStoreName - Required. Object store in the IBM FileNet Content Engine.

ecmObjectPath - Required. Path of the object in ECM repository. For example, /Folder/Filename.ext. Note: The path should lead to an existing ECM object. The path should use a forward slash [/], and must not include the name of the object store (objectStoreName).

formTemplateURL - Required. Form template URL (preferably, path of the XDP in the native repository). This path is not cross checked for its existence at the time of ALO creation.

assetLinkObjectRelationship - Optional. Relationship between ECM Object and ALO. If nothing is specified, "Related Items" is used as a default relationship type.

propertyNameValueMap - Optional. Map containing relationship properties and their values. These properties are set on the relationship. If any of the property names are not correct, an exception is thrown.

Throws:

RepositoryException - If any of the required parameters are NULL.

getLinkedLCAssetsLocation

public IGetLinkedLCAssetsLocationResult getLinkedLCAssetsLocation(ILoginSettings loginSettings,
                                                                  java.lang.String objectStoreName,
                                                                  java.lang.String ecmObjectPath,
                                                                  java.lang.String assetLinkObjectRelationship)
                                                           throws RepositoryException

Description copied from interface: IIBMFileNetContentRepositoryConnectorServiceClient

Fetches the form template repository URL from the native repository for the given form data object in the IBM FileNet repository.

Specified by:

getLinkedLCAssetsLocation in interface IIBMFileNetContentRepositoryConnectorServiceClient

Parameters:

loginSettings - Required. Configuration settings required to connect to IBM FileNet Repository. You can authenticate using:

• Process Context (In this mode no other details are required from the user)
• User Credentials (Username and Password)
• Token (IBM FileNet ticket)

objectStoreName - Required. Object store in the IBM FileNet Content Engine, where form data is kept.

ecmObjectPath - Required. ECM Object Path. For example, /Folder/EcmObject.xml. It must use a forward slash [/] to denote the path.

assetLinkObjectRelationship - Optional. Relationship between form data and the asset link object. If nothing is specified, "Related Items" is used as a default relationship type.

Throws:

RepositoryException - If any of the required parameters are NULL.

deleteContent

public void deleteContent(ILoginSettings loginSettings,
                          java.lang.String objectStoreName,
                          java.lang.String documentGUIDOrPath)
                   throws RepositoryException

Description copied from interface: IIBMFileNetContentRepositoryConnectorServiceClient

Deletes a document/Folder from the IBM FileNet repository. In case of a folder all its sub folders and other containees are also deleted. If however, due to some reason an exception is thrown when trying to delete any of the above subfolders/containees, further deletion halts and few containees are deleted while few are left undeleted.

Specified by:

deleteContent in interface IIBMFileNetContentRepositoryConnectorServiceClient

Parameters:

loginSettings - Required. Configuration settings required to connect to IBM FileNet Repository. You can authenticate using:

• Process Context (In this mode no other details are required from the user)
• User Credentials (Username and Password)
• Token (IBM FileNet ticket)

objectStoreName - Required. Object store in the IBM FileNet Content Engine, where the document or folder is stored.

documentGUIDOrPath - Required. GUID or path of the document or folder. For example, E9B46C4F-B75C-46BD-87C3-037A38E6BDF3} or /FolderPath/documentTitle) of the document or custom object. Note: Paths should use a forward slash [/], and must not include the name of the object store (objectStoreName).

Throws:

RepositoryException - If any of the required parameters are NULL.