com.atlassian.jira.scheme
Interface SchemeManager

All Known Subinterfaces:

IssueSecuritySchemeManager, NotificationSchemeManager, PermissionSchemeManager, WorkflowSchemeManager

All Known Implementing Classes:

AbstractSchemeManager, DefaultNotificationSchemeManager, DefaultPermissionSchemeManager, DefaultWorkflowSchemeManager, IssueSecuritySchemeManagerImpl, WorkflowBasedPermissionSchemeManager

public interface SchemeManager

Field Summary

static String

PROJECT_ASSOCIATION The one and only "association type".

Method Summary

void	addDefaultSchemeToProject(org.ofbiz.core.entity.GenericValue project) Deprecated. Use addDefaultSchemeToProject(com.atlassian.jira.project.Project) instead. Since v5.0.
void	addDefaultSchemeToProject(Project project) Adds the default scheme to a particular project
void	addSchemeToProject(org.ofbiz.core.entity.GenericValue project, org.ofbiz.core.entity.GenericValue scheme) Deprecated. Use addSchemeToProject(com.atlassian.jira.project.Project, Scheme) instead. Since v5.0.
void	addSchemeToProject(Project project, Scheme scheme) Adds a scheme to a particular project
org.ofbiz.core.entity.GenericValue	copyScheme(org.ofbiz.core.entity.GenericValue scheme) Deprecated. Use copyScheme(Scheme) instead. Since v5.0.
Scheme	copyScheme(Scheme scheme) Copys a scheme, giving the new scheme the same entities as the original one
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) Deprecated. Use createSchemeObject(String, String) instead. Since v5.0.
Scheme	createSchemeAndEntities(Scheme scheme)
org.ofbiz.core.entity.GenericValue	createSchemeEntity(org.ofbiz.core.entity.GenericValue scheme, SchemeEntity entity)
Scheme	createSchemeObject(String name, String description) Creates a new scheme
void	deleteEntity(Long id) Deletes an entity with the given id from the database.
void	deleteScheme(Long id) Deletes a scheme from the database
List<Scheme>	getAssociatedSchemes(boolean withEntitiesComparable) Gets all schemes of this type in the database taht are associated with at least one project.
org.ofbiz.core.entity.GenericValue	getDefaultScheme() Deprecated. Use getDefaultSchemeObject() instead. Since v5.0.
Scheme	getDefaultSchemeObject() Gets the default scheme.
List<org.ofbiz.core.entity.GenericValue>	getEntities(org.ofbiz.core.entity.GenericValue scheme) Get all Scheme entity records for a particular scheme
List<org.ofbiz.core.entity.GenericValue>	getEntities(org.ofbiz.core.entity.GenericValue scheme, Long entityTypeId)
List<org.ofbiz.core.entity.GenericValue>	getEntities(org.ofbiz.core.entity.GenericValue scheme, Long entityTypeId, String parameter)
List<org.ofbiz.core.entity.GenericValue>	getEntities(org.ofbiz.core.entity.GenericValue scheme, String entityTypeId)
List<org.ofbiz.core.entity.GenericValue>	getEntities(org.ofbiz.core.entity.GenericValue scheme, String type, Long entityTypeId)
List<org.ofbiz.core.entity.GenericValue>	getEntities(String type, 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
Collection<com.atlassian.crowd.embedded.api.Group>	getGroups(Long permissionId, org.ofbiz.core.entity.GenericValue project) Deprecated. Use getGroups(Long, com.atlassian.jira.project.Project) instead. Since v5.0.
Collection<com.atlassian.crowd.embedded.api.Group>	getGroups(Long permissionId, Project project)
List<org.ofbiz.core.entity.GenericValue>	getProjects(org.ofbiz.core.entity.GenericValue scheme) Deprecated. Use getProjects(Scheme) instead. Since 2009.
List<Project>	getProjects(Scheme scheme) Gets all projects that are associated with that scheme
org.ofbiz.core.entity.GenericValue	getScheme(Long id) Deprecated. Use getSchemeObject(Long) instead. Since v5.0.
org.ofbiz.core.entity.GenericValue	getScheme(String name) Deprecated. use getSchemeObject(String) instead. Since 2010.
Scheme	getSchemeFor(Project project) Get the scheme of this type attached to the given project.
Scheme	getSchemeObject(Long id) Gets a scheme by id from the database.
Scheme	getSchemeObject(String name) Gets a scheme by name from the database.
List<Scheme>	getSchemeObjects() Gets all scheme objects in the database.
List<org.ofbiz.core.entity.GenericValue>	getSchemes() Deprecated. use getSchemeObjects(). Since 2010.
List<org.ofbiz.core.entity.GenericValue>	getSchemes(org.ofbiz.core.entity.GenericValue project) Deprecated. Use getSchemeFor(com.atlassian.jira.project.Project) instead. Since v5.0.
List<Scheme>	getUnassociatedSchemes() Will return all @link Scheme objects that are not currently associated with any projects.
Collection<com.atlassian.crowd.embedded.api.User>	getUsers(Long permissionId, org.ofbiz.core.entity.GenericValue issueOrProject) Deprecated. Use getUsers(Long, com.atlassian.jira.permission.PermissionContext) instead. Since 2006.
Collection<com.atlassian.crowd.embedded.api.User>	getUsers(Long permissionId, Issue issue)
Collection<com.atlassian.crowd.embedded.api.User>	getUsers(Long permissionId, PermissionContext ctx)
Collection<com.atlassian.crowd.embedded.api.User>	getUsers(Long permissionId, Project project)
boolean	hasSchemeAuthority(Long entityType, org.ofbiz.core.entity.GenericValue entity) Checks anonymous permission of the given permission type for the given entity.
boolean	hasSchemeAuthority(Long entityType, org.ofbiz.core.entity.GenericValue entity, com.atlassian.crowd.embedded.api.User user, boolean issueCreation) Checks the given user's permission of the given permission type for the given entity.
boolean	removeEntities(org.ofbiz.core.entity.GenericValue scheme, Long entityTypeId) Deprecated. Use getEntities(org.ofbiz.core.entity.GenericValue, Long) and deleteEntity(Long) instead. Since v5.0.
boolean	removeEntities(String type, String parameter) Removes all scheme entities with this parameter and type
void	removeSchemesFromProject(org.ofbiz.core.entity.GenericValue project) Deprecated. Use removeSchemesFromProject(com.atlassian.jira.project.Project) instead. Since v4.4.
void	removeSchemesFromProject(Project project) Removes all schemes from a project
boolean	schemeExists(String name) Determine if the given scheme name exists.
void	updateScheme(org.ofbiz.core.entity.GenericValue entity) Deprecated. Use updateScheme(Scheme) instead. Since v5.0.
void	updateScheme(Scheme scheme) Updates any changes to the scheme object.

Field Detail

PROJECT_ASSOCIATION

static final String PROJECT_ASSOCIATION

The one and only "association type".

See Also:

Constant Field Values

Method Detail

getScheme

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

Deprecated. Use getSchemeObject(Long) instead. Since v5.0.

Gets a scheme based on the Id of the scheme

Parameters:

id - Id of the scheme

Returns:

The scheme

Throws:

org.ofbiz.core.entity.GenericEntityException - DB Error

getSchemeObject

Scheme getSchemeObject(Long id)
                       throws DataAccessException

Gets a scheme by id from the database.

Parameters:

id - the id of the scheme to get.

Returns:

the Scheme

Throws:

DataAccessException - if there is trouble retrieving from the database.

getSchemes

List<org.ofbiz.core.entity.GenericValue> getSchemes()
                                                    throws org.ofbiz.core.entity.GenericEntityException

Deprecated. use getSchemeObjects(). Since 2010.

Gets all the Schemes (of the type defined by the subclass) from the database.

Returns:

the schemes.

Throws:

org.ofbiz.core.entity.GenericEntityException - DB Error

getSchemeObjects

List<Scheme> getSchemeObjects()
                              throws DataAccessException

Gets all scheme objects in the database.

Returns:

the schemes.

Throws:

DataAccessException - if the database is down or equivalent.

getAssociatedSchemes

List<Scheme> getAssociatedSchemes(boolean withEntitiesComparable)

Gets all schemes of this type in the database taht are associated with at least one project.

Parameters:

withEntitiesComparable - if true then the scheme entites will be logically comparable (they will not include database specific information such as the pk id). Otherwise the object will be a full representation of the row stored in the database.

Returns:

List of associated schemes

getScheme

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

Deprecated. use getSchemeObject(String) instead. Since 2010.

Gets a scheme by name from the database.

Parameters:

name - the name of the scheme to get.

Returns:

the Scheme

Throws:

org.ofbiz.core.entity.GenericEntityException - DB error

getSchemeObject

Scheme getSchemeObject(String name)
                       throws DataAccessException

Gets a scheme by name from the database.

Parameters:

name - the name of the scheme to get.

Returns:

the Scheme

Throws:

DataAccessException - if there is trouble retrieving from the database.

getSchemes

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

Deprecated. Use getSchemeFor(com.atlassian.jira.project.Project) instead. Since v5.0.

Get all schemes of this type attached to the given project.

Parameters:

project - The project that the schemes are attached to

Returns:

List of schemes

Throws:

org.ofbiz.core.entity.GenericEntityException - If a DB error occurs

getSchemeFor

Scheme getSchemeFor(Project project)

Get the scheme of this type attached to the given project.

Parameters:

project - The project

Returns:

Thoe associated schem for this project.

schemeExists

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

Determine if the given scheme name exists.

Parameters:

name - The name of the scheme

Returns:

true is the schem exists.

Throws:

org.ofbiz.core.entity.GenericEntityException - If a DB error occurs

createScheme

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

Deprecated. Use createSchemeObject(String, String) instead. Since v5.0.

Creates a new scheme

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 - If a DB error occurs

createSchemeObject

Scheme createSchemeObject(String name,
                          String description)

Creates a new scheme

Parameters:

name - The name of the new scheme

description - The description of the new scheme

Returns:

The new scheme object

createSchemeAndEntities

Scheme createSchemeAndEntities(Scheme scheme)
                               throws DataAccessException

Throws:

DataAccessException

getEntity

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

Parameters:

id - The id of the entity

Returns:

The scheme entity object

Throws:

org.ofbiz.core.entity.GenericEntityException - If a DB error occurs

getEntities

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

Get all Scheme entity records for a particular scheme

Parameters:

scheme - The scheme that the entities belong to

Returns:

List of (GenericValue) entities

Throws:

org.ofbiz.core.entity.GenericEntityException - If a DB error occurs

getEntities

List<org.ofbiz.core.entity.GenericValue> getEntities(org.ofbiz.core.entity.GenericValue scheme,
                                                     Long entityTypeId)
                                                     throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getEntities

List<org.ofbiz.core.entity.GenericValue> getEntities(org.ofbiz.core.entity.GenericValue scheme,
                                                     Long entityTypeId,
                                                     String parameter)
                                                     throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getEntities

List<org.ofbiz.core.entity.GenericValue> getEntities(org.ofbiz.core.entity.GenericValue scheme,
                                                     String type,
                                                     Long entityTypeId)
                                                     throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

getEntities

List<org.ofbiz.core.entity.GenericValue> getEntities(org.ofbiz.core.entity.GenericValue scheme,
                                                     String entityTypeId)
                                                     throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

updateScheme

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

Deprecated. Use updateScheme(Scheme) instead. Since v5.0.

Updates any changes to the given scheme

Parameters:

entity - The modified scheme

Throws:

org.ofbiz.core.entity.GenericEntityException - If a DB error occurs

updateScheme

void updateScheme(Scheme scheme)

Updates any changes to the scheme object. This does not include changes to the scheme entities.

Parameters:

scheme - The modified scheme object

deleteScheme

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

Deletes a scheme from the database

Parameters:

id - Id of the scheme to be deleted

Throws:

org.ofbiz.core.entity.GenericEntityException - If a DB error occurs

addSchemeToProject

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

Deprecated. Use addSchemeToProject(com.atlassian.jira.project.Project, Scheme) instead. Since v5.0.

Adds a scheme to a particular project

Parameters:

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

scheme - The scheme to be added

Throws:

org.ofbiz.core.entity.GenericEntityException - If a DB error occurs

addSchemeToProject

void addSchemeToProject(Project project,
                        Scheme scheme)

Adds a scheme to a particular project

Parameters:

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

scheme - The scheme to be added

removeSchemesFromProject

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

Deprecated. Use removeSchemesFromProject(com.atlassian.jira.project.Project) instead. Since v4.4.

Removes all schemes from a project

Parameters:

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

Throws:

org.ofbiz.core.entity.GenericEntityException - If a DB error occurs

removeSchemesFromProject

void removeSchemesFromProject(Project project)

Removes all schemes from a project

Parameters:

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

createSchemeEntity

org.ofbiz.core.entity.GenericValue createSchemeEntity(org.ofbiz.core.entity.GenericValue scheme,
                                                      SchemeEntity entity)
                                                      throws org.ofbiz.core.entity.GenericEntityException

Throws:

org.ofbiz.core.entity.GenericEntityException

deleteEntity

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

Deletes an entity with the given id from the database.

Parameters:

id - The id of the entity to be deleted

Throws:

org.ofbiz.core.entity.GenericEntityException - If a DB error occurs

getProjects

@Deprecated
List<org.ofbiz.core.entity.GenericValue> getProjects(org.ofbiz.core.entity.GenericValue scheme)
                                                     throws org.ofbiz.core.entity.GenericEntityException

Deprecated. Use getProjects(Scheme) instead. Since 2009.

Gets all projects that are associated with that scheme

Parameters:

scheme - The scheme used to get all projects

Returns:

List of (GenericValue) projects

Throws:

org.ofbiz.core.entity.GenericEntityException - If a DB error occurs

getProjects

List<Project> getProjects(Scheme scheme)

Gets all projects that are associated with that scheme

Parameters:

scheme - The scheme used to get all projects

Returns:

List of Project's

createDefaultScheme

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

Creates a default scheme, with an id of 0

Returns:

The new permission scheme object

Throws:

org.ofbiz.core.entity.GenericEntityException - If a DB error occurs

getDefaultScheme

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

Deprecated. Use getDefaultSchemeObject() instead. Since v5.0.

Gets the default scheme. This should have an id of 0 This does not work for the Default Notification scheme as it does not have an id of 0.

Returns:

The default scheme

Throws:

org.ofbiz.core.entity.GenericEntityException - If a DB error occurs

getDefaultSchemeObject

Scheme getDefaultSchemeObject()

Gets the default scheme. This should have an id of 0 This does not work for the Default Notification scheme as it does not have an id of 0.

Returns:

The default scheme

addDefaultSchemeToProject

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

Deprecated. Use addDefaultSchemeToProject(com.atlassian.jira.project.Project) instead. Since v5.0.

Adds the default scheme to a particular project

Parameters:

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

Throws:

org.ofbiz.core.entity.GenericEntityException - If a DB error occurs

addDefaultSchemeToProject

void addDefaultSchemeToProject(Project project)

Adds the default scheme to a particular project

Parameters:

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

copyScheme

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

Deprecated. Use copyScheme(Scheme) instead. Since v5.0.

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

Parameters:

scheme - The permission scheme to be copied

Returns:

The new permission scheme

Throws:

org.ofbiz.core.entity.GenericEntityException - If a DB error occurs

copyScheme

Scheme copyScheme(Scheme scheme)

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

Parameters:

scheme - The permission scheme to be copied

Returns:

The new permission scheme

hasSchemeAuthority

boolean hasSchemeAuthority(Long entityType,
                           org.ofbiz.core.entity.GenericValue entity)

Checks anonymous permission of the given permission type for the given entity.

Parameters:

entityType - permission type.

entity - the entity to which permission is being checked.

Returns:

true only if the anonymous user is permitted.

hasSchemeAuthority

boolean hasSchemeAuthority(Long entityType,
                           org.ofbiz.core.entity.GenericValue entity,
                           com.atlassian.crowd.embedded.api.User user,
                           boolean issueCreation)

Checks the given user's permission of the given permission type for the given entity.

Parameters:

entityType - permission type.

entity - the entity to which permission is being checked.

user - the user.

issueCreation - whether the permission is for creating an issue.

Returns:

true only if the user is permitted.

removeEntities

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

Deprecated. Use getEntities(org.ofbiz.core.entity.GenericValue, Long) and deleteEntity(Long) instead. Since v5.0.

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

Parameters:

scheme - to remove entites from must NOT be null

entityTypeId - to remove

Returns:

True all the time (legacy)

Throws:

RemoveException - if the delete fails (DB error)

getEntities

List<org.ofbiz.core.entity.GenericValue> getEntities(String type,
                                                     String parameter)
                                                     throws org.ofbiz.core.entity.GenericEntityException

Get all entity records with a particular parameter

Parameters:

type - The type of entity you wish to retrieve, eg 'user', 'group', 'projectrole'

parameter - The parameter in the entity

Returns:

List of (GenericValue) entities

Throws:

org.ofbiz.core.entity.GenericEntityException - If a DB error occurs

removeEntities

boolean removeEntities(String type,
                       String parameter)
                       throws RemoveException

Removes all scheme entities with this parameter and type

Parameters:

type - the 'type' of entity you are deleting, eg 'group', 'user', 'projectrole'

parameter - must NOT be null

Returns:

true always (legacy)

Throws:

RemoveException - if the delete fails (DB error)

getGroups

Collection<com.atlassian.crowd.embedded.api.Group> getGroups(Long permissionId,
                                                             org.ofbiz.core.entity.GenericValue project)

Deprecated. Use getGroups(Long, com.atlassian.jira.project.Project) instead. Since v5.0.

getGroups

Collection<com.atlassian.crowd.embedded.api.Group> getGroups(Long permissionId,
                                                             Project project)

getUsers

Collection<com.atlassian.crowd.embedded.api.User> getUsers(Long permissionId,
                                                           Project project)

getUsers

Collection<com.atlassian.crowd.embedded.api.User> getUsers(Long permissionId,
                                                           Issue issue)

getUsers

@Deprecated
Collection<com.atlassian.crowd.embedded.api.User> getUsers(Long permissionId,
                                                                      org.ofbiz.core.entity.GenericValue issueOrProject)

Deprecated. Use getUsers(Long, com.atlassian.jira.permission.PermissionContext) instead. Since 2006.

getUsers

Collection<com.atlassian.crowd.embedded.api.User> getUsers(Long permissionId,
                                                           PermissionContext ctx)

getUnassociatedSchemes

List<Scheme> getUnassociatedSchemes()
                                    throws DataAccessException

Will return all @link Scheme objects that are not currently associated with any projects.

Returns:

list of @link Scheme objects

Throws:

DataAccessException - if the database is down or equivalent.