com.atlassian.jira.scheme
Class AbstractSchemeManager

java.lang.Object
  com.atlassian.jira.scheme.AbstractSchemeManager

All Implemented Interfaces:

SchemeManager

Direct Known Subclasses:

DefaultNotificationSchemeManager, DefaultPermissionSchemeManager, DefaultWorkflowSchemeManager, IssueSecuritySchemeManagerImpl

public abstract class AbstractSchemeManager

extends Object

implements SchemeManager

Field Summary

protected ProjectManager

projectManager

Fields inherited from interface com.atlassian.jira.scheme.SchemeManager

PROJECT_ASSOCIATION

Constructor Summary

protected

AbstractSchemeManager(ProjectManager projectManager)

Method Summary

void	addDefaultSchemeToProject(org.ofbiz.core.entity.GenericValue project) Adds the default scheme to a particular project
void	addSchemeToProject(org.ofbiz.core.entity.GenericValue project, org.ofbiz.core.entity.GenericValue scheme) Adds a scheme to a particular project
org.ofbiz.core.entity.GenericValue	copyScheme(org.ofbiz.core.entity.GenericValue scheme) Copys a scheme, giving the new scheme the same entities as the original one
abstract org.ofbiz.core.entity.GenericValue	copySchemeEntity(org.ofbiz.core.entity.GenericValue scheme, org.ofbiz.core.entity.GenericValue entity)
org.ofbiz.core.entity.GenericValue	createDefaultScheme() Creates a default scheme, with an id of 0
org.ofbiz.core.entity.GenericValue	createScheme(String name, String description) Creates a new scheme
void	deleteEntity(Long id) Deletes an entity from the database
void	deleteScheme(Long id) Deletes a scheme from the database
abstract String	getAssociationType()
org.ofbiz.core.entity.GenericValue	getDefaultScheme() Gets the default scheme.
List	getEntities(org.ofbiz.core.entity.GenericValue scheme) Get all Scheme entity records for a particular scheme
List	getEntities(String parameter) Get all entity records with a particular parameter
org.ofbiz.core.entity.GenericValue	getEntity(Long id) Gets a scheme entity based on the id of the entity
abstract String	getEntityName()
Collection	getGroups(Long entityTypeId, org.ofbiz.core.entity.GenericValue project)
protected org.ofbiz.core.entity.GenericValue	getProjectAndValidate(org.ofbiz.core.entity.GenericValue projectOrIssue)
List	getProjects(org.ofbiz.core.entity.GenericValue scheme) Gets all projects that are associated with that scheme
org.ofbiz.core.entity.GenericValue	getScheme(Long id) Gets a scheme based on the Id of the scheme
org.ofbiz.core.entity.GenericValue	getScheme(String name) Gets a scheme based on the name of the scheme
abstract String	getSchemeDesc()
abstract String	getSchemeEntityName()
List	getSchemes() Gets all the Schemes of a certain type in the database
List	getSchemes(org.ofbiz.core.entity.GenericValue project) Get all schemes of a certain type attached to a project.
Collection	getUsers(Long permissionId, org.ofbiz.core.entity.GenericValue projectOrIssue) Retrieves a list of users that have current permission in a project (e.g.
boolean	removeEntities(org.ofbiz.core.entity.GenericValue scheme, Long entityTypeId) Retrieves all the entites for this permissio and then removes them.
boolean	removeEntities(String parameter) Removes all scheme entities with this parameter
void	removeSchemesFromProject(org.ofbiz.core.entity.GenericValue project) Removes all schemes from a project
boolean	schemeExists(String name) Determine if the scheme exists
void	updateScheme(org.ofbiz.core.entity.GenericValue entity) Updates any changes to the scheme

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.atlassian.jira.scheme.SchemeManager

createSchemeEntity, getEntities, getEntities, getEntities, getEntities, hasSchemeAuthority, hasSchemeAuthority

Field Detail

projectManager

protected final ProjectManager projectManager

Constructor Detail

AbstractSchemeManager

protected AbstractSchemeManager(ProjectManager projectManager)

Method Detail

getSchemeEntityName

public abstract String getSchemeEntityName()

getEntityName

public abstract String getEntityName()

getSchemeDesc

public abstract String getSchemeDesc()

getAssociationType

public abstract String getAssociationType()

copySchemeEntity

public abstract org.ofbiz.core.entity.GenericValue copySchemeEntity(org.ofbiz.core.entity.GenericValue scheme,
                                                                    org.ofbiz.core.entity.GenericValue entity)
                                                             throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getScheme

public org.ofbiz.core.entity.GenericValue getScheme(Long id)
                                             throws org.ofbiz.core.entity.GenericEntityException

Gets a scheme based on the Id of the scheme

Specified by:

getScheme in interface SchemeManager

Parameters:

id - Id of the scheme

Returns:

The scheme

Throws:

org.ofbiz.core.entity.GenericEntityException

getScheme

public org.ofbiz.core.entity.GenericValue getScheme(String name)
                                             throws org.ofbiz.core.entity.GenericEntityException

Gets a scheme based on the name of the scheme

Specified by:

getScheme in interface SchemeManager

Parameters:

name - Name of the scheme

Returns:

The scheme

Throws:

org.ofbiz.core.entity.GenericEntityException

getSchemes

public List getSchemes()
                throws org.ofbiz.core.entity.GenericEntityException

Gets all the Schemes of a certain type in the database

Specified by:

getSchemes in interface SchemeManager

Returns:

List of schemes

Throws:

org.ofbiz.core.entity.GenericEntityException

getSchemes

public List getSchemes(org.ofbiz.core.entity.GenericValue project)
                throws org.ofbiz.core.entity.GenericEntityException

Get all schemes of a certain type attached to a project.

This method may be overridden if you want to return a default value for projects without a scheme associated.

Specified by:

getSchemes in interface SchemeManager

Parameters:

project - The project that the schemes are attached to

Returns:

List of schemes

Throws:

org.ofbiz.core.entity.GenericEntityException

getEntity

public org.ofbiz.core.entity.GenericValue getEntity(Long id)
                                             throws org.ofbiz.core.entity.GenericEntityException

Gets a scheme entity based on the id of the entity

Specified by:

getEntity in interface SchemeManager

Parameters:

id - The id of the entity

Returns:

The scheme entity object

Throws:

org.ofbiz.core.entity.GenericEntityException

getEntities

public List getEntities(String parameter)
                 throws org.ofbiz.core.entity.GenericEntityException

Get all entity records with a particular parameter

Specified by:

getEntities in interface SchemeManager

Parameters:

parameter - The parameter in the entity

Returns:

List of (GenericValue) entities

Throws:

org.ofbiz.core.entity.GenericEntityException

getEntities

public List getEntities(org.ofbiz.core.entity.GenericValue scheme)
                 throws org.ofbiz.core.entity.GenericEntityException

Get all Scheme entity records for a particular scheme

Specified by:

getEntities in interface SchemeManager

Parameters:

scheme - The scheme that the entities belong to

Returns:

List of (GenericValue) entities

Throws:

org.ofbiz.core.entity.GenericEntityException

schemeExists

public boolean schemeExists(String name)
                     throws org.ofbiz.core.entity.GenericEntityException

Determine if the scheme exists

Specified by:

schemeExists in interface SchemeManager

Parameters:

name - The name of the scheme

Returns:

True / False

Throws:

org.ofbiz.core.entity.GenericEntityException

createScheme

public org.ofbiz.core.entity.GenericValue createScheme(String name,
                                                       String description)
                                                throws org.ofbiz.core.entity.GenericEntityException

Creates a new scheme

Specified by:

createScheme in interface SchemeManager

Parameters:

name - The name of the new scheme

description - The description of the new scheme

Returns:

The new scheme object

Throws:

org.ofbiz.core.entity.GenericEntityException

updateScheme

public void updateScheme(org.ofbiz.core.entity.GenericValue entity)
                  throws org.ofbiz.core.entity.GenericEntityException

Updates any changes to the scheme

Specified by:

updateScheme in interface SchemeManager

Parameters:

entity - The modified scheme

Throws:

org.ofbiz.core.entity.GenericEntityException

deleteScheme

public void deleteScheme(Long id)
                  throws org.ofbiz.core.entity.GenericEntityException

Deletes a scheme from the database

Specified by:

deleteScheme in interface SchemeManager

Parameters:

id - Id of the scheme to be deleted

Throws:

org.ofbiz.core.entity.GenericEntityException

addSchemeToProject

public void addSchemeToProject(org.ofbiz.core.entity.GenericValue project,
                               org.ofbiz.core.entity.GenericValue scheme)
                        throws org.ofbiz.core.entity.GenericEntityException

Adds a scheme to a particular project

Specified by:

addSchemeToProject in interface SchemeManager

Parameters:

project - The project that the scheme is to be added to

scheme - The scheme to be added

Throws:

org.ofbiz.core.entity.GenericEntityException

removeSchemesFromProject

public void removeSchemesFromProject(org.ofbiz.core.entity.GenericValue project)
                              throws org.ofbiz.core.entity.GenericEntityException

Removes all schemes from a project

Specified by:

removeSchemesFromProject in interface SchemeManager

Parameters:

project - The project that all schemes are to be deleted from

Throws:

org.ofbiz.core.entity.GenericEntityException

deleteEntity

public void deleteEntity(Long id)
                  throws org.ofbiz.core.entity.GenericEntityException

Deletes an entity from the database

Specified by:

deleteEntity in interface SchemeManager

Parameters:

id - The id of the entity to be deleted

Throws:

org.ofbiz.core.entity.GenericEntityException

getProjects

public List getProjects(org.ofbiz.core.entity.GenericValue scheme)
                 throws org.ofbiz.core.entity.GenericEntityException

Gets all projects that are associated with that scheme

Specified by:

getProjects in interface SchemeManager

Parameters:

scheme - The scheme used to get all projects

Returns:

List of (GenericValue) projects

Throws:

org.ofbiz.core.entity.GenericEntityException

createDefaultScheme

public org.ofbiz.core.entity.GenericValue createDefaultScheme()
                                                       throws org.ofbiz.core.entity.GenericEntityException

Creates a default scheme, with an id of 0

Specified by:

createDefaultScheme in interface SchemeManager

Returns:

The new permission scheme object

Throws:

org.ofbiz.core.entity.GenericEntityException

removeEntities

public boolean removeEntities(String parameter)
                       throws RemoveException

Removes all scheme entities with this parameter

Specified by:

removeEntities in interface SchemeManager

Parameters:

parameter - must NOT be null

Throws:

RemoveException

removeEntities

public boolean removeEntities(org.ofbiz.core.entity.GenericValue scheme,
                              Long entityTypeId)
                       throws RemoveException

Retrieves all the entites for this permissio and then removes them.

Specified by:

removeEntities in interface SchemeManager

Parameters:

scheme - to remove entites from must NOT be null

entityTypeId - to remove

Returns:

True is all the entities are removed

Throws:

RemoveException

getDefaultScheme

public org.ofbiz.core.entity.GenericValue getDefaultScheme()
                                                    throws org.ofbiz.core.entity.GenericEntityException

Gets the default scheme. This should have an id of 0

Specified by:

getDefaultScheme in interface SchemeManager

Returns:

The default scheme

Throws:

org.ofbiz.core.entity.GenericEntityException

addDefaultSchemeToProject

public void addDefaultSchemeToProject(org.ofbiz.core.entity.GenericValue project)
                               throws org.ofbiz.core.entity.GenericEntityException

Adds the default scheme to a particular project

Specified by:

addDefaultSchemeToProject in interface SchemeManager

Parameters:

project - The project that the scheme is to be added to

Throws:

org.ofbiz.core.entity.GenericEntityException

copyScheme

public org.ofbiz.core.entity.GenericValue copyScheme(org.ofbiz.core.entity.GenericValue scheme)
                                              throws org.ofbiz.core.entity.GenericEntityException

Copys a scheme, giving the new scheme the same entities as the original one

Specified by:

copyScheme in interface SchemeManager

Parameters:

scheme - The permission scheme to be copied

Returns:

The new permission scheme

Throws:

org.ofbiz.core.entity.GenericEntityException

getGroups

public Collection getGroups(Long entityTypeId,
                            org.ofbiz.core.entity.GenericValue project)

Specified by:

getGroups in interface SchemeManager

getUsers

public Collection getUsers(Long permissionId,
                           org.ofbiz.core.entity.GenericValue projectOrIssue)

Retrieves a list of users that have current permission in a project (e.g. projects schemes)

Specified by:

getUsers in interface SchemeManager

Parameters:

permissionId -

projectOrIssue -

getProjectAndValidate

protected org.ofbiz.core.entity.GenericValue getProjectAndValidate(org.ofbiz.core.entity.GenericValue projectOrIssue)