Package com._1c.g5.v8.bm.integration

Interface IBmTask<T>

Record Components:
T - the type of task result.
All Known Subinterfaces:
ICleanUpProjectObjectTasksProvider.ICleanUpBmObjectTask
All Known Implementing Classes:
AbstractAddTask, AbstractBmTask, AbstractBpCoreTask, AbstractBpTask, AbstractBslMdObjectHandlerRenameParticipant.RenameHandlerTask, AbstractFormAttributeTask, AbstractMdObjectCollectionTask, AddActivityAttributeTask, AddAdditionTask, AddButtonTask, AddCaseTask, AddCommandToMainSectionTask, AddDecorationTask, AddDecorativeRelationTask, AddElementsTask, AddEntityTask, AddFieldTask, AddFieldWithTableTask, AddFormAttributeColumnTask, AddFormAttributeTask, AddFormCommandInterfaceItemTask, AddFormCommandTask, AddFormParameterTask, AddGroupTask, AddRemoveDrawingOperation, AddRemoveGroupOperation, AddRightValuesTask, AddRlsTask, AddRlsTemplateTask, AddSplitRelationTask, AddTableTask, AddToExtensionTask, AddUsualNotVisualGroup, ApplyFontOperation, ApplyFormatOperation, BaseApplyFormatOperation, BaseOperation, BasicCICustomizationTask, BasicCICustomizationTask1, BasicCICustomizationTask2, BasicDbObjectBasedOnTask, BmBasicTask, BmBasicTask1, BmBasicTask2, BmBasicTask2Collection, BmCompoundTask, CalculationRegisterActionPeriodChangeTask, CatalogChangeHierarchyTypeTask, CatalogChangeLimitLevelCountTask, ChangeCaseDesctiptionTask, ChangeCellsOperation, ChangeConfigurationRequiredMobileApplicationPermissionsTask, ChangeConfigurationUsePurposesTask, ChangeDataPathTask, ChangeDistributionSettingsTask, ChangeDocumentNumeratorInDocumentTask, ChangeDrawingOperation, ChangeDrawingPositionOperation, ChangeDrawingZOrder, ChangeDynamicListExtInfoCustomQueryTask, ChangeEntityTitleTask, ChangeFooterDataPath, ChangeFormAttributeSaveDataValueTask, ChangeFormAttributeUseAlwaysValueTask, ChangeGroupOperation, ChangeGroupParametersOperation, ChangeHeaderFooterOperation, ChangeIbmObjectTask, ChangeInformationRegisterDimensionMasterTask, ChangeInformationRegisterWriteModeTask, ChangeMdPictureTask, ChangeParagraphPropertyOperation, ChangeQuickChoiceTask, ChangeRelationTitleTask, ChangeRowsColumnsOperation, ChangeSpreadsheetOperation, ChangeSupportLanguagesTask, ChangeTypeDescriptionTask, ChangeTypeDescriptionTask, ChangeUserModeTask, ChartElementChangeBoundsTask, ChartOfCalculationTypesBaseChangeTask, CloneFormAttributeColumnTask, CloneFormAttributeTask, CloneFormItemTask, CollapseToLevelOperation, CollectBslStringReferenceForConfigurationProjectTask, CollectCharacteristicsDescriptionStringReferenceForConfigurationProjectTask, CollectReferenceForConfigurationProjectTask, CommonAttributeContentTask, CommonPictureCleanContentTask, CommonPictureLoadContentFromFileTask, CommonPictureSaveContentToFileTask, ComponentResizeTask, CompositeOperation, ConnectTask, CopyCellsOperation, CopyDrawingsOperation, CreateGroupBmTask, CutDrawingsOperation, DataSeriesAttributesSetTask, DataSeriesFeatureSetTask, DataSeriesItemAdditionTask, DeleteBrokenSubsystemTask, DeleteFormAttributeTask, DeleteFormCommandInterfaceItemTask, DeleteFormCommandTask, DeleteFormItemTask, DeleteFormParameterTask, DeleteInsertCellsOperation, DeleteObjectsFromRolesTask, DeleteRlsTask, DeleteRlsTemplateTask, DeleteRoleFromVisibilitiesTask, DocumentInJournalsTask, DocumentInSequncesTask, DocumentJournalRegisteredDocumentsTask, DocumentRegisterRecordsTask, EditRightValuesTask, EditRlsTask, EditRlsTemplateTask, ExchangePlanContentTask, ExpandCollapseAllOperation, ExpandCollapseOperation, FilterCriterionContentChangeTask, FormAutoCommandInterfaceTask, FunctionalOptionContentChangeTask, FunctionalOptionsParameterUseChangeTask, GeographicalSchemaInitTask, GroupDrawngsOperation, InsertBmTask, LayerAdditionTask, LayerFeatureSetTask, LayerObjectCopyTask, LayerObjectFeatureSetTask, LayerObjectsAttributesSetTask, LegendItemAdditionTask, LegendItemFeatureSetTask, LineStyleFeatureSetTask, ListElementsSwapTask, ListRemovalTask, MergeAndUnmergeOperation, MoveElementsTask, MoveFormCommandInterfaceItemTask, MoveFormItemTask, MoveToEndFormCommandInterfaceItemTask, MoveToEndFormItemTask, NotifyingOperation, PasteCellsOperation, PasteDrawingsOperation, PictureSetTask, PredefinedAccountAccountingFlagsTask, PredefinedAccountExtDimensionTypeCharacteristicTypeTask, PredefinedAccountExtDimensionTypeFlagTask, PredefinedAccountExtDimensionTypesTask, PredefinedAccountExtDimensionTypeTurnoversOnlyTask, PredefinedCalculationTypeCalculationBaseTask, PredefinedContainerCodeAllowedLengthChangeTask, PredefinedContainerCodeLengthChangeTask, PredefinedContainerCodeTypeChangeTask, PredefinedContainerDescriptionLengthChangeTask, PurgeUnsetErrorItemsBmTask, RefreshActivityAttributeTask, RemoveActivityAttributesTask, RemoveCaiGroupBmTask, RemoveCaiPanelBmTask, RemoveCaseTask, RemoveCommandFromMainSectionTask, RemoveCommandGroupFromMainSectionTask, RemoveElementsTask, RemoveRowColumnsOperation, RenameAreaOperation, ResetOrRemoveFormExtensionAttributeTask, ResetOrRemoveFormExtensionCommandTask, ResetOrRemoveFormExtensionParameterTask, SchemaBoundsSetTask, SequenceDocumentsChangeTask, SequenceRegistersChangeTask, SetAdditionSourceTask, SetAllRightsTask, SetAutoWidthCalculationOperation, SetColumnWidthOperation, SetCommandOrderTask, SetCommandPlacementTask, SetCommandVisibilityTask, SetDefaultCommandOrderTask, SetDefaultCommandPlacementTask, SetDefaultCommandVisibilityTask, SetDefaultSubsystemOrderTask, SetDefaultSubsystemVisibilityTask, SetDefaultWidthWeightFactorOperation, SetFormItemTypeTask, SetIndependentRightsOfChildObjectsTask, SetMainAttributeTask, SetRemovePrintAreaOperation, SetRemoveRepeatedColumnsOperation, SetRemoveRepeatedRowsOperation, SetRowHeightOperation, SetSetRightsForAttributesByDefaultTask, SetSetRightsForNewObjectsTask, SetSheetDefaultHeightOperation, SetSheetDefaultWidthOperation, SetSubsystemOrderTask, SetSubsystemVisibilityTask, SetVisibilityTask, SetWidthWeightFactorOperation, ShowHideOperation, SplitCellHorizontalOperation, SplitCellVerticalOperation, SubsystemContentChangeTask, SubsystemIncludeInCommandInterfaceTask, UngroupDrawingsOperation, UnsetWidthWeightFactorOperation, UpdateFormDefaultButtonTask, UseStandardCommandChangeTask
public interface IBmTask<T>
The interface that describes the BM task for objects editing. A task is the only valid way to edit BM objects.

