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

Interface DocumentService

All Known Subinterfaces:

DocumentServiceLocal

All Known Implementing Classes:

DocumentBean, DocumentBeanImpl

public interface DocumentService

Method Summary

void	addAuthUser(String permission, String primaryKey, String userId)
void	addRelatedObjectRefs(String documentKey, String relatedObjectKey) Adds an association to a RelatedObject instance with the given identifier
String	addRelatedObjectRid(String boRid, String documentKey, String boGuid, String boName)
Document	create(String documentId, String parentFolder)
void	delete(Document input)
List<Document>	findAll()
List<Document>	findByDocumentId(String parentFolder, String documentId)
List<Document>	findByMultipleParameters(List<QueryFilter> mapNameToFilter, Boolean implCheck, String findByName)
List<Document>	findByMultipleParameters(List<QueryFilter> queryFilters, OrderBy orderBy, Paging paging, String findByName)
List<Document>	findByMultipleParameters(QueryFilter[] queryFilters, Boolean implCheck, String findByName)
List<Document>	findByMultipleParameters(QueryFilter[] queryFilters, OrderBy orderBy, Paging paging, String findByName)
List<Document>	findByRid(String rid)
List<Document>	findByTitle(String parentFolder, String title)
Document	getAuthUser(String permission, String primaryKey)
String[]	getRelatedObjectRefs(String documentKey)
Document	read(String key)
String	relateDocument(String srcRid, String dstBOGuid, String dstBOName)
void	removeAuthUser(String permission, String primaryKey, String userId)
void	removeRelatedObjectRefs(String documentKey, String relatedObjectKey) Removes the association to the RelatedObject instance with the given identifier
void	removeRelatedObjectRid(String boRid, String documentKey, String boName)
void	setRelatedObjectRefs(String documentKey, String[] relatedObjectKeys)
void	update(Document input)

Method Detail

create

Document create(String documentId,
                String parentFolder)
                throws CAFCreateException

Throws:

CAFCreateException

read

Document read(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

findByMultipleParameters

List<Document> findByMultipleParameters(List<QueryFilter> mapNameToFilter,
                                        Boolean implCheck,
                                        String findByName)
                                        throws CAFFindException

Throws:

CAFFindException

findAll

List<Document> findAll()
                       throws CAFFindException

Throws:

CAFFindException

addAuthUser

void addAuthUser(String permission,
                 String primaryKey,
                 String userId)
                 throws CAFBONodeException

Throws:

CAFBONodeException

removeAuthUser

void removeAuthUser(String permission,
                    String primaryKey,
                    String userId)
                    throws CAFBONodeException

Throws:

CAFBONodeException

getAuthUser

Document getAuthUser(String permission,
                     String primaryKey)
                     throws CAFBONodeException

Throws:

CAFBONodeException

addRelatedObjectRid

String addRelatedObjectRid(String boRid,
                           String documentKey,
                           String boGuid,
                           String boName)
                           throws CAFUpdateException

Throws:

CAFUpdateException

removeRelatedObjectRid

void removeRelatedObjectRid(String boRid,
                            String documentKey,
                            String boName)
                            throws CAFUpdateException

Throws:

CAFUpdateException

relateDocument

String relateDocument(String srcRid,
                      String dstBOGuid,
                      String dstBOName)
                      throws CAFUpdateException

Throws:

CAFUpdateException

findByTitle

List<Document> findByTitle(String parentFolder,
                           String title)
                           throws CAFFindException

Throws:

CAFFindException

findByDocumentId

List<Document> findByDocumentId(String parentFolder,
                                String documentId)
                                throws CAFFindException

Throws:

CAFFindException

findByRid

List<Document> findByRid(String rid)
                         throws CAFFindException

Throws:

CAFFindException

findByMultipleParameters

List<Document> findByMultipleParameters(List<QueryFilter> queryFilters,
                                        OrderBy orderBy,
                                        Paging paging,
                                        String findByName)
                                        throws CAFFindException

Throws:

CAFFindException

findByMultipleParameters

List<Document> findByMultipleParameters(QueryFilter[] queryFilters,
                                        OrderBy orderBy,
                                        Paging paging,
                                        String findByName)
                                        throws CAFFindException

Throws:

CAFFindException

findByMultipleParameters

List<Document> findByMultipleParameters(QueryFilter[] queryFilters,
                                        Boolean implCheck,
                                        String findByName)
                                        throws CAFFindException

Throws:

CAFFindException

getRelatedObjectRefs

String[] getRelatedObjectRefs(String documentKey)
                              throws CAFRetrieveException

Parameters:

documentKey - Identifier of a Document instance.

Returns:

The identifiers of the associated RelatedObject nodes.

Throws:

CAFRetrieveException

setRelatedObjectRefs

void setRelatedObjectRefs(String documentKey,
                          String[] relatedObjectKeys)
                          throws CAFUpdateException

Parameters:

documentKey - Identifier of a Document instance.

relatedObjectKeys - Identifiers of the RelatedObject instances that are to be associated.

Throws:

CAFUpdateException

addRelatedObjectRefs

void addRelatedObjectRefs(String documentKey,
                          String relatedObjectKey)
                          throws CAFUpdateException

Adds an association to a RelatedObject instance with the given identifier

Parameters:

documentKey - Identifier of a Document instance.

relatedObjectKey - Identifier of a RelatedObject instance that is to be associated

Throws:

CAFUpdateException

removeRelatedObjectRefs

void removeRelatedObjectRefs(String documentKey,
                             String relatedObjectKey)
                             throws CAFUpdateException

Removes the association to the RelatedObject instance with the given identifier

Parameters:

documentKey - Identifier of a Document instance.

relatedObjectKey - Identifier of the associated RelatedObject instance.

Throws:

CAFUpdateException

Access Rights

This class can be accessed from:

SC	DC
[sap.com] CAF	[sap.com] caf/core/ear