com.almworks.jira.structure.api.item.generic

Interface GenericItemService

@PublicApi
public interface GenericItemService

GenericItemService is responsible for performing get, create, update and delete operations with generic items.

Corresponding validation should be performed before all operations except get.

Along with data related to operation each result may contain an error collection with any error messages that may have been generated when performing the operation. Also result may contain exception that has been thrown during operation execution.

See Also:

GenericItemManager, GenericItem

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GenericItemService.CreateValidationResult
static class	GenericItemService.DeleteValidationResult
static class	GenericItemService.ExceptionSupportResult
static class	GenericItemService.GenericItemResult
static class	GenericItemService.UpdateValidationResult

Method Summary

Modifier and Type	Method and Description
GenericItemService.GenericItemResult	create(GenericItemService.CreateValidationResult validationResult)
GenericItemService.GenericItemResult	delete(GenericItemService.DeleteValidationResult validationResult)
GenericItemService.GenericItemResult	getItem(ItemIdentity itemId)
GenericItemService.GenericItemResult	update(GenericItemService.UpdateValidationResult validationResult)
GenericItemService.CreateValidationResult	validateCreate(String itemType, GenericItem genericItem)
GenericItemService.DeleteValidationResult	validateDelete(ItemIdentity itemId)
GenericItemService.UpdateValidationResult	validateUpdate(ItemIdentity itemId, GenericItem genericItem)

Method Detail

getItem

@NotNull
GenericItemService.GenericItemResult getItem(@NotNull
                                                      ItemIdentity itemId)

validateCreate

@NotNull
GenericItemService.CreateValidationResult validateCreate(@NotNull
                                                                  String itemType,
                                                                  @NotNull
                                                                  GenericItem genericItem)

create

@NotNull
GenericItemService.GenericItemResult create(@NotNull
                                                     GenericItemService.CreateValidationResult validationResult)

validateUpdate

@NotNull
GenericItemService.UpdateValidationResult validateUpdate(@NotNull
                                                                  ItemIdentity itemId,
                                                                  @NotNull
                                                                  GenericItem genericItem)

update

@NotNull
GenericItemService.GenericItemResult update(@NotNull
                                                     GenericItemService.UpdateValidationResult validationResult)

validateDelete

@NotNull
GenericItemService.DeleteValidationResult validateDelete(@NotNull
                                                                  ItemIdentity itemId)

delete

@NotNull
GenericItemService.GenericItemResult delete(@NotNull
                                                     GenericItemService.DeleteValidationResult validationResult)