com.sap.caf.core.services.bonode.document.document
Interface DocumentService

All Known Subinterfaces:

DocumentServiceLocal

public interface DocumentService

Method Summary

void	addAuthUser(java.lang.String permission, java.lang.String primaryKey, java.lang.String userId)
void	addRelatedObjectRefs(java.lang.String sourceKey, java.lang.String targetKey) Adds an association to a RelatedObjectRefs with the given identifier
java.lang.String	addRelatedObjectRid(java.lang.String boRid, java.lang.String documentKey, java.lang.String boGuid, java.lang.String boName)
Document	create(java.lang.String documentId, java.lang.String parentFolder)
void	delete(Document Input)
java.util.Collection<Document>	findAll()
java.util.Collection<Document>	findByDocumentId(java.lang.String parentFolder, java.lang.String documentId)
java.util.Collection<Document>	findByMultipleParameters(QueryFilter[] queryFilters, boolean implCheck, java.lang.String findByName)
java.util.Collection<Document>	findByRid(java.lang.String rid)
java.util.Collection<Document>	findByTitle(java.lang.String parentFolder, java.lang.String title)
Document	getAuthUser(java.lang.String permission, java.lang.String primaryKey)
java.lang.String[]	getRelatedObjectRefs(java.lang.String sourceKey)
Document	read(java.lang.String key)
java.lang.String	relateDocument(java.lang.String srcRid, java.lang.String dstBOGuid, java.lang.String dstBOName)
void	removeAuthUser(java.lang.String permission, java.lang.String primaryKey, java.lang.String userId)
void	removeRelatedObjectRefs(java.lang.String sourceKey, java.lang.String targetKey) Removes the association to a RelatedObjectRefs with the given identifier
void	removeRelatedObjectRid(java.lang.String boRid, java.lang.String documentKey, java.lang.String boName)
void	setRelatedObjectRefs(java.lang.String sourceKey, java.lang.String[] targetKeys)
void	update(Document Input)

Method Detail

create

Document create(java.lang.String documentId,
                java.lang.String parentFolder)
                throws CAFCreateException

Throws:

CAFCreateException

read

Document read(java.lang.String key)
              throws CAFRetrieveException

Throws:

CAFRetrieveException

update

void update(Document Input)
            throws CAFUpdateException,
                   CAFOptimisticLockException,
                   CAFPessimisticLockException

Throws:

CAFUpdateException

CAFOptimisticLockException

CAFPessimisticLockException

delete

void delete(Document Input)
            throws CAFDeleteException,
                   CAFOptimisticLockException,
                   CAFPessimisticLockException

Throws:

CAFDeleteException

CAFOptimisticLockException

CAFPessimisticLockException

findAll

java.util.Collection<Document> findAll()
                                       throws CAFFindException

Throws:

CAFFindException

addAuthUser

void addAuthUser(java.lang.String permission,
                 java.lang.String primaryKey,
                 java.lang.String userId)
                 throws CAFBONodeException

Throws:

CAFBONodeException

removeAuthUser

void removeAuthUser(java.lang.String permission,
                    java.lang.String primaryKey,
                    java.lang.String userId)
                    throws CAFBONodeException

Throws:

CAFBONodeException

getAuthUser

Document getAuthUser(java.lang.String permission,
                     java.lang.String primaryKey)
                     throws CAFBONodeException

Throws:

CAFBONodeException

addRelatedObjectRid

java.lang.String addRelatedObjectRid(java.lang.String boRid,
                                     java.lang.String documentKey,
                                     java.lang.String boGuid,
                                     java.lang.String boName)
                                     throws CAFUpdateException

Throws:

CAFUpdateException

removeRelatedObjectRid

void removeRelatedObjectRid(java.lang.String boRid,
                            java.lang.String documentKey,
                            java.lang.String boName)
                            throws CAFUpdateException

Throws:

CAFUpdateException

relateDocument

java.lang.String relateDocument(java.lang.String srcRid,
                                java.lang.String dstBOGuid,
                                java.lang.String dstBOName)
                                throws CAFUpdateException

Throws:

CAFUpdateException

findByTitle

java.util.Collection<Document> findByTitle(java.lang.String parentFolder,
                                           java.lang.String title)
                                           throws CAFFindException

Throws:

CAFFindException

findByDocumentId

java.util.Collection<Document> findByDocumentId(java.lang.String parentFolder,
                                                java.lang.String documentId)
                                                throws CAFFindException

Throws:

CAFFindException

findByRid

java.util.Collection<Document> findByRid(java.lang.String rid)
                                         throws CAFFindException

Throws:

CAFFindException

findByMultipleParameters

java.util.Collection<Document> findByMultipleParameters(QueryFilter[] queryFilters,
                                                        boolean implCheck,
                                                        java.lang.String findByName)
                                                        throws CAFFindException

Throws:

CAFFindException

getRelatedObjectRefs

java.lang.String[] getRelatedObjectRefs(java.lang.String sourceKey)
                                        throws CAFRetrieveException

Parameters:

sourceKey - The BO Node identifier

Returns:

The identifiers of the associated RelatedObject nodes.

Throws:

CAFRetrieveException

setRelatedObjectRefs

void setRelatedObjectRefs(java.lang.String sourceKey,
                          java.lang.String[] targetKeys)
                          throws CAFUpdateException

Parameters:

sourceKey - The BO Node identifier

targetKeys - Identifiers of a RelatedObjectRefs that is to be associated

Throws:

CAFUpdateException

addRelatedObjectRefs

void addRelatedObjectRefs(java.lang.String sourceKey,
                          java.lang.String targetKey)
                          throws CAFUpdateException

Adds an association to a RelatedObjectRefs with the given identifier

Parameters:

sourceKey - The BO Node identifier

targetKey - Identifier of a RelatedObjectRefs that is to be associated

Throws:

CAFUpdateException

removeRelatedObjectRefs

void removeRelatedObjectRefs(java.lang.String sourceKey,
                             java.lang.String targetKey)
                             throws CAFUpdateException

Removes the association to a RelatedObjectRefs with the given identifier

Parameters:

sourceKey - The BO Node identifier

targetKey - Identifier of a RelatedObjectRefs.

Throws:

CAFUpdateException