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

Interface ObjectFacade

All Known Implementing Classes:

ObjectFacadeImpl

@PublicApi
public interface ObjectFacade

Service interface to access and manage Assets objects

Since:

2.13.1

Author:

Mathias Edblom

Method Summary

Modifier and Type	Method	Description
AttachmentBean	addAttachmentBean(int objectId, File file, String fileName, String contentType, String comment)	Add a AttachmentBean domain objects.
void	archiveObjectBean(int id)	Archive an ObjectBean by ID.
void	archiveObjectBean(int id, com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)	Archive an ObjectBean by ID with control over the event dispatch option.
void	archiveObjectBean(String objectKey)	Archive an ObjectBean by object key.
void	archiveObjectBean(String objectKey, com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)	Archive an ObjectBean by object key with control over the event dispatch option.
int	countObjectBeans(int objectTypeId)	Finds total count of all ObjectBean domain objects.
WatcherBean	createWatcherBean(int objectId, String userKey)	Created a WatcherBean
AttachmentBean	deleteAttachmentBean(int id)	Delete AttachmentBean
void	deleteCommentBean(int commentBeanId)	Delete a CommentBean
void	deleteObjectAttributeBean(int id)	Deprecated. use the deleteObjectAttributeBean(long) instead
void	deleteObjectAttributeBean(int id, com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)	Deprecated. use the deleteObjectAttributeBean(long, EventDispatchOption) instead
void	deleteObjectAttributeBean(long id)	Deletes an object attribute bean
void	deleteObjectAttributeBean(long id, com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)	Deletes an object attribute bean
void	deleteObjectBean(int id)	Delete a ObjectBean
void	deleteObjectBean(int id, com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)	Delete a ObjectBean
void	deleteWatcherBean(WatcherBean watcherBean)	Delete a WatcherBean
List<AttachmentBean>	findAttachmentBeans(int objectId)	Finds attachmentBeans for specified ObjectBean id
List<CommentBean>	findCommentBeans(int objectId)	Find all CommentBean for an ObjectBean
List<ObjectAttributeBean>	findObjectAttributeBeans(int objectId)	Finds all ObjectAttributeBean
List<ObjectHistoryBean>	findObjectHistoryBean(int objectId)	Find the ObjectBean history
List<ObjectTicketConnectionEntry>	findObjectTicketConnections(int objectId)	Find all JIRA issues connected to an ObjectBean
List<ObjectTicketConnectionEntry>	findObjectTicketConnections(int objectId, int offset, int limit)	Deprecated. use findObjectTicketConnections(int) instead
List<ObjectTicketConnectionEntry>	findObjectTicketConnections(long ticketId)	Find all ObjectBean connected to a JIRA issue
List<WatcherBean>	findWatcherBeans(int objectId)	Finds all WatcherBean for an ObjectBean
AttachmentBean	loadAttachmentBeanById(int id)	Load a AttachmentBean
CommentBean	loadCommentBean(int commentId)	Load a CommentBean
ObjectAttributeBean	loadObjectAttributeBean(int id)	Deprecated. Go through the object to load the object attribute bean instead of directly.
ObjectAttributeBean	loadObjectAttributeBean(int objectId, int objectTypeAttributeId)	Loads a ObjectAttributeBean given an object id and object type attribute id
ObjectAttributeBean	loadObjectAttributeBean(int objectId, int objectTypeAttributeId, boolean ignorePermissionCheck)	Loads a ObjectAttributeBean given an object id, object type attribute id and a parameter to ignore permission check
ObjectAttributeBean	loadObjectAttributeBean(int objectId, String objectTypeAttributeName)	Loads a ObjectAttributeBean given an object id and object type attribute name
ObjectBean	loadObjectBean(int id)	Loads a ObjectBean given its id.
ObjectBean	loadObjectBean(String key)	Loads a ObjectBean given its key.
WatcherBean	loadWatcherBean(int objectId, String userKey)	Loads a WatcherBean
Progress	moveObjects(MoveObjectBean moveObjectBean)	Move objects to another object type
void	restoreObjectBean(int id)	Restore an ObjectBean by ID.
void	restoreObjectBean(int id, com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)	Restore an ObjectBean by ID with control over the event dispatch option.
void	restoreObjectBean(String objectKey)	Restore an ObjectBean by object key.
void	restoreObjectBean(String objectKey, com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)	Restore an ObjectBean by object key with control over the event dispatch option.
CommentBean	storeCommentBean(CommentBean commentBean)	Store a CommentBean
ObjectAttributeBean	storeObjectAttributeBean(MutableObjectAttributeBean objectAttributeBean)	Stores a ObjectAttributeBean
ObjectAttributeBean	storeObjectAttributeBean(MutableObjectAttributeBean objectAttributeBean, com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)	Stores a ObjectAttributeBean
ObjectAttributeBean	storeObjectAttributeBean(ObjectAttributeBean objectAttributeBean)	Deprecated.
ObjectBean	storeObjectBean(MutableObjectBean objectBean)	Stores a ObjectBean
ObjectBean	storeObjectBean(MutableObjectBean objectBean, byte[] avatarData, com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)	Stores a ObjectBean with the corresponding avatar
ObjectBean	storeObjectBean(MutableObjectBean objectBean, com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)	Stores a ObjectBean
ObjectBean	storeObjectBeanIgnoreAttributeValidation(MutableObjectBean objectBean)	Stores a ObjectBean bypassing ALL attribute validation e.g. uniqueness.
void	validateObjectAttributeBean(MutableObjectAttributeBean objectAttributeBean, ObjectBean objectBean)	Validate an object attribute bean.
void	validateObjectBean(MutableObjectBean objectBean)	Validate an object bean.

