1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
/*******************************************************************************
* Copyright (c) 2010 BSI Business Systems Integration AG.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* BSI Business Systems Integration AG - initial API and implementation
******************************************************************************/
package org.eclipse.scout.rt.shared.data.model;
import java.security.Permission;
import java.util.Map;
import org.eclipse.scout.commons.beans.IPropertyObserver;
import org.eclipse.scout.commons.exception.ProcessingException;
import org.eclipse.scout.rt.shared.services.common.code.ICodeType;
import org.eclipse.scout.rt.shared.services.lookup.LookupCall;
public interface IDataModelAttribute extends IPropertyObserver, DataModelConstants {
void initAttribute() throws ProcessingException;
/**
* For {@link #TYPE_CODE_LIST}, {@link #TYPE_CODE_TREE}, {@link #TYPE_NUMBER_LIST}, {@link #TYPE_NUMBER_TREE} and
* {@link #TYPE_SMART} only. Delegate of the callback {@link AbstractListBox#execPrepareLookup(LookupCall)} and
* {@link AbstractTreeBox#execPrepareLookup(LookupCall, org.eclipse.scout.rt.client.ui.basic.tree.ITreeNode)}
*/
void prepareLookup(LookupCall call) throws ProcessingException;
String getText();
void setText(String s);
/**
* @return the type of field to display to select a value for this attribute
* see the TYPE_* values
*/
int getType();
void setType(int type);
IDataModelAttributeOp[] getOperators();
void setOperators(IDataModelAttributeOp[] ops);
/**
* @return array of {@link DataModelConstants#AGGREGATION_*}
*/
int[] getAggregationTypes();
/**
* @param aggregationTypes
* array of {@link DataModelConstants#AGGREGATION_*}
*/
void setAggregationTypes(int[] aggregationTypes);
boolean containsAggregationType(int agType);
String getIconId();
void setIconId(String s);
boolean isNullOperatorEnabled();
void setNullOperatorEnabled(boolean b);
boolean isNotOperatorEnabled();
void setNotOperatorEnabled(boolean b);
boolean isAggregationEnabled();
void setAggregationEnabled(boolean aggregationEnabled);
Class<? extends ICodeType> getCodeTypeClass();
void setCodeTypeClass(Class<? extends ICodeType> codeTypeClass);
LookupCall getLookupCall();
void setLookupCall(LookupCall call);
Permission getVisiblePermission();
void setVisiblePermission(Permission p);
boolean isVisibleGranted();
void setVisibleGranted(boolean b);
boolean isVisible();
void setVisible(boolean b);
boolean isActiveFilterEnabled();
void setActiveFilterEnabled(boolean active);
/**
* Client code should not call this method, it is used internally to set up a {@link IDataModel} structure
*
* @deprecated will be renamed to setParentEntityInternal and set to package private
*/
@Deprecated
IDataModelEntity getParentEntity();
/**
* Client code should not call this method, it is used internally to set up a {@link IDataModel} structure
*
* @deprecated will be renamed to setParentEntityInternal and set to package private
*/
@Deprecated
void setParentEntity(IDataModelEntity parent);
/**
* @return meta data for the attribute, default returns null
* <p>
* This method is useful and should be overridden when dynamic attributes are used, where multiple attributes
* of the same type (Class) occur in the same {@link IDataModel}. This meta map contains the distinguishing
* map of these multiple instances.
* <p>
* If the map is not filled or null, the comparison is only based on the type ({@link #getClass()})
* <p>
* see {@link DataModelUtility}
*/
Map<String, String> getMetaDataOfAttribute();
/**
* Describes whether this attribute holds a multi-value content. The default implementation derives the result from
* {@link #getType()}. The following types are considered multi-valued:
* <ul>
* <li>{@link DataModelConstants#TYPE_CODE_LIST}</li>
* <li>{@link DataModelConstants#TYPE_CODE_TREE}</li>
* <li>{@link DataModelConstants#TYPE_NUMBER_LIST}</li>
* <li>{@link DataModelConstants#TYPE_NUMBER_TREE}</li>
* </ul>
* <p>
* A multi valued attribute behaves same as {@link IDataModelEntity#isOneToMany()}
*
* @return Returns <code>true</code> if this attribute holds multiple values. <code>false</code> otherwise.
* @since 3.8.0
*/
boolean isMultiValued();
/**
* Formats the provided raw value according to the defined attribute type.
*
* @param rawValue
* Raw value to format.
* @return Formatted value
*/
String formatValue(Object rawValue);
}
|
