org.argeo.connect.core

Class AbstractAppService

java.lang.Object

org.argeo.connect.core.AbstractAppService

All Implemented Interfaces:

AppService

Direct Known Subclasses:

ActivitiesServiceImpl, DefaultSystemAppService, DocumentsServiceImpl, DynamicSystemAppService, PeopleServiceImpl, ResourcesServiceImpl, TrackerServiceImpl

public abstract class AbstractAppService
extends java.lang.Object
implements AppService

Constructor Summary

Constructors

Constructor and Description
AbstractAppService()

Method Summary

Modifier and Type	Method and Description
Node	createDraftEntity(Session session, java.lang.String mainMixin) Convenience method to create a Node with given mixin under the current logged in user home.
java.lang.String	getDisplayName(Node entity) Returns a display name that is app specific and that depends on one or more of the entity properties.
Node	getDraftParent(Session session) Returns (after creation if necessary) the base parent for draft nodes of this application
Node	getEntityByUid(Session session, java.lang.String parentPath, java.lang.String uid) Searches the workspace corresponding to the passed session.
Node	publishEntity(Node parent, java.lang.String nodeType, Node srcNode, boolean removeSrcNode)
Node	saveEntity(Node entity, boolean publish) Try to save and optionally publish a business object after applying context specific rules and special behaviours (typically cache updates).

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.argeo.connect.AppService

getAppBaseName, getBaseRelPath, getDefaultRelPath, getDefaultRelPath, getLabel, getMainNodeType, isKnownType, isKnownType, publishEntity

Constructor Detail

AbstractAppService

public AbstractAppService()

Method Detail

publishEntity

public Node publishEntity(Node parent,
                          java.lang.String nodeType,
                          Node srcNode,
                          boolean removeSrcNode)
                   throws RepositoryException

Specified by:

publishEntity in interface AppService

Throws:

RepositoryException

saveEntity

public Node saveEntity(Node entity,
                       boolean publish)

Try to save and optionally publish a business object after applying context specific rules and special behaviours (typically cache updates).

Specified by:

saveEntity in interface AppService

Parameters:

entity -

publish - also publishes the corresponding node

Returns:

the entity that has been saved (and optionally published): note that in some cases (typically, the first save of a draft node in the business sub tree) the returned node is not the same as the one that has been passed

Throws:

PeopleException - If one of the rule defined for this type is not respected. Use getMessage to display to the user if needed

getDisplayName

public java.lang.String getDisplayName(Node entity)

Returns a display name that is app specific and that depends on one or more of the entity properties. The user can always set a flag to force the value to something else. The Display name is usually stored in the JCR_TITLE property.

Specified by:

getDisplayName in interface AppService

getDraftParent

public Node getDraftParent(Session session)
                    throws RepositoryException

Returns (after creation if necessary) the base parent for draft nodes of this application

Specified by:

getDraftParent in interface AppService

Throws:

RepositoryException

createDraftEntity

public Node createDraftEntity(Session session,
                              java.lang.String mainMixin)
                       throws RepositoryException

Convenience method to create a Node with given mixin under the current logged in user home. Creates a UUID and set the connect:uid properties. The session is not saved.

Specified by:

createDraftEntity in interface AppService

Throws:

RepositoryException

getEntityByUid

public Node getEntityByUid(Session session,
                           java.lang.String parentPath,
                           java.lang.String uid)

Searches the workspace corresponding to the passed session. It returns the corresponding entity or null if none has been found. This UID is implementation specific and is not a JCR Identifier. It will throw a PeopleException if more than one item with this ID has been found

Specified by:

getEntityByUid in interface AppService

Parameters:

session -

parentPath - can be null or empty

uid - the implementation specific UID of the searched entity