Package com.riadalabs.jira.plugins.insight.channel.external.api.facade

Interface ConfigureFacade

All Known Implementing Classes:

ConfigureFacadeImpl

@PublicApi
public interface ConfigureFacade

Service interface to access and manage Assets configuration

Since:

2.13.1

Author:

Mathias Edblom

Method Summary

Modifier and Type	Method	Description
IconBean	createIconBean(IconBean iconBean)	Creates a IconBean
ReferenceTypeBean	createReferenceTypeBean(ReferenceTypeBean referenceTypeBean)	Creates a ReferenceTypeBean
StatusTypeBean	createStatusTypeBean(StatusTypeBean statusTypeBean)	Creates a StatusTypeBean
void	deleteGroupRoleActor(String groupName)	Deletes group from all Assets permissions
void	deleteIconBean(int id)	Delete a IconBean domain object.
void	deleteReferenceTypeBean(int id)	Delete a ReferenceTypeBean
void	deleteStatusTypeBean(int id)	Delete a StatusTypeBean
String	exportObjectSchemaConfiguration(int id)	Deprecated. Use ObjectSchemaExportService.streamSchemaToClient(ExportObjectSchemaDataBean) instead.
List<IconBean>	findAllIconBeans(int objectSchemaId)	Finds all IconBean for a specific ObjectSchemaBean including all global ones.
List<ReferenceTypeBean>	findAllReferenceTypeBeans(int objectSchemaId)	Finds all ReferenceTypeBean including global ones
List<StatusTypeBean>	findAllStatusTypeBeans(int objectSchemaId)	Finds all StatusTypeBean including global ones
List<IconBean>	findGlobalIconBeans()	Finds all global IconBean
List<ReferenceTypeBean>	findGlobalReferenceTypeBeans()	Finds all global ReferenceTypeBean
List<StatusTypeBean>	findGlobalStatusTypeBeans()	Finds all global StatusTypeBean
List<IconBean>	findIconBeans(int objectSchemaId)	Finds all IconBean specified for a specific ObjectSchemaBean (not global ones).
List<ReferenceTypeBean>	findReferenceTypeBeans(int objectSchemaId)	Finds all ReferenceTypeBean for a specific ObjectSchema id
List<RoleBean>	findRoleBeans()	Finds all RoleBean
List<RoleBean>	findRoleBeansByObjectSchema(int objectSchemaId)	Finds all RoleBean by Object Schema
List<RoleBean>	findRoleBeansByObjectType(int objectTypeId)	Finds all RoleBean by Object Type
List<StatusTypeBean>	findStatusTypeBeans(int objectSchemaId)	Finds all StatusTypeBean for a specific ObjectSchema id
IconBean	loadIconBean(int id)	Loads a single IconBean
IconBean	loadIconBean(int objectSchemaId, String name)	Loads a single IconBean
ReferenceTypeBean	loadReferenceTypeBean(int id)	Loads a single ReferenceTypeBean
ReferenceTypeBean	loadReferenceTypeBean(int id, String name)	Loads a single ReferenceTypeBean
RoleActorBean	loadRoleActorBean(int id)	Loads a RoleActorBean
RoleBean	loadRoleBean(int id)	Loads a RoleBean
StatusTypeBean	loadStatusTypeBean(int id)	Loads a single StatusTypeBean
StatusTypeBean	loadStatusTypeBean(int objectSchemaId, String name)	Loads a single StatusTypeBean
void	storeActorsForRoleBean(Map<String,Set<String>> newRoleActorBeans, int roleBeanId)	Stores actors for a RoleBean
IconBean	updateIconBean(IconBean iconBean)	Update a IconBean
ReferenceTypeBean	updateReferenceTypeBean(ReferenceTypeBean referenceTypeBean)	Updates a ReferenceTypeBean
StatusTypeBean	updateStatusTypeBean(StatusTypeBean statusTypeBean)	Updates a StatusTypeBean

Method Details

findRoleBeans

List<RoleBean> findRoleBeans()
                      throws InsightException

Finds all RoleBean

Returns:

a list of RoleBean @

Throws:

InsightException