Method Details

storeObjectBean

ObjectBean storeObjectBean(MutableObjectBean objectBean,
 @Nonnull
 com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)
                    throws InsightException

Stores a ObjectBean

Parameters:

objectBean - the object bean to store

eventDispatchOption - event dispatch

Returns:

the stored ObjectBean

Throws:

InsightException - if something goes wrong

storeObjectBean

ObjectBean storeObjectBean(@Nonnull
 MutableObjectBean objectBean,
 @Nonnull
 byte[] avatarData,
 @Nonnull
 com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)
                    throws InsightException

Stores a ObjectBean with the corresponding avatar

Parameters:

objectBean - an existing object bean, the object bean must exist and be stored in insight before added as a parameter to this method

avatarData - the actual avatar data to be used for the object

eventDispatchOption - event dispatch

Returns:

the stored ObjectBean

Throws:

InsightException - if something goes

storeObjectBean

ObjectBean storeObjectBean(MutableObjectBean objectBean)
                    throws InsightException

Stores a ObjectBean

Parameters:

objectBean - the object bean to store

Returns:

the stored ObjectBean

Throws:

InsightException - if something goes wrong

storeObjectBeanIgnoreAttributeValidation

ObjectBean storeObjectBeanIgnoreAttributeValidation(MutableObjectBean objectBean)
                                             throws InsightException

Stores a ObjectBean bypassing ALL attribute validation e.g. uniqueness. This method should be used with care because it will create objects that potentially does not conform to the configuration of the object type.

Parameters:

objectBean - the object bean with corresponding attributes. Attributes present will NOT be validated

Returns:

the stored object bean

Throws:

InsightException

storeObjectAttributeBean

ObjectAttributeBean storeObjectAttributeBean(MutableObjectAttributeBean objectAttributeBean)
                                      throws InsightException

Stores a ObjectAttributeBean

Returns:

the stored ObjectAttributeBean

Throws:

InsightException - if something goes wrong

storeObjectAttributeBean

ObjectAttributeBean storeObjectAttributeBean(MutableObjectAttributeBean objectAttributeBean,
 @Nonnull
 com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)
                                      throws InsightException

Stores a ObjectAttributeBean

Returns:

the stored ObjectAttributeBean

Throws:

InsightException - if something goes wrong

storeObjectAttributeBean

@Deprecated
ObjectAttributeBean storeObjectAttributeBean(ObjectAttributeBean objectAttributeBean)
                                      throws InsightException

Deprecated.

Throws:

InsightException

countObjectBeans

int countObjectBeans(int objectTypeId)
              throws InsightException

Finds total count of all ObjectBean domain objects.

Returns:

the number of ObjectTypes

Throws:

InsightException

loadObjectBean

ObjectBean loadObjectBean(int id)
                   throws InsightException

Loads a ObjectBean given its id.

Returns:

a ObjectBean

Throws:

InsightException

loadObjectBean

ObjectBean loadObjectBean(String key)
                   throws InsightException

Loads a ObjectBean given its key.

Returns:

a ObjectBean

Throws:

InsightException

deleteObjectBean

void deleteObjectBean(int id)
               throws InsightException

Delete a ObjectBean

Throws:

InsightException

deleteObjectBean

void deleteObjectBean(int id,
 @Nonnull
 com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)
               throws InsightException

