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

Method Summary

void	addDefaultSchemeToProject(org.ofbiz.core.entity.GenericValue project)
void	addSchemeToProject(org.ofbiz.core.entity.GenericValue project, org.ofbiz.core.entity.GenericValue scheme)
void	addSchemeToProject(Project project, Scheme scheme)
org.ofbiz.core.entity.GenericValue	copyScheme(org.ofbiz.core.entity.GenericValue scheme)
org.ofbiz.core.entity.GenericValue	createDefaultScheme()
org.ofbiz.core.entity.GenericValue	createScheme(String name, String description)
Scheme	createSchemeAndEntities(Scheme scheme)
org.ofbiz.core.entity.GenericValue	createSchemeEntity(org.ofbiz.core.entity.GenericValue scheme, SchemeEntity entity)
void	deleteEntity(Long id)
void	deleteScheme(Long id)
List	getAssociatedSchemes(boolean withEntitiesComparable)
org.ofbiz.core.entity.GenericValue	getDefaultScheme()
List	getEntities(org.ofbiz.core.entity.GenericValue scheme)
List	getEntities(org.ofbiz.core.entity.GenericValue scheme, Long entityTypeId)
List	getEntities(org.ofbiz.core.entity.GenericValue scheme, Long entityTypeId, String parameter)
List	getEntities(org.ofbiz.core.entity.GenericValue scheme, String entityTypeId)
List	getEntities(org.ofbiz.core.entity.GenericValue scheme, String type, Long entityTypeId)
List	getEntities(String type, String parameter) Get all entity records with a particular parameter
org.ofbiz.core.entity.GenericValue	getEntity(Long id)
Collection	getGroups(Long permissionId, org.ofbiz.core.entity.GenericValue project)
List	getProjects(org.ofbiz.core.entity.GenericValue scheme)
List	getProjects(Scheme scheme)
org.ofbiz.core.entity.GenericValue	getScheme(Long id)
org.ofbiz.core.entity.GenericValue	getScheme(String name)
List	getSchemes()
List	getSchemes(org.ofbiz.core.entity.GenericValue project)
List	getUnassociatedSchemes() Will return all @link Scheme objects that are not currently associated with any projects.
Collection	getUsers(Long permissionId, org.ofbiz.core.entity.GenericValue issueOrProject) Deprecated. Use getUsers(Long, com.atlassian.jira.permission.PermissionContext) instead.
Collection	getUsers(Long permissionId, PermissionContext ctx)
boolean	hasSchemeAuthority(Long entityType, org.ofbiz.core.entity.GenericValue entity)
boolean	hasSchemeAuthority(Long entityType, org.ofbiz.core.entity.GenericValue entity, User user, boolean issueCreation)
boolean	removeEntities(org.ofbiz.core.entity.GenericValue scheme, Long permissionId)
boolean	removeEntities(String type, String parameter) Removes all scheme entities with this parameter and type
void	removeSchemesFromProject(org.ofbiz.core.entity.GenericValue project)
void	removeSchemesFromProject(Project project)
boolean	schemeExists(String name)
void	updateScheme(org.ofbiz.core.entity.GenericValue entity)
void	updateScheme(Scheme scheme)

Field Detail

PROJECT_ASSOCIATION

static final String PROJECT_ASSOCIATION

See Also:

Constant Field Values

Method Detail

getScheme

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

Throws:

org.ofbiz.core.entity.GenericEntityException

getSchemes

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

Throws:

org.ofbiz.core.entity.GenericEntityException

getAssociatedSchemes

List getAssociatedSchemes(boolean withEntitiesComparable)
                          throws DataAccessException

Throws:

DataAccessException

getScheme

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

Throws:

org.ofbiz.core.entity.GenericEntityException

getSchemes

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

Throws:

org.ofbiz.core.entity.GenericEntityException

schemeExists

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

Throws:

org.ofbiz.core.entity.GenericEntityException

createScheme

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

Throws:

org.ofbiz.core.entity.GenericEntityException

createSchemeAndEntities

Scheme createSchemeAndEntities(Scheme scheme)
                               throws DataAccessException

Throws:

DataAccessException

getEntity

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

Throws:

org.ofbiz.core.entity.GenericEntityException

getEntities

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

Throws:

org.ofbiz.core.entity.GenericEntityException

getEntities

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

Throws:

org.ofbiz.core.entity.GenericEntityException

getEntities

List 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 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 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

Throws:

org.ofbiz.core.entity.GenericEntityException

updateScheme

void updateScheme(Scheme scheme)
                  throws DataAccessException

Throws:

DataAccessException

deleteScheme

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

Throws:

org.ofbiz.core.entity.GenericEntityException

addSchemeToProject

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

Throws:

org.ofbiz.core.entity.GenericEntityException

addSchemeToProject

void addSchemeToProject(Project project,
                        Scheme scheme)
                        throws DataAccessException

Throws:

DataAccessException

removeSchemesFromProject

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

Throws:

org.ofbiz.core.entity.GenericEntityException

removeSchemesFromProject

void removeSchemesFromProject(Project project)
                              throws DataAccessException

Throws:

DataAccessException

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

Throws:

org.ofbiz.core.entity.GenericEntityException

getProjects

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

Throws:

org.ofbiz.core.entity.GenericEntityException

getProjects

List getProjects(Scheme scheme)
                 throws DataAccessException

Throws:

DataAccessException

createDefaultScheme

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

Throws:

org.ofbiz.core.entity.GenericEntityException

getDefaultScheme

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

Throws:

org.ofbiz.core.entity.GenericEntityException

addDefaultSchemeToProject

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

Throws:

org.ofbiz.core.entity.GenericEntityException

copyScheme

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

Throws:

org.ofbiz.core.entity.GenericEntityException

hasSchemeAuthority

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

hasSchemeAuthority

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

removeEntities

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

Throws:

RemoveException

getEntities

List 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

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

Throws:

RemoveException

getGroups

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

getUsers

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

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

getUsers

Collection getUsers(Long permissionId,
                    PermissionContext ctx)

getUnassociatedSchemes

List 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