Package com._1c.g5.v8.dt.dcs.dataset

Interface IDataSetWrapper

All Known Subinterfaces:
IDataSetsWrapper
All Known Implementing Classes:
DataSetsWrapperBase, DataSetsWrapperObject, DataSetsWrapperQuery, DataSetsWrapperUnion, DataSetWrapperBase, EmptyQueryDataSetWrapperBase
public interface IDataSetWrapper
Wrapper for data set model object, provides uninform interface for query, object and union data sets with runtime information about fields (tree of fields, fields synonyms, fields restrictions).

  • Method Details

    • init

      void init()
      Initialize

    • addField

      void addField(DataSetField currentField, DataSetField field) throws DcsPathException
      Add field
      Parameters:
      currentField - current field, can be null
      field - field, can't be null
      Throws:
      DcsPathException

    • copyField

      void copyField(DataSetField field, String parentPathNew)
      Copy field
      Parameters:
      field - field, can't be null
      parentPathNew - destination folder path or null (empty) for root

    • removeField

      void removeField(DataSetField field)
      Remove field
      Parameters:
      field - field, can't be null

    • moveField

      void moveField(DataSetField field, String parentPathNew)
      Move field
      Parameters:
      field - field, can't be null
      parentPathNew - destination folder path or null (empty) for root

    • getFieldsWrappers

      Collection<IDataSetFieldsWrapper> getFieldsWrappers()
      Get fields wrappers
      Returns:
      collection of fields wrappers, never null

    • getChildFields

      List<DataSetField> getChildFields(DataSetField parentField)
      Get child fields or root fields
      Parameters:
      parentField - parent field, can't be null
      Returns:
      list of fields, never null

    • getFieldName

      String getFieldName(DataSetField field)
      Get 'Field' property of field
      Parameters:
      field - field, can't be null
      Returns:
      value of 'Field' property name from source, never null, empty for folder

    • setFieldName

      void setFieldName(DataSetField field, String name)
      Set 'Field' property of field
      Parameters:
      field - field, can't be null
      name - value of 'Field' property

    • getFieldPath

      String getFieldPath(DataSetField field)
      Get 'Data path' property of field
      Parameters:
      field - field, can't be null
      Returns:
      value of 'Data path' property, never null

    • setFieldPath

      void setFieldPath(DataSetField field, String path)
      Set 'Data path' property of field
      Parameters:
      field - field, can't be null
      path - value of 'Data path' property, can't be null

    • setFieldTitle

      void setFieldTitle(DataSetField field, LocalString title)
      Set 'Title' property of field
      Parameters:
      field - field, can't be null
      title - value of 'Title' property, can't be null

    • getFieldSynonym

      IDataSetWrapper.FieldSynonym getFieldSynonym(String path)
      Get field synonym
      Parameters:
      path - path of field, can't be null
      Returns:
      synonym or null

    • getFieldUseRestriction

      IDataSetWrapper.FieldRestriction getFieldUseRestriction(String path)
      Get field use restriction
      Parameters:
      path - path of field, can't be null
      Returns:
      restriction or null

    • getFieldVisibilityRestriction

      IDataSetWrapper.FieldRestriction getFieldVisibilityRestriction(String path)
      Get field visibility restriction
      Parameters:
      path - path of field, can't be null
      Returns:
      restriction or null if no restrictions present

    • getField

      DataSetField getField(String path)
      Get field
      Parameters:
      path - field path, can't be null
      Returns:
      field or null if field not found

    • getAncestorField

      DataSetField getAncestorField(DataSetField field)
      Get ancestor for field
      Parameters:
      field - field, can't be null
      Returns:
      ancestor if exists or null

    • getCurrentLanguageCode

      String getCurrentLanguageCode()
      Get current language code
      Returns:
      language code, never null

    • getCurrentAlias

      int getCurrentAlias()
      Gets number of current alias
      Returns:
      number of current alias

    • createPath

      DcsPath createPath(String path) throws IDataSetFieldsWrapper.FieldRenameException
      Create path from string
      Parameters:
      path - string path, never null
      Returns:
      DCS path, never null
      Throws:
      IDataSetFieldsWrapper.FieldRenameException - if path is not valid

    • getFieldParentPath

      String getFieldParentPath(DataSetField field)
      Get path of field parent
      Parameters:
      field - field, can't be null
      Returns:
      path of field parent, can be null

    • setFieldUseRestiction

      void setFieldUseRestiction(DataSetField field, org.eclipse.emf.ecore.EStructuralFeature feature, boolean state)
      Set field restiction
      Parameters:
      field - field, can't be null
      feature - feature of restriction, can't be null
      state - state

    • setFieldAttrUseRestiction

      void setFieldAttrUseRestiction(DataSetField field, org.eclipse.emf.ecore.EStructuralFeature feature, boolean state)
      Set field attribute restiction
      Parameters:
      field - field, can't be null
      feature - feature of attribute restriction, can't be null
      state - state