Delete a ObjectBean

Throws:

InsightException

archiveObjectBean

void archiveObjectBean(int id)
                throws InsightException

Archive an ObjectBean by ID.

Parameters:

id - the id of the object to archive

Throws:

InsightException

archiveObjectBean

void archiveObjectBean(int id,
 @Nonnull
 com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)
                throws InsightException

Archive an ObjectBean by ID with control over the event dispatch option.

Parameters:

id - the id of the object to archive

eventDispatchOption - event dispatch option

Throws:

InsightException

archiveObjectBean

void archiveObjectBean(String objectKey)
                throws InsightException

Archive an ObjectBean by object key.

Parameters:

objectKey - the key of the object to archive

Throws:

InsightException

archiveObjectBean

void archiveObjectBean(String objectKey,
 @Nonnull
 com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)
                throws InsightException

Archive an ObjectBean by object key with control over the event dispatch option.

Parameters:

objectKey - the key of the object to archive

eventDispatchOption - event dispatch option

Throws:

InsightException

restoreObjectBean

void restoreObjectBean(int id)
                throws InsightException

Restore an ObjectBean by ID.

Parameters:

id - the id of the object to restore

Throws:

InsightException

restoreObjectBean

void restoreObjectBean(int id,
 @Nonnull
 com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)
                throws InsightException

Restore an ObjectBean by ID with control over the event dispatch option.

Parameters:

id - the id of the object to restore

eventDispatchOption - event dispatch option

Throws:

InsightException

restoreObjectBean

void restoreObjectBean(String objectKey)
                throws InsightException

Restore an ObjectBean by object key.

Parameters:

objectKey - the key of the object to restore

Throws:

InsightException

restoreObjectBean

void restoreObjectBean(String objectKey,
 @Nonnull
 com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)
                throws InsightException

Restore an ObjectBean by object key with control over the event dispatch option.

Parameters:

objectKey - the key of the object to restore

eventDispatchOption - event dispatch option

Throws:

InsightException

findObjectAttributeBeans

List<ObjectAttributeBean> findObjectAttributeBeans(int objectId)
                                            throws InsightException

Finds all ObjectAttributeBean

Parameters:

objectId - the ObjectBean id

Returns:

a list of ObjectAttributeBean

Throws:

InsightException

loadObjectAttributeBean

@Deprecated
ObjectAttributeBean loadObjectAttributeBean(int id)
                                     throws InsightException

Deprecated.

Go through the object to load the object attribute bean instead of directly. This will be removed in future releases

Loads a ObjectAttributeBean given its id.

Returns:

a ObjectAttributeBean

Throws:

InsightException

deleteObjectAttributeBean

@Deprecated
void deleteObjectAttributeBean(int id)
                        throws InsightException

Deprecated.

use the deleteObjectAttributeBean(long) instead

Deletes an object attribute bean

Throws:

InsightException

deleteObjectAttributeBean

@Deprecated
void deleteObjectAttributeBean(int id,
 @Nonnull
 com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)
                        throws InsightException

Deprecated.

use the deleteObjectAttributeBean(long, EventDispatchOption) instead

Deletes an object attribute bean

Throws:

InsightException

deleteObjectAttributeBean

void deleteObjectAttributeBean(long id)
                        throws InsightException

Deletes an object attribute bean

Throws:

InsightException

deleteObjectAttributeBean

void deleteObjectAttributeBean(long id,
 @Nonnull
 com.riadalabs.jira.plugins.insight.services.events.EventDispatchOption eventDispatchOption)
                        throws InsightException

Deletes an object attribute bean

Throws:

InsightException

loadObjectAttributeBean

ObjectAttributeBean loadObjectAttributeBean(int objectId,
 int objectTypeAttributeId)
                                     throws InsightException

Loads a ObjectAttributeBean given an object id and object type attribute id

Returns:

a ObjectAttributeBean

Throws:

InsightException

loadObjectAttributeBean

ObjectAttributeBean loadObjectAttributeBean(int objectId,
 int objectTypeAttributeId,
 boolean ignorePermissionCheck)
                                     throws InsightException

Loads a ObjectAttributeBean given an object id, object type attribute id and a parameter to ignore permission check

Returns:

a ObjectAttributeBean

Throws:

InsightException

loadObjectAttributeBean

ObjectAttributeBean loadObjectAttributeBean(int objectId,
 String objectTypeAttributeName)
                                     throws InsightException

Loads a ObjectAttributeBean given an object id and object type attribute name

Returns:

a ObjectAttributeBean