findRoleBeansByObjectSchema

List<RoleBean> findRoleBeansByObjectSchema(int objectSchemaId)
                                    throws InsightException

Finds all RoleBean by Object Schema

Parameters:

objectSchemaId - the ObjectSchemaBean Id

Returns:

a list of RoleBean @

Throws:

InsightException - if something goes wrong

findRoleBeansByObjectType

List<RoleBean> findRoleBeansByObjectType(int objectTypeId)
                                  throws InsightException

Finds all RoleBean by Object Type

Parameters:

objectTypeId - the ObjectTypeBean Id

Returns:

a list of RoleBean @

Throws:

InsightException - if something goes wrong

loadRoleBean

RoleBean loadRoleBean(int id)
               throws InsightException

Loads a RoleBean

Returns:

a RoleBean @

Throws:

InsightException - if something goes wrong

loadRoleActorBean

RoleActorBean loadRoleActorBean(int id)
                         throws InsightException

Loads a RoleActorBean

Returns:

a RoleActorBean @

Throws:

InsightException - if something goes wrong

storeActorsForRoleBean

void storeActorsForRoleBean(Map<String,Set<String>> newRoleActorBeans,
 int roleBeanId)
                     throws InsightException

Stores actors for a RoleBean

Throws:

InsightException - if something goes wrong

deleteGroupRoleActor

void deleteGroupRoleActor(String groupName)
                   throws InsightException

Deletes group from all Assets permissions

Throws:

InsightException - if something goes wrong

createReferenceTypeBean

ReferenceTypeBean createReferenceTypeBean(ReferenceTypeBean referenceTypeBean)
                                   throws InsightException

Creates a ReferenceTypeBean

Parameters:

referenceTypeBean - a ReferenceTypeBean

Returns:

the created ReferenceTypeBean

Throws:

InsightException - if something goes wrong

updateReferenceTypeBean

ReferenceTypeBean updateReferenceTypeBean(ReferenceTypeBean referenceTypeBean)
                                   throws InsightException

Updates a ReferenceTypeBean

Parameters:

referenceTypeBean - a ReferenceTypeBean

Returns:

the updated ReferenceTypeBean

Throws:

InsightException - if something goes wrong

findGlobalReferenceTypeBeans

List<ReferenceTypeBean> findGlobalReferenceTypeBeans()
                                              throws InsightException

Finds all global ReferenceTypeBean

Returns:

all list of ReferenceTypeBean

Throws:

InsightException - if something goes wrong

findReferenceTypeBeans

List<ReferenceTypeBean> findReferenceTypeBeans(int objectSchemaId)
                                        throws InsightException

Finds all ReferenceTypeBean for a specific ObjectSchema id

Returns:

all list of ReferenceTypeBean

Throws:

InsightException - if something goes wrong

findAllReferenceTypeBeans

List<ReferenceTypeBean> findAllReferenceTypeBeans(int objectSchemaId)
                                           throws InsightException

Finds all ReferenceTypeBean including global ones

Returns:

a list of ReferenceTypeBean

Throws:

InsightException - if something goes wrong

loadReferenceTypeBean

ReferenceTypeBean loadReferenceTypeBean(int id)
                                 throws InsightException

Loads a single ReferenceTypeBean

Returns:

the loaded ReferenceTypeBean

Throws:

InsightException - if something goes wrong

loadReferenceTypeBean

ReferenceTypeBean loadReferenceTypeBean(int id,
 String name)
                                 throws InsightException

Loads a single ReferenceTypeBean

Returns:

the loaded ReferenceTypeBean

Throws:

InsightException - if something goes wrong

deleteReferenceTypeBean

void deleteReferenceTypeBean(int id)
                      throws InsightException

Delete a ReferenceTypeBean

Throws:

InsightException - if something goes wrong

createStatusTypeBean

StatusTypeBean createStatusTypeBean(StatusTypeBean statusTypeBean)
                             throws InsightException

Creates a StatusTypeBean

Parameters:

statusTypeBean - a StatusTypeBean

Returns:

the created StatusTypeBean

Throws:

InsightException - if something goes wrong

updateStatusTypeBean

StatusTypeBean updateStatusTypeBean(StatusTypeBean statusTypeBean)
                             throws InsightException

Updates a StatusTypeBean

Parameters:

statusTypeBean - a StatusTypeBean

Returns:

the updated StatusTypeBean

Throws:

InsightException - if something goes wrong

findGlobalStatusTypeBeans

List<StatusTypeBean> findGlobalStatusTypeBeans()
                                        throws InsightException

Finds all global StatusTypeBean

Returns:

all list of StatusTypeBean

Throws:

InsightException - if something goes wrong

findStatusTypeBeans

List<StatusTypeBean> findStatusTypeBeans(int objectSchemaId)
                                  throws InsightException

Finds all StatusTypeBean for a specific ObjectSchema id

Returns:

all list of StatusTypeBean

Throws:

InsightException - if something goes wrong

findAllStatusTypeBeans

List<StatusTypeBean> findAllStatusTypeBeans(int objectSchemaId)
                                     throws InsightException

Finds all StatusTypeBean including global ones

Returns:

a list of StatusTypeBean

Throws:

InsightException - if something goes wrong

loadStatusTypeBean

StatusTypeBean loadStatusTypeBean(int id)
                           throws InsightException

Loads a single StatusTypeBean

Returns:

the loaded StatusTypeBean

Throws:

InsightException - if something goes wrong

loadStatusTypeBean

StatusTypeBean loadStatusTypeBean(int objectSchemaId,
 String name)
                           throws InsightException

Loads a single StatusTypeBean

Returns:

the loaded StatusTypeBean

Throws:

InsightException - if something goes wrong

deleteStatusTypeBean

void deleteStatusTypeBean(int id)
                   throws InsightException

Delete a StatusTypeBean

Throws:

InsightException - if something goes wrong

createIconBean

IconBean createIconBean(IconBean iconBean)
                 throws InsightException

Creates a IconBean

Parameters:

iconBean - a IconBean

Returns:

the created IconBean with an id.

Throws:

InsightException - if something goes wrong

updateIconBean

IconBean updateIconBean(IconBean iconBean)
                 throws InsightException

Update a IconBean

Parameters:

iconBean - a IconBean

Returns:

the updated IconBean with an id.

Throws:

InsightException - if something goes wrong

findGlobalIconBeans

List<IconBean> findGlobalIconBeans()
                            throws InsightException

Finds all global IconBean

Returns:

all IconBean

Throws:

InsightException - if something goes wrong

findAllIconBeans

List<IconBean> findAllIconBeans(int objectSchemaId)
                         throws InsightException

Finds all IconBean for a specific ObjectSchemaBean including all global ones.

Returns:

a list of IconBean

Throws:

InsightException - if something goes wrong

findIconBeans

List<IconBean> findIconBeans(int objectSchemaId)
                      throws InsightException

Finds all IconBean specified for a specific ObjectSchemaBean (not global ones).

Returns:

a list of IconBean

Throws:

InsightException - if something goes wrong

loadIconBean

IconBean loadIconBean(int id)
               throws InsightException

Loads a single IconBean

Parameters:

id - the id of the IconBean to load

Returns:

the loaded IconBean

Throws:

InsightException - if something goes wrong

loadIconBean

IconBean loadIconBean(int objectSchemaId,
 String name)
               throws InsightException

Loads a single IconBean

Parameters:

name - the name of the IconBean to load

Returns:

the loaded IconBean

Throws:

InsightException - if something goes wrong

deleteIconBean

void deleteIconBean(int id)
             throws InsightException

Delete a IconBean domain object.

Throws:

InsightException - if something goes wrong

exportObjectSchemaConfiguration

@Deprecated
String exportObjectSchemaConfiguration(int id)
                                throws InsightException

Deprecated.

Use ObjectSchemaExportService.streamSchemaToClient(ExportObjectSchemaDataBean) instead.

Due to being deprecated, this method will NOT support auditing. This method will be removed with Jira 6.0 platform release.

Parameters:

id - Object Schema ID

Returns:

a xml string

Throws:

InsightException - if something goes wrong