|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IIBMFileNetContentRepositoryConnectorServiceClient
IBM FileNet Content Repository Connector service client interface: This interface contains all methods that can be invoked on the service using the service client
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. |
Method Detail |
---|
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
loginSettings
- Required. Configuration settings required to connect to IBM FileNet Repository.
You can authenticate using:
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.
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- If the passed class in relationship class type is invalid.
RepositoryException
- In all other cases when IBM FileNet throws a run-time error.java.util.List getClassPropertyList(java.lang.String objectStoreName, java.lang.String className, boolean includeReadOnlyProperties) throws RepositoryException
className
) in the given object store (objectStore
).
Authentication is performed using the credentials specified at the Admin UI for IBM FileNet.
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.
list
containing properties for the given class.
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- In all other cases when IBM FileNet throws a run-time error.java.util.List getClassTypeList(java.lang.String objectStoreName) throws RepositoryException
Document
class in FileNet
objectStoreName
- Required. Object store in the IBM FileNet Content Engine.
list
of supported class types.
RepositoryException
- If the required objectStoreName
parameter is NULL
.
RepositoryException
- In all other cases when IBM FileNet throws a run-time error.java.util.List getRelated(ILoginSettings loginSettings, java.lang.String objectStoreName, java.lang.String relationshipType, java.lang.String documentGUIDOrPath, boolean isHead) throws RepositoryException
loginSettings
- Required. Configuration settings required to connect to IBM FileNet Repository.
You can authenticate using:
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.
list
containing GUIDs of documents or custom objects related to the given
document or custom object.
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- In all other cases when IBM FileNet throws a run-time error.java.util.List getRelationshipTypeList(java.lang.String objectStoreName) throws RepositoryException
objectStore
. These classes obey the
following criteria:
Link
class in FileNet
objectStoreName
- Required. Object store in the IBM FileNet Content Engine.
list
of supported class types.
RepositoryException
- If the required objectStore
parameter is NULL
.
RepositoryException
- In all other cases when IBM FileNet throws a run-time error.java.util.List getObjectStoreNameList() throws RepositoryException
list
of object store names.
RepositoryException
- When IBM FileNet throws a run-time error.IRetrieveContentResult retrieveContent(ILoginSettings loginSettings, java.lang.String objectStoreName, java.lang.String documentGUIDOrPath, java.util.List inPropertyNameList) throws RepositoryException
loginSettings
- Required. Configuration settings required to connect to IBM FileNet Repository.
You can authenticate using:
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.
IRetrieveContentResult
object with the contents of the document.
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- If an invalid path or GUID is provided.
RepositoryException
- If user credentials cannot be authenticated.
RepositoryException
- If the user does not have read permissions on the document.
RepositoryException
- If the document is checked out.
RepositoryException
- If the user does not have permissions to check out the document.
RepositoryException
- In all other cases when FileNet throws a run-time error.java.util.List getAllVersionsList(ILoginSettings loginSettings, java.lang.String objectStoreName, java.lang.String documentGUIDOrPath) throws RepositoryException
loginSettings
- The login settings required to connect to the IBM FileNet Repository.objectStoreName
- The object store where the Document/Custom object is storeddocumentGUIDOrPath
- 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
.
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 read permissions on the document.
RepositoryException
- If the document is already checked out.
RepositoryException
- If the user does not have permissions to check out the document.
RepositoryException
- In all other cases where FileNet produces a run-time error.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
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.
loginSettings
- The login settings required to connect to the IBM FileNet Repository.objectStoreName
- The object store to store the document infolderPath
- 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 usedpropertyNameValueMap
- 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).
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 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
- If more than 1 documents exist with the same "DocumentTitle" in the specified folder.
RepositoryException
- In all other cases where FileNet produces a run-time error.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
updateVersionType
flag is set.
The stored document is stored as the current version.
loginSettings
- The login settings required to connect to the IBM FileNet Repository.objectStoreName
- The object store to store the document infolderPath
- 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).
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 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 where FileNet produces a run-time error.java.lang.String createFolders(ILoginSettings loginSettings, java.lang.String objectStoreName, java.lang.String folderPath) throws RepositoryException
mkdir -p
command.
loginSettings
- Required. Configuration settings required to connect to IBM FileNet Repository.
You can authenticate using:
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 [/].
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- If the folderPath
does not start with a forward slash [/].
RepositoryException
- If user credentials cannot be authenticated.
RepositoryException
- If the user does not have write permissions for the folder.
RepositoryException
- If an I/O Exception occurs during the operation.
RepositoryException
- In all other cases where FileNet throws a run-time error.java.util.List getAllItemsList(java.lang.String objectStoreName, java.lang.String path, boolean showOnlyFolders) throws RepositoryException
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.
name
, path
, isFolder
, mimetype
, and hasChildren
.
RepositoryException
- If the required objectStore
parameter is NULL
.
RepositoryException
- If the required path
parameter is NULL
.
RepositoryException
- In all other cases when IBM FileNet throws a run-time error.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
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.
RepositoryException
- If the required objectStore
parameter is NULL
.
RepositoryException
- If the required map
parameter is NULL
.
RepositoryException
- In all other cases where IBM FileNet produces a run-time error.
Example :
1.) The method objIBMFileNetContentRepositoryConnectorServiceClient.searchDocumentsByProperty(objectStoresList, "Document", "/TestFolder", "DocumentTitle='test_Document.pdf'", null)
generates a query SELECT DocumentTitle, Id, MimeType FROM Document WHERE Document.This INFOLDER '/TestFolder' AND DocumentTitle='test_Document.pdf'
2.) The method objIBMFileNetContentRepositoryConnectorServiceClient.searchDocumentsByProperty(objectStoresList, "Document", null, "Document.This INFOLDER '/TestFolder' AND DocumentTitle='test_Document.pdf'", null)
generates a query SELECT DocumentTitle, Id, MimeType FROM Document WHERE Document.This INFOLDER '/TestFolder' AND DocumentTitle='test_Document.pdf'
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
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.
loginSettings
- Required. Configuration settings required to connect to IBM FileNet Repository.
You can authenticate using:
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.
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- If user credentials cannot be authenticated.
RepositoryException
- If ecmObjectPath
does not exist.
RepositoryException
- If the user does not have write permissions for the folder where the ALO is stored.
RepositoryException
- If an I/O Exception occurs during the operation.
RepositoryException
- In all other cases when FileNet throws a run-time error.IGetLinkedLCAssetsLocationResult getLinkedLCAssetsLocation(ILoginSettings loginSettings, java.lang.String objectStoreName, java.lang.String ecmObjectPath, java.lang.String assetLinkObjectRelationship) throws RepositoryException
loginSettings
- Required. Configuration settings required to connect to IBM FileNet Repository.
You can authenticate using:
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.
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- If user credentials cannot be authenticated.
RepositoryException
- If the ecmObjectPath
does not exist.
RepositoryException
- If an I/O Exception occurs during the operation.
RepositoryException
- In all other cases when FileNet throws a run-time error.void deleteContent(ILoginSettings loginSettings, java.lang.String objectStoreName, java.lang.String documentGUIDOrPath) throws RepositoryException
loginSettings
- Required. Configuration settings required to connect to IBM FileNet Repository.
You can authenticate using:
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
).
RepositoryException
- If any of the required parameters are NULL
.
RepositoryException
- If an invalid path or GUID is provided.
RepositoryException
- If user credentials cannot be authenticated.
RepositoryException
- If the user does have delete permissions on the document.
RepositoryException
- In all other cases where FileNet throws a run-time error.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |