|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectbiz.c24.io.api.data.DataType
biz.c24.io.api.data.ComplexDataType
biz.c24.io.api.data.swift.SwiftFieldDataType
public class SwiftFieldDataType
A type representing a S.W.I.F.T field.
Warning: Serialized objects of this class or of a deployed class which is derived from it may not be compatible with future releases of C24 Integreation Objects. The current serialization support is appropriate for short term storage or RMI between applications running the same version of C24 Integreation Objects.
Nested Class Summary | |
---|---|
class |
SwiftFieldDataType.QualifiedRestrictionMap
A S.W.I.F.T. specific restriction to ensure the enumeration of a particular subfield is restricted when a certain qualifier, option and data source scheme combination are present. |
Field Summary | |
---|---|
static String |
IO_SWIFT_SUPRESSWARNINGS
Deprecated. Use Utils.SYSTEM_PROPERTY_SUPPRESS_SWIFT_WARNINGS instead. |
Fields inherited from class biz.c24.io.api.data.DataType |
---|
duringParsing, hasEnumerations, hasPatternMatching, qualifierValidation |
Constructor Summary | |
---|---|
SwiftFieldDataType()
Create a new instance. |
Method Summary | |
---|---|
void |
addQualifiedRestrictionMap(String qualifier,
DataComponent[] options,
boolean dssPresent,
int[] dssRestrictionMap,
String subfieldName,
int[] restrictionMap)
Add a restriction map, which operates when qualifier |
static Enumeration |
getAllowedQualifiers(ComplexDataObject swiftField,
SimpleDataType simpleDataType)
|
String |
getDataSourceSchemeFieldName()
Returns the name of the SWIFT data source scheme field. |
SwiftFieldDataType.QualifiedRestrictionMap |
getQualifiedRestrictionMap(int index)
Returns the restriction map at index . |
int |
getQualifiedRestrictionMapCount()
Returns the number of restriction maps which have been added to this field. |
String |
getQualifierFieldName()
Returns the name of the SWIFT qualifier field. |
static Enumeration |
getSpecificRestrictions(ComplexDataObject swiftField,
SimpleDataType subfieldType)
Returns a restricted enumeration containing the specific values which must be matched by an object of type subfieldType inside swiftField . |
void |
removeQualifiedRestrictionMap(int index)
Removes the restriction map at index . |
void |
setDataSourceSchemeFieldName(String dataSourceSchemeFieldName)
Sets the name of the SWIFT data source scheme field. |
void |
setQualifierFieldName(String qualifierFieldName)
Sets the name of the SWIFT qualifier field. |
boolean |
validateProperties(Object object,
DataComponent comp,
ComplexDataObject context,
ValidationManager manager)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String IO_SWIFT_SUPRESSWARNINGS
Utils.SYSTEM_PROPERTY_SUPPRESS_SWIFT_WARNINGS
instead.
Constructor Detail |
---|
public SwiftFieldDataType()
Method Detail |
---|
public String getDataSourceSchemeFieldName()
public void setDataSourceSchemeFieldName(String dataSourceSchemeFieldName)
dataSourceSchemeFieldName
- The SWIFT data source scheme field name.public String getQualifierFieldName()
public void setQualifierFieldName(String qualifierFieldName)
qualifierFieldName
- The SWIFT qualifier field name.public void addQualifiedRestrictionMap(String qualifier, DataComponent[] options, boolean dssPresent, int[] dssRestrictionMap, String subfieldName, int[] restrictionMap)
qualifier is matched in one of options, dssPresent equals the presence of the data source scheme,
and if present the data source scheme value matches an item in dssRestrictionMap
.
- Parameters:
qualifier
- The value of the qualifier to match.options
- The array of options to match.dssPresent
- The presence of the data source scheme to match.dssRestrictionMap
- The restriction map to apply to the data source scheme. May be null.subfieldName
- The index of the subfield to be restricted.restrictionMap
- The restriction map to apply to the designated subfield.
public void removeQualifiedRestrictionMap(int index)
index
.
index
- The index of the map to be removed.public int getQualifiedRestrictionMapCount()
public SwiftFieldDataType.QualifiedRestrictionMap getQualifiedRestrictionMap(int index)
index
.
index
- The index of the map to return.
public static Enumeration getAllowedQualifiers(ComplexDataObject swiftField, SimpleDataType simpleDataType)
public static Enumeration getSpecificRestrictions(ComplexDataObject swiftField, SimpleDataType subfieldType)
subfieldType
inside swiftField
.
The restrictions applied will be drawn from the qualified restriction maps present on this type and the values of
the qualifier and data source scheme inside swiftField
.
swiftField
- The field to examine.subfieldType
- The type of the subfield to find.
subfieldType
if no specialisations exist
(this will be null
if subfieldType
does not contain an enumeration).
IllegalArgumentException
- If the type of swiftField
is not an instance of this class.public boolean validateProperties(Object object, DataComponent comp, ComplexDataObject context, ValidationManager manager) throws ValidationException
validateProperties
in class ComplexDataType
ValidationException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |