Package mc.core.domain.project.dobj

Class ProjectDO

java.lang.Object

mc.core.system.base.BaseBean

mc.core.domain.base.dobj.AbstractBaseDO<T>

mc.core.domain.base.dobj.AbstractEntityBaseDO<T>

mc.core.domain.base.dobj.AbstractComplexEntityDO<Project>

mc.core.domain.project.dobj.ProjectDO

All Implemented Interfaces:

IBaseDO<Project>

public class ProjectDO
extends AbstractComplexEntityDO<Project>

Nested Class Summary

Nested classes/interfaces inherited from class mc.core.domain.base.dobj.AbstractBaseDO

AbstractBaseDO.Initializer

Constructor Summary

Constructors

Constructor	Description
ProjectDO()

Method Summary

Modifier and Type	Method	Description
Project	copy(Project source, Collection targetCollection)
void	delete(Project entity, boolean force)	NOTE: when overriding this method and you delete any other objects you need to call validateNotUsed before in case flag force is false!
HashMap<Right,List<Locale>>	determineProjectPermission(ProjectPrincipal projectPrincipal)	Specifies the rights, that are set on project
Project	getActiveForUser(User user)
List<Project>	getAllForUser(User user, boolean onlyActive, List<ProjectPrincipal.ProjectPrincipalRole> roles)	searches for projects in which is user in one of given roles
List<Project>	getAllForUser(User user, boolean onlyActive, ProjectPrincipal.ProjectPrincipalRole... roles)
List<ProjectTaskSwimlane>	getEntitySwimlanes(ComplexEntity targetEntity)
List<ProjectTaskSwimlane>	getProjectSwimlanes(Project project)
Project	insert(Project project)
boolean	isCreateNewProjectAllowed()	to override
Project	move(Project source, Collection targetCollection)
ProjectPrincipal	principalAdd(Project project, ProjectPrincipal.ProjectPrincipalRole projectPrincipalRole, Principal principal, User deputyUser)
void	principalRemove(Project project, ProjectPrincipal projectPrincipal)
ProjectPrincipal	principalSave(Project project, ProjectPrincipal projectPrincipal, User deputyUser)
void	projectSetPermissions(Project project, Principal principal, RightType rightType)
ProjectResource	resourceAdd(Project project, ComplexEntity resourceEntity)
void	resourceRemove(ProjectResource resource)
void	resourceRemove(Project project, ComplexEntity resourceEntity)
void	resourceSetActive(Project project, ComplexEntity resourceEntity, boolean active)
List<IProjectResource>	resourcesGetLatestForUser(User user, int count, Class<? extends ComplexEntity> entityClass)
Project	save(Project project, DataMap dataMap)	map data to entity if any, validate and save
void	setActiveForUser(Project project, User user)
void	updateTaskProjectPrincipal(Project project, ProjectPrincipal projectPrincipal)	update tasks
mc.core.domain.project.dobj.ProjectDO.ProjectValidator	validator(Project project, DataMap map)	for persistent entity copy constructor be used, the copy of entity be mapped and validated WARNING: in error case param map be changed! non valid fields be deleted from it all error be collect as ValidationResults in ValidationException and throw only by validate() call Examples to use: 1.

Methods inherited from class mc.core.domain.base.dobj.AbstractComplexEntityDO

addDefaultSearchCriteria, assertPermission, assertPermission, attributes, copy, copyDataSync, copyToCollection, doRecursiveActionAsync, edit, entityProfileApply, entityProfileApply, filter, getCollectionHierarchies, getCollectionsAll, getFromExternalKey, getFromKeySearchFilter, getUserRole, lifecycle, newComplexEntityEvent, onChange, parameter, permissions, prepareSearchFilter, relations, secondaryCollectionAdd, secondaryCollectionCopy, secondaryCollectionMove, secondaryCollectionRemove, setRightInheritanceDisabled, states, translate, versions, watches

Methods inherited from class mc.core.domain.base.dobj.AbstractEntityBaseDO

getFromInternalDescription, sendEvent, sendEvent

Methods inherited from class mc.core.domain.base.dobj.AbstractBaseDO

delete, getAll, getAllActive, getEntityDisplay, getFromId, getFromKey, getOne, map, map, save

Methods inherited from class java.lang.Object

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

Constructor Details

ProjectDO

public ProjectDO()

Method Details

insert

public Project insert(Project project)
               throws ApplicationException

Overrides:

insert in class AbstractComplexEntityDO<Project>

Throws:

ApplicationException

save

public Project save(Project project,
 DataMap dataMap)
             throws ApplicationException

Description copied from interface: IBaseDO

map data to entity if any, validate and save

Specified by:

save in interface IBaseDO<Project>

Overrides:

save in class AbstractEntityBaseDO<Project>

Parameters:

