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

Class DocumentBeanImpl

java.lang.Object
  com.sap.caf.rt.bol.BusinessObjectNodeServiceBase
      com.sap.caf.core.services.bonode.document.document.DocumentBean
          com.sap.caf.core.services.bonode.document.document.DocumentBeanImpl

All Implemented Interfaces:

DocumentService, DocumentServiceLocal, IBusinessObjectNodeServiceBase

public class DocumentBeanImpl
extends DocumentBean

Field Summary

Fields inherited from class com.sap.caf.core.services.bonode.document.document.DocumentBean

_APPLICATION, _BO_SRV_NAME, _dataAccessService, _entityManager, _FULLY_QUALIFIED_NAME, _JARM_REQUEST, _location, _NAMESPACE, _OBJECT_NAME, _OBJECT_TYPE, _objectGuid, _PROVIDER

Fields inherited from class com.sap.caf.rt.bol.BusinessObjectNodeServiceBase

_objectName, sessionContext

Fields inherited from interface com.sap.caf.rt.bol.IBusinessObjectNodeServiceBase

MODE_READ, MODE_WRITE

Constructor Summary

DocumentBeanImpl()

Method Summary

void	addRelatedObjectRefs(String sourceKey, String targetKey) Adds an association to a RelatedObject instance with the given identifier
Document	create(String documentId, String parentFolder) Create a new document instance by given parentFolder and documentId.
void	delete(Document document)
List<Document>	findAll()
List<Document>	findByDocumentId(String parentFolder, String documentId)
Collection<Document>	findByDocumentKey(QueryFilter key)
Collection<Document>	findByMultipleParameters(QueryFilter[] queryFilters, boolean implCheck, String findByName)
List<Document>	findByRid(String rid)
List<Document>	findByTitle(QueryFilter title, QueryFilter parentFolder)
String[]	getRelatedObjectRefs(String sourceKey)
Document	read(String key) The method gets document by its CAF key.
void	removeRelatedObjectRefs(String sourceKey, String targetKey) Removes the association to the RelatedObject instance with the given identifier
void	update(Document document)

Methods inherited from class com.sap.caf.core.services.bonode.document.document.DocumentBean

_destroy, _init, addAuthUser, addRelatedObjectRid, checkPermission, findByMultipleParameters, findByMultipleParameters, findByMultipleParameters, findByMultipleParameters, findByTitle, getAuthUser, relateDocument, removeAuthUser, removeRelatedObjectRid, setRelatedObjectRefs

Methods inherited from class com.sap.caf.rt.bol.BusinessObjectNodeServiceBase

almostEqual, almostEqual, assertLocking, checkPermission, createGeneric, createWithKeyGeneric, deleteGeneric, findByKMPropertySearch, findGeneric, getCurrentOwner, getLogonLanguage, lock, lock, readGeneric, transformForFindByMultipleParams, unlock, unlock, updateGeneric

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sap.caf.rt.bol.IBusinessObjectNodeServiceBase

assertLocking, createGeneric, createWithKeyGeneric, deleteGeneric, findGeneric, getCurrentOwner, lock, lock, readGeneric, unlock, unlock, updateGeneric

Constructor Detail

DocumentBeanImpl

public DocumentBeanImpl()

Method Detail

delete

public void delete(Document document)
            throws CAFDeleteException

Specified by:

delete in interface DocumentService

Overrides:

delete in class DocumentBean

Throws:

CAFDeleteException

update

public void update(Document document)
            throws CAFUpdateException

Specified by:

update in interface DocumentService

Overrides:

update in class DocumentBean

Throws:

CAFUpdateException

findAll

public List<Document> findAll()
                       throws CAFFindException

Specified by:

findAll in interface DocumentService

Overrides:

findAll in class DocumentBean

Throws:

CAFFindException

read

public Document read(String key)
              throws CAFRetrieveException

The method gets document by its CAF key.

Specified by:

read in interface DocumentService

Overrides:

read in class DocumentBean

Parameters:

key - A key of a document

Returns:

document instance

Throws:

CAFRetrieveException

create

public Document create(String documentId,
                       String parentFolder)
                throws CAFCreateException

Create a new document instance by given parentFolder and documentId. If parentFolder is null, temporary folder will be used.

Specified by:

create in interface DocumentService

Overrides:

create in class DocumentBean

Parameters:

parentFolder - KM parent folder RID, if null temp folder will be used

documentId - An id of the document, it's used as a default title. If parentFolder is null, i.e. document is uploaded to the temp folder, the document key is used as a perfix for real document id, It means the whole rid will be: //-documentId, if parentFolder is null and /parentFolder/documentId otherwise.

Returns:

The new document instance

Throws:

CAFCreateException

getRelatedObjectRefs

public String[] getRelatedObjectRefs(String sourceKey)
                              throws CAFRetrieveException

Specified by:

getRelatedObjectRefs in interface DocumentService

Overrides:

getRelatedObjectRefs in class DocumentBean

Parameters:

sourceKey - Identifier of a Document instance.

Returns:

The identifiers of the associated RelatedObject nodes.

Throws:

CAFRetrieveException

addRelatedObjectRefs

public void addRelatedObjectRefs(String sourceKey,
                                 String targetKey)
                          throws CAFUpdateException

Description copied from interface: DocumentService

Adds an association to a RelatedObject instance with the given identifier

Specified by:

addRelatedObjectRefs in interface DocumentService

Overrides:

addRelatedObjectRefs in class DocumentBean

Parameters:

sourceKey - Identifier of a Document instance.

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

Throws:

CAFUpdateException

removeRelatedObjectRefs

public void removeRelatedObjectRefs(String sourceKey,
                                    String targetKey)
                             throws CAFUpdateException

Description copied from interface: DocumentService

Removes the association to the RelatedObject instance with the given identifier

Specified by:

removeRelatedObjectRefs in interface DocumentService

Overrides:

removeRelatedObjectRefs in class DocumentBean

Parameters:

sourceKey - Identifier of a Document instance.

targetKey - Identifier of the associated RelatedObject instance.

Throws:

CAFUpdateException

findByDocumentKey

public Collection<Document> findByDocumentKey(QueryFilter key)
                                       throws CAFFindException

Throws:

CAFFindException

See Also:

DocumentLocal#findByDocumentKey(com.sap.caf.rt.bol.util.QueryFilter)

findByTitle

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

Throws:

CAFFindException

See Also:

DocumentLocal#findByTitle(com.sap.caf.rt.bol.util.QueryFilter, com.sap.caf.rt.bol.util.QueryFilter)

findByDocumentId

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

Specified by:

findByDocumentId in interface DocumentService

Overrides:

findByDocumentId in class DocumentBean

Throws:

CAFFindException

See Also:

DocumentLocal#findByDocumentId(com.sap.caf.rt.bol.util.QueryFilter, com.sap.caf.rt.bol.util.QueryFilter)

findByRid

public List<Document> findByRid(String rid)
                         throws CAFFindException

Specified by:

findByRid in interface DocumentService

Overrides:

findByRid in class DocumentBean

Throws:

CAFFindException

See Also:

DocumentLocal#findByRid(com.sap.caf.rt.bol.util.QueryFilter)

findByMultipleParameters

public Collection<Document> findByMultipleParameters(QueryFilter[] queryFilters,
                                                     boolean implCheck,
                                                     String findByName)
                                              throws CAFFindException

Throws:

CAFFindException

Access Rights

This class can be accessed from:

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