The main point of task is the execute method. It should contain all required objects modifications.

The task is executed inside an editing context which provides the BM transaction.
The example below shows a common flow to objects editing: 

 
 Object execute(IBmTransaction transaction, IProgressMonitor progressMonitor)
 {
      SomeObject someObject = transaction.getObjectByFqn("someObject.FQN");
      someObject.setName("Some Object New Name");
      //...
      return null;
 }

The task also is described by name. The name is a localized string that can be used, for example, to show previous/current/next task on UI.

A task may implement IBmPostUndoRedoHandler to provide custom post undo/redo handlers:

  • #onRedo() - invoked after the task is redone.
  • #onUndo() - invoked after the task is undone.
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    T
    execute(IBmTransaction transaction, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
    The method called by the task executor with an active transaction.
    Object
    getId()
    Gets the ID of the task.
    String
    getName()
    Gets the localized name of the task to be displayed on the UI, logs, etc.
    Object
    getServiceId()
    Gets the ID of the service executing this task.

  • Method Details

    • getName

      String getName()
      Gets the localized name of the task to be displayed on the UI, logs, etc.
      Returns:
      the name of the task, never null.

    • getId

      Object getId()
      Gets the ID of the task.
      Returns:
      the ID of the task or null.

    • getServiceId

      Object getServiceId()
      Gets the ID of the service executing this task.
      Returns:
      the ID of the service or null.

    • execute

      T execute(IBmTransaction transaction, org.eclipse.core.runtime.IProgressMonitor progressMonitor)

      The method called by the task executor with an active transaction. The method code must not commit or rollback the transaction.

      If the task is not supposed to return a result, then it may be parameterized with Void and return null.

      Parameters:
      transaction - The active transaction. May not be null.
      progressMonitor - The monitor to indicate the progress. May not be null.
      Returns:
      execution result, may be null.