project - mandatory

dataMap - optional

Returns:

mapped entity

Throws:

ApplicationException

delete

public void delete(Project entity,
 boolean force)
            throws ApplicationException

Description copied from class: AbstractBaseDO

NOTE: when overriding this method and you delete any other objects you need to call validateNotUsed before in case flag force is false!

Overrides:

delete in class AbstractComplexEntityDO<Project>

Parameters:

entity - mandatory

force - if true delete without usage check, which can result in db constraints error unless references are taken care of

Throws:

ApplicationException

move

public Project move(Project source,
 Collection targetCollection)
             throws ApplicationException

Throws:

ApplicationException

copy

public Project copy(Project source,
 Collection targetCollection)
             throws ApplicationException

Throws:

ApplicationException

getProjectSwimlanes

public List<ProjectTaskSwimlane> getProjectSwimlanes(Project project)

getEntitySwimlanes

public List<ProjectTaskSwimlane> getEntitySwimlanes(ComplexEntity targetEntity)

principalAdd

public ProjectPrincipal principalAdd(Project project,
 ProjectPrincipal.ProjectPrincipalRole projectPrincipalRole,
 Principal principal,
 User deputyUser)
                              throws ApplicationException

Throws:

ApplicationException

projectSetPermissions

public void projectSetPermissions(Project project,
 Principal principal,
 RightType rightType)
                           throws ApplicationException

Throws:

ApplicationException

resourceAdd

public ProjectResource resourceAdd(Project project,
 ComplexEntity resourceEntity)
                            throws ApplicationException

Throws:

ApplicationException

resourceRemove

public void resourceRemove(Project project,
 ComplexEntity resourceEntity)
                    throws ApplicationException

Throws:

ApplicationException

resourceRemove

public void resourceRemove(ProjectResource resource)
                    throws ApplicationException

Throws:

ApplicationException

resourceSetActive

public void resourceSetActive(Project project,
 ComplexEntity resourceEntity,
 boolean active)
                       throws ApplicationException

Throws:

ApplicationException

principalSave

public ProjectPrincipal principalSave(Project project,
 ProjectPrincipal projectPrincipal,
 User deputyUser)
                               throws ApplicationException

Throws:

ApplicationException

principalRemove

public void principalRemove(Project project,
 ProjectPrincipal projectPrincipal)
                     throws ApplicationException

Throws:

ApplicationException

updateTaskProjectPrincipal

public void updateTaskProjectPrincipal(Project project,
 ProjectPrincipal projectPrincipal)

update tasks

determineProjectPermission

public HashMap<Right,List<Locale>> determineProjectPermission(ProjectPrincipal projectPrincipal)

Specifies the rights, that are set on project

Returns:

Permissions to be set for user on project's.

getActiveForUser

public Project getActiveForUser(User user)

setActiveForUser

public void setActiveForUser(Project project,
 User user)

getAllForUser

public List<Project> getAllForUser(User user,
 boolean onlyActive,
 ProjectPrincipal.ProjectPrincipalRole... roles)

getAllForUser

public List<Project> getAllForUser(User user,
 boolean onlyActive,
 List<ProjectPrincipal.ProjectPrincipalRole> roles)

searches for projects in which is user in one of given roles

Parameters:

user - User mandatory

onlyActive - if true only searches for projects where dateEnded is null

roles - optional: if null searches for projects that have given user in any role

Returns:

list of Project

resourcesGetLatestForUser

public List<IProjectResource> resourcesGetLatestForUser(User user,
 int count,
 Class<? extends ComplexEntity> entityClass)

isCreateNewProjectAllowed

public boolean isCreateNewProjectAllowed()

to override

validator

public mc.core.domain.project.dobj.ProjectDO.ProjectValidator validator(Project project,
 DataMap map)
                                                                 throws ApplicationException

Description copied from class: AbstractBaseDO

for persistent entity copy constructor be used, the copy of entity be mapped and validated
WARNING: in error case param map be changed! non valid fields be deleted from it
all error be collect as ValidationResults in ValidationException and throw only by validate() call
Examples to use:
1. validator( navigationHrc, dataMap).thatValidField( NavigationHrc.Field.navigationHrcType).validate(); 2. validator( navigation, dataMap).thatValidField( Navigation.Field.navigationType, Navigation.Field.navigationHrc) .thatNotNullIf( HrcEntity.Field.parent, n -> n.getNavigationType().getParentNavigationType() != null).validate(); 3. validator( entity, dataMap).thatValidField( Country.Field.iso2Code, "message.validate.Country.iso2Code.missing").thatUnique( Country.Field.iso2Code).validate();

Overrides:

validator in class AbstractBaseDO<Project>

Parameters:

project - mandatory

map - optional

Returns:

the validator

Throws:

ApplicationException - the application exception