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

Class DocumentBean

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

All Implemented Interfaces:

DocumentService, DocumentServiceLocal, IBusinessObjectNodeServiceBase

Direct Known Subclasses:

DocumentBeanImpl

public abstract class DocumentBean
extends com.sap.caf.rt.bol.BusinessObjectNodeServiceBase
implements DocumentServiceLocal

Field Summary

static String	_APPLICATION
static String	_BO_SRV_NAME
protected com.sap.caf.rt.bol.da.IDataAccessService	_dataAccessService
protected EntityManager	_entityManager
static String	_FULLY_QUALIFIED_NAME
protected static String	_JARM_REQUEST
protected static com.sap.tc.logging.Location	_location
static String	_NAMESPACE
static String	_OBJECT_NAME
static String	_OBJECT_TYPE
static String	_objectGuid
static String	_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

DocumentBean()

Method Summary

protected void	_destroy()
protected void	_init()
void	addAuthUser(String permission, String primaryKey, String userId)
void	addRelatedObjectRefs(String sourceKey, String targetKey) Adds an association to a RelatedObject instance with the given identifier
String	addRelatedObjectRid(String boRid, String documentKey, String boGuid, String boName)
protected boolean	checkPermission(String permission, IBusinessObjectNodeBase object, String user, String objectName)
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> queryFilters, 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 sourceKey)
Document	read(String key)
String	relateDocument(String srcRid, String dstBOGuid, String dstBOName)
void	removeAuthUser(String permission, String primaryKey, String userId)
void	removeRelatedObjectRefs(String sourceKey, String targetKey) Removes the association to the RelatedObject instance with the given identifier
void	removeRelatedObjectRid(String boRid, String documentKey, String boName)
void	setRelatedObjectRefs(String sourceKey, String[] targetKeys)
void	update(Document input)

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

Field Detail

_objectGuid

public static final String _objectGuid

See Also:

Constant Field Values

_PROVIDER

public static final String _PROVIDER

See Also:

Constant Field Values

_APPLICATION

public static final String _APPLICATION

See Also:

Constant Field Values

_BO_SRV_NAME

public static final String _BO_SRV_NAME

See Also:

Constant Field Values

_NAMESPACE

public static final String _NAMESPACE

See Also:

Constant Field Values

_FULLY_QUALIFIED_NAME

public static final String _FULLY_QUALIFIED_NAME

See Also:

Constant Field Values

_OBJECT_NAME

public static final String _OBJECT_NAME

See Also:

Constant Field Values

_OBJECT_TYPE

public static final String _OBJECT_TYPE

See Also:

Constant Field Values

_JARM_REQUEST

protected static final String _JARM_REQUEST

See Also:

Constant Field Values

_location

protected static final com.sap.tc.logging.Location _location

_dataAccessService

protected com.sap.caf.rt.bol.da.IDataAccessService _dataAccessService

_entityManager

protected EntityManager _entityManager

Constructor Detail

DocumentBean

public DocumentBean()

Method Detail

_init

@PostConstruct
protected void _init()

_destroy

@PreDestroy
protected void _destroy()

create

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

Specified by:

create in interface DocumentService

Throws:

CAFCreateException

read

public Document read(String key)
              throws CAFRetrieveException

Specified by:

read in interface DocumentService

Throws:

CAFRetrieveException

update

public void update(Document input)
            throws CAFUpdateException,
                   CAFOptimisticLockException,
                   CAFPessimisticLockException

Specified by:

update in interface DocumentService

Throws:

CAFUpdateException

CAFOptimisticLockException

CAFPessimisticLockException

delete

public void delete(Document input)
            throws CAFDeleteException,
                   CAFOptimisticLockException,
                   CAFPessimisticLockException

Specified by:

delete in interface DocumentService

Throws:

CAFDeleteException

CAFOptimisticLockException

CAFPessimisticLockException

findAll

public List<Document> findAll()
                       throws CAFFindException

Specified by:

findAll in interface DocumentService

Throws:

CAFFindException

addAuthUser

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

Specified by:

addAuthUser in interface DocumentService

Throws:

CAFBONodeException

removeAuthUser

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

Specified by:

removeAuthUser in interface DocumentService

Throws:

CAFBONodeException

getAuthUser

public Document getAuthUser(String permission,
                            String primaryKey)
                     throws CAFBONodeException

Specified by:

getAuthUser in interface DocumentService

Throws:

CAFBONodeException

addRelatedObjectRid

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

Specified by:

addRelatedObjectRid in interface DocumentService

Throws:

CAFUpdateException

removeRelatedObjectRid

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

Specified by:

removeRelatedObjectRid in interface DocumentService

Throws:

CAFUpdateException

relateDocument

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

Specified by:

relateDocument in interface DocumentService

Throws:

CAFUpdateException

findByTitle

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

Specified by:

findByTitle in interface DocumentService

Throws:

CAFFindException

findByDocumentId

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

Specified by:

findByDocumentId in interface DocumentService

Throws:

CAFFindException

findByRid

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

Specified by:

findByRid in interface DocumentService

Throws:

CAFFindException

getRelatedObjectRefs

public String[] getRelatedObjectRefs(String sourceKey)
                              throws CAFRetrieveException

Specified by:

getRelatedObjectRefs in interface DocumentService

Parameters:

sourceKey - Identifier of a Document instance.

Returns:

The identifiers of the associated RelatedObject nodes.

Throws:

CAFRetrieveException

setRelatedObjectRefs

public void setRelatedObjectRefs(String sourceKey,
                                 String[] targetKeys)
                          throws CAFUpdateException

Specified by:

setRelatedObjectRefs in interface DocumentService

Parameters:

sourceKey - Identifier of a Document instance.

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

Throws:

CAFUpdateException

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

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

Parameters:

sourceKey - Identifier of a Document instance.

targetKey - Identifier of the associated RelatedObject instance.

Throws:

CAFUpdateException

findByMultipleParameters

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

Specified by:

findByMultipleParameters in interface DocumentService

Throws:

CAFFindException

findByMultipleParameters

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

Specified by:

findByMultipleParameters in interface DocumentService

Throws:

CAFFindException

findByMultipleParameters

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

Specified by:

findByMultipleParameters in interface DocumentService

Throws:

CAFFindException

findByMultipleParameters

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

Specified by:

findByMultipleParameters in interface DocumentService

Throws:

CAFFindException

checkPermission

protected boolean checkPermission(String permission,
                                  IBusinessObjectNodeBase object,
                                  String user,
                                  String objectName)

Overrides:

checkPermission in class com.sap.caf.rt.bol.BusinessObjectNodeServiceBase

Access Rights

This class can be accessed from:

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