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

Interface IDataSetFieldsWrapper

All Superinterfaces:

Comparable<IDataSetFieldsWrapper>

All Known Implementing Classes:

DataSetsFieldsWrapperBase, DataSetsFieldsWrapperField, DataSetsFieldsWrapperFolder, DataSetsFieldsWrapperNested, DataSetsFieldsWrapperWithChildrenBase

public interface IDataSetFieldsWrapper
extends Comparable<IDataSetFieldsWrapper>

Wrapper for field model object, provides uninform interface for field, folder and table. For folder and table wrapper operations like rename and remove affect "child" fields.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IDataSetFieldsWrapper.FieldCommand	Command for field (wrapper for CompoundCommand)
static class	IDataSetFieldsWrapper.FieldRenameException	Exception of field renaming

Method Summary

Modifier and Type	Method	Description
IDataSetFieldsWrapper.FieldCommand	copy(String parentPath, String name)	Copy field
DataSetField	getField()	Get field
String	getName()	Get name (field in viewer)
String	getPath()	Get data path
Presentation	getTitle()	Get title
String	getTitle(String languageCode)	Get title for current language
boolean	isFolder()	Check whether field is folder
boolean	isTitleAuto()	Check whether title is autogenerated
IDataSetFieldsWrapper.FieldCommand	remove()	Remove field
IDataSetFieldsWrapper.FieldCommand	setName(String name, boolean checkUnique)	Set name (field in viewer)
IDataSetFieldsWrapper.FieldCommand	setPath(String path, boolean checkUnique)	Set data path
IDataSetFieldsWrapper.FieldCommand	setTitle(LocalString title)	Set title
IDataSetFieldsWrapper.FieldCommand	setTitle(Presentation title)	Set title

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getField

DataSetField getField()

Get field

Returns:

field, never null

getName

String getName()

Get name (field in viewer)

Returns:

name, never null, empty for folder

setName

IDataSetFieldsWrapper.FieldCommand setName(String name,
                                           boolean checkUnique)
                                    throws IDataSetFieldsWrapper.FieldRenameException

Set name (field in viewer)

Parameters:

name - name, can't be null

checkUnique - check whether name is unique

Returns:

command, never null

Throws:

IDataSetFieldsWrapper.FieldRenameException - if checkUnique true and name is not unique

getPath

String getPath()

Get data path

Returns:

path, never null

setPath

IDataSetFieldsWrapper.FieldCommand setPath(String path,
                                           boolean checkUnique)
                                    throws IDataSetFieldsWrapper.FieldRenameException

Set data path

Parameters:

path - path, can't be null

checkUnique - check whether path is unique

Returns:

command, never null

Throws:

IDataSetFieldsWrapper.FieldRenameException - if checkUnique true and path is not unique

isTitleAuto

boolean isTitleAuto()

Check whether title is autogenerated

Returns:

whether title is autogenerated

getTitle

Presentation getTitle()

Get title

Returns:

title, never null

getTitle

String getTitle(String languageCode)

Get title for current language

Returns:

title, never null

setTitle

IDataSetFieldsWrapper.FieldCommand setTitle(LocalString title)

Set title

Parameters:

title - title, can't be null

Returns:

command, never null

setTitle

IDataSetFieldsWrapper.FieldCommand setTitle(Presentation title)

Set title

Parameters:

title - title, can't be null

Returns:

command, never null

isFolder

boolean isFolder()

Check whether field is folder

Returns:

whether field is folder

copy

IDataSetFieldsWrapper.FieldCommand copy(String parentPath,
                                        String name)

Copy field

Parameters:

parentPath - parent path for copy, can't be null

name - name for copy, can't be null

Returns:

command, never null

remove

IDataSetFieldsWrapper.FieldCommand remove()
                                   throws IDataSetFieldsWrapper.FieldRenameException

Remove field

Returns:

command, never null

Throws:

IDataSetFieldsWrapper.FieldRenameException - if after removing name of some child field won't be unique