Throws:

InsightException

findObjectHistoryBean

List<ObjectHistoryBean> findObjectHistoryBean(int objectId)
                                       throws InsightException

Find the ObjectBean history

Returns:

a list of ObjectHistoryBean

Throws:

InsightException

loadAttachmentBeanById

AttachmentBean loadAttachmentBeanById(int id)
                               throws InsightException

Load a AttachmentBean

Returns:

a AttachmentBean

Throws:

InsightException

addAttachmentBean

AttachmentBean addAttachmentBean(int objectId,
 File file,
 String fileName,
 String contentType,
 String comment)
                          throws InsightException

Add a AttachmentBean domain objects.

Parameters:

objectId - the ObjectBean id

file - the file to add

fileName - the filename

contentType - the content type

comment - an optional comment

Returns:

the added AttachmentBean

Throws:

InsightException

findAttachmentBeans

List<AttachmentBean> findAttachmentBeans(int objectId)
                                  throws InsightException

Finds attachmentBeans for specified ObjectBean id

Parameters:

objectId - the ObjectBean id

Returns:

a list of AttachmentBean

Throws:

InsightException

deleteAttachmentBean

AttachmentBean deleteAttachmentBean(int id)
                             throws InsightException

Delete AttachmentBean

Returns:

the deleted AttachmentBean

Throws:

InsightException

findObjectTicketConnections

List<ObjectTicketConnectionEntry> findObjectTicketConnections(int objectId)
                                                       throws InsightException

Find all JIRA issues connected to an ObjectBean

Returns:

list of ObjectTicketConnectionEntry

Throws:

InsightException

findObjectTicketConnections

@Deprecated
List<ObjectTicketConnectionEntry> findObjectTicketConnections(int objectId,
 int offset,
 int limit)
                                                       throws InsightException

Deprecated.

use findObjectTicketConnections(int) instead

Throws:

InsightException

findObjectTicketConnections

List<ObjectTicketConnectionEntry> findObjectTicketConnections(long ticketId)
                                                       throws InsightException

Find all ObjectBean connected to a JIRA issue

Returns:

list of ObjectTicketConnectionEntry

Throws:

InsightException

deleteCommentBean

void deleteCommentBean(int commentBeanId)
                throws InsightException

Delete a CommentBean

Throws:

InsightException

storeCommentBean

CommentBean storeCommentBean(CommentBean commentBean)
                      throws InsightException

Store a CommentBean

Returns:

the stored CommentBean

Throws:

InsightException

findCommentBeans

List<CommentBean> findCommentBeans(int objectId)
                            throws InsightException

Find all CommentBean for an ObjectBean

Returns:

a list of CommentBean

Throws:

InsightException

loadCommentBean

CommentBean loadCommentBean(int commentId)
                     throws InsightException

Load a CommentBean

Returns:

a CommentBean

Throws:

InsightException

loadWatcherBean

WatcherBean loadWatcherBean(int objectId,
 String userKey)
                     throws InsightException

Loads a WatcherBean

Parameters:

objectId - the ObjectBean id

userKey - the User key

Returns:

a WatcherBean

Throws:

InsightException

findWatcherBeans

List<WatcherBean> findWatcherBeans(int objectId)
                            throws InsightException

Finds all WatcherBean for an ObjectBean

Returns:

a list of WatcherBean

Throws:

InsightException

createWatcherBean

WatcherBean createWatcherBean(int objectId,
 String userKey)
                       throws InsightException

Created a WatcherBean

Parameters:

objectId - the ObjectBean id

userKey - the userkey

Returns:

a created WatcherBean

Throws:

InsightException

deleteWatcherBean

void deleteWatcherBean(WatcherBean watcherBean)
                throws InsightException

Delete a WatcherBean

Throws:

InsightException

moveObjects

Progress moveObjects(MoveObjectBean moveObjectBean)
              throws Exception

Move objects to another object type

Returns:

a Progress

Throws:

Exception

validateObjectBean

void validateObjectBean(MutableObjectBean objectBean)
                 throws ValidationInsightException,
IQLValidationException

Validate an object bean. This will be implicitly be executed on store object

Throws:

ValidationInsightException

IQLValidationException

validateObjectAttributeBean

void validateObjectAttributeBean(MutableObjectAttributeBean objectAttributeBean,
 ObjectBean objectBean)
                          throws ValidationInsightException,
IQLValidationException

Validate an object attribute bean. This will be implicitly be executed on store object

Throws:

ValidationInsightException

IQLValidationException