Backend (openCRX/Core API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.opencrx.kernel.backend
Class Backend

java.lang.Object
  org.opencrx.kernel.backend.Backend

public class Backend
extends Object
extends Object

Field Summary
`BackendContext`	`context`

Constructor Summary
`Backend()`

Method Summary
`String`	`analyseReport(List report)` Counts the number of occurences of items in report and returns a string of the form item0: n0, item1: n1, etc.
`void`	`createObject(DataproviderObject object)`
`void`	`flushObjectModifications(ServiceHeader header)`
`Accounts`	`getAccounts()`
`Activities`	`getActivities()`
`Addresses`	`getAddresses()`
`Admin`	`getAdmin()`
`Base`	`getBase()`
`Cloneable`	`getCloneable()`
`Codes`	`getCodes()`
`Contracts`	`getContracts()`
`Layer_1_0`	`getDelegatingLayer()`
`RefPackage_1_3`	`getDelegatingPkg()`
`RequestCollection`	`getDelegatingRequests()`
`Depots`	`getDepots()`
`DerivedReferences`	`getDerivedReferences()`
`RefPackage_1_3`	`getLocalPkg()`
`RequestCollection`	`getLocalRequests()`
`Model_1_3`	`getModel()`
`Models`	`getModels()`
`List`	`getNewValue(String feature, DataproviderObject obj, DataproviderObject_1_0 oldValues)`
`Products`	`getProducts()`
`Path`	`getRealmIdentity()`
`RequestCollection`	`getRunAsRootDelegation()`
`ServiceHeader`	`getServiceHeader()`
`String`	`getUidAsString()`
`UserHomes`	`getUserHomes()`
`Workflows`	`getWorkflows()`
`boolean`	`isActivity(DataproviderObject_1_0 object)`
`boolean`	`isActivityGroup(DataproviderObject_1_0 object)`
`boolean`	`isActivityTracker(DataproviderObject_1_0 object)`
`boolean`	`isActivityWorkRecord(DataproviderObject_1_0 object)`
`boolean`	`isContact(DataproviderObject_1_0 object)`
`boolean`	`isContract(DataproviderObject_1_0 object)`
`boolean`	`isContractPosition(DataproviderObject_1_0 object)`
`boolean`	`isDepot(DataproviderObject_1_0 object)`
`boolean`	`isDepotHolder(DataproviderObject_1_0 object)`
`boolean`	`isEffortEstimate(DataproviderObject_1_0 object)`
`boolean`	`isLead(DataproviderObject_1_0 object)`
`boolean`	`isMedia(DataproviderObject_1_0 object)`
`boolean`	`isModelElement(DataproviderObject_1_0 object)`
`boolean`	`isPictured(DataproviderObject_1_0 object)`
`boolean`	`isPropertySetEntry(DataproviderObject_1_0 object)`
`boolean`	`isSecureObject(DataproviderObject_1_0 object)`
`boolean`	`isSegment(DataproviderObject_1_0 object)`
`boolean`	`isUserHome(DataproviderObject_1_0 object)`
`void`	`notifyRemoveObject(Path objectIdentity)` This method is invoked before removing an object.
`void`	`open(BackendContext context)`
`Date`	`parseDate(String date)`
`void`	`preStore(ServiceHeader header, DataproviderObject obj, DataproviderObject_1_0 oldValues)`
`void`	`processPendingModifications(ServiceHeader header)`
`void`	`removeAll(Path forReference, FilterProperty[] includeFilter, int excludeFirst, int limit, Set exclude)`
`void`	`removeObject(Path identity)`
`void`	`replaceObject(ServiceHeader header, DataproviderObject object)`
`DataproviderObject_1_0`	`retrieveObject(Path identity)`
`DataproviderObject`	`retrieveObjectForModification(Path identity)`
`DataproviderObject_1_0`	`retrieveObjectFromDelegation(Path identity)`
`void`	`testObjectIsChangeable(DataproviderObject_1_0 object)`
`String`	`toFilename(String s)`
`void`	`verifyObject(ServiceHeader header, DataproviderObject object)` This method is invoked before storing the object.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

context

public BackendContext context

Constructor Detail

Backend

public Backend()

Method Detail

open

public void open(BackendContext context)

getCodes

public Codes getCodes()
               throws ServiceException

Throws:: ServiceException

getContracts

public Contracts getContracts()

getCloneable

public Cloneable getCloneable()

getDepots

public Depots getDepots()

getProducts

public Products getProducts()

getActivities

public Activities getActivities()

getAdmin

public Admin getAdmin()

getAccounts

public Accounts getAccounts()

getAddresses

public Addresses getAddresses()

getModels

public Models getModels()

getUserHomes

public UserHomes getUserHomes()

getWorkflows

public Workflows getWorkflows()
                       throws ServiceException

Throws:: ServiceException

getBase

public Base getBase()

getDerivedReferences

public DerivedReferences getDerivedReferences()

notifyRemoveObject

public void notifyRemoveObject(Path objectIdentity)
                        throws ServiceException

This method is invoked before removing an object. If this method throws an exception the object will not be removed.

Throws:: ServiceException

isContract

public boolean isContract(DataproviderObject_1_0 object)
                   throws ServiceException

Throws:: ServiceException

isLead

public boolean isLead(DataproviderObject_1_0 object)
               throws ServiceException

Throws:: ServiceException

isContact

public boolean isContact(DataproviderObject_1_0 object)
                  throws ServiceException

Throws:: ServiceException

isPropertySetEntry

public boolean isPropertySetEntry(DataproviderObject_1_0 object)
                           throws ServiceException

Throws:: ServiceException

isDepot

public boolean isDepot(DataproviderObject_1_0 object)
                throws ServiceException

Throws:: ServiceException

isDepotHolder

public boolean isDepotHolder(DataproviderObject_1_0 object)
                      throws ServiceException

Throws:: ServiceException

isMedia

public boolean isMedia(DataproviderObject_1_0 object)
                throws ServiceException

Throws:: ServiceException

isSecureObject

public boolean isSecureObject(DataproviderObject_1_0 object)
                       throws ServiceException

Throws:: ServiceException

isContractPosition

public boolean isContractPosition(DataproviderObject_1_0 object)
                           throws ServiceException

Throws:: ServiceException

isPictured

public boolean isPictured(DataproviderObject_1_0 object)
                   throws ServiceException

Throws:: ServiceException

isSegment

public boolean isSegment(DataproviderObject_1_0 object)
                  throws ServiceException

Throws:: ServiceException

isUserHome

public boolean isUserHome(DataproviderObject_1_0 object)
                   throws ServiceException

Throws:: ServiceException

isActivityTracker

public boolean isActivityTracker(DataproviderObject_1_0 object)
                          throws ServiceException

Throws:: ServiceException

isEffortEstimate

public boolean isEffortEstimate(DataproviderObject_1_0 object)
                         throws ServiceException

Throws:: ServiceException

isActivity

public boolean isActivity(DataproviderObject_1_0 object)
                   throws ServiceException

Throws:: ServiceException

isActivityGroup

public boolean isActivityGroup(DataproviderObject_1_0 object)
                        throws ServiceException

Throws:: ServiceException

isModelElement

public boolean isModelElement(DataproviderObject_1_0 object)
                       throws ServiceException

Throws:: ServiceException

isActivityWorkRecord

public boolean isActivityWorkRecord(DataproviderObject_1_0 object)
                             throws ServiceException

Throws:: ServiceException

getDelegatingRequests

public RequestCollection getDelegatingRequests()

getDelegatingLayer

public Layer_1_0 getDelegatingLayer()

getLocalRequests

public RequestCollection getLocalRequests()

getRunAsRootDelegation

public RequestCollection getRunAsRootDelegation()

getServiceHeader

public ServiceHeader getServiceHeader()

getModel

public Model_1_3 getModel()

getUidAsString

public String getUidAsString()

getLocalPkg

public RefPackage_1_3 getLocalPkg()

getDelegatingPkg

public RefPackage_1_3 getDelegatingPkg()

getRealmIdentity

public Path getRealmIdentity()

getNewValue

public List getNewValue(String feature,
                        DataproviderObject obj,
                        DataproviderObject_1_0 oldValues)
                 throws ServiceException

Throws:: ServiceException

retrieveObjectFromDelegation

public DataproviderObject_1_0 retrieveObjectFromDelegation(Path identity)
                                                    throws ServiceException

Throws:: ServiceException

parseDate

public Date parseDate(String date)
               throws ServiceException

Throws:: ServiceException

retrieveObjectForModification

public DataproviderObject retrieveObjectForModification(Path identity)
                                                 throws ServiceException

Throws:: ServiceException

retrieveObject

public DataproviderObject_1_0 retrieveObject(Path identity)
                                      throws ServiceException

Throws:: ServiceException

replaceObject

public void replaceObject(ServiceHeader header,
                          DataproviderObject object)
                   throws ServiceException

Throws:: ServiceException

createObject

public void createObject(DataproviderObject object)
                  throws ServiceException

Throws:: ServiceException

removeObject

public void removeObject(Path identity)
                  throws ServiceException

Throws:: ServiceException

removeAll

public void removeAll(Path forReference,
                      FilterProperty[] includeFilter,
                      int excludeFirst,
                      int limit,
                      Set exclude)

flushObjectModifications

public void flushObjectModifications(ServiceHeader header)
                              throws ServiceException

Throws:: ServiceException

processPendingModifications

public void processPendingModifications(ServiceHeader header)
                                 throws ServiceException

Throws:: ServiceException

testObjectIsChangeable

public void testObjectIsChangeable(DataproviderObject_1_0 object)
                            throws ServiceException

Throws:: ServiceException

preStore

public void preStore(ServiceHeader header,
                     DataproviderObject obj,
                     DataproviderObject_1_0 oldValues)
              throws ServiceException

Throws:: ServiceException

toFilename

public String toFilename(String s)

verifyObject

public void verifyObject(ServiceHeader header,
                         DataproviderObject object)
                  throws ServiceException

This method is invoked before storing the object. The object can be verified for consistency. A user defined ServiceException must be thrown in case the object must not be stored.

Throws:: ServiceException

analyseReport

public String analyseReport(List report)

Counts the number of occurences of items in report and returns a string of the form item0: n0, item1: n1, etc.