com.oberon.ooql.sdk
Class Field

java.lang.Object
  com.oberon.ooql.sdk.OBBase
      com.oberon.ooql.sdk.AdminBase
          com.oberon.ooql.sdk.Field

All Implemented Interfaces:

java.io.Serializable

public class Field
extends AdminBase
implements java.io.Serializable

Field Admin Object: defines an OBEROn object [ObjectObj] or Link field.

Version:

5.0

See Also:

Serialized Form

Field Summary

static java.lang.String	ATTRSEP The value separator for multivalue Fields
static int	MULTILINE_OPTION The Multiline flag index inside the Option Set
static int	MULTIPLE_OPTION The Multiple flag index inside the Option Set
static int	RESET_NONE Field value is never automatically reset
static int	RESET_ONCLONE Field value is reset to default value for the new copy instance
static int	RESET_ONCREATE Field value is resetted to default value for all new instances
static int	RESET_ONREVISE Field value is reset to default value for the new revision instance
java.lang.String	sDefault
static int	TYPE_BOOLEAN Boolean (true/false) type
static int	TYPE_DATE Date type - the format is yyyy-MM-dd
static int	TYPE_DATETIME DateTime type - the format is yyyy-MM-dd HH:mm:ss zzz
static int	TYPE_INTEGER Integer type
static int	TYPE_length
static int	TYPE_REAL Real number type
static int	TYPE_STRING String type
static int	TYPE_TEXT Long Text type

Fields inherited from class com.oberon.ooql.sdk.AdminBase

bsOptions, HIDDEN_OPTION

Constructor Summary

Field()

Field(java.lang.String name)

Method Summary

void	addRange(FieldRange range) Add a Range value/interval to this Field;
void	addTrigger(Trigger trigger) Add a Trigger to this Field;
void	addUnitMeasure(java.lang.String unitMeasureName) Appends a new UnitMeasure to the MetricSystem
java.lang.String	compareUpdate(Field refField, boolean checkImage, boolean overwrite, boolean force, Framework framework) Return/apply the OOQL command to update this Field object and let it become equals to another reference object.
java.util.Vector<java.lang.String>	computeProgramRanges(java.util.Vector<java.lang.Object> filterArgs, Framework framework) Execute the range Program to compute the Field ranges
java.lang.String	convertValueFromUserUnitMeasure(java.lang.String value, Framework framework, java.util.Hashtable<java.lang.String,java.lang.Integer> counters) Return the UnitMeasure for this Field on the basis of current Framework user
java.lang.String	convertValueToUserUnitMeasure(java.lang.String value, Framework framework, java.util.Hashtable<java.lang.String,java.lang.Integer> counters) Return the UnitMeasure for this Field on the basis of current Framework user
void	create(boolean force, Framework framework) Create a new Field object on the database
void	create(Framework framework) Create a new Field object on the database
void	destroy(Framework framework) Remove the Field object from the database
void	fromXML(org.jdom.Element rootElement) Load the Field object properties from XML element tree
java.util.Vector<java.lang.String>	getAllClassIds(Framework framework) Get the IDs of all Classes where the Field is used [INTERNAL USAGE]
java.util.Vector<java.lang.String>	getAllLinkTypeIds(Framework framework) Get the IDs of all LinkTypes where the Field is used [INTERNAL USAGE]
java.util.Vector<java.lang.String>	getClasses(Framework framework) Return the list of Classes where this Field is used
java.lang.String	getClassesAsString(java.lang.String delim, Framework framework) Return the list of Classes where this Field is used, as a String
java.lang.String	getCreateCommand(boolean force) Return the OOQL command to create this Field object with the settled properties
java.lang.String	getDefault() Get the Field default value
java.util.Vector<java.lang.String>	getLinkTypes(Framework framework) Return the list of LinkTypes where this Field is used
java.lang.String	getLinkTypesAsString(java.lang.String delim, Framework framework) Return the list of LinkTypes where this Field is used, as a String
java.lang.String	getProperty(java.lang.String propertyName, java.util.Vector<java.lang.Object> filterArgs, java.lang.String token, Framework framework) Get a property for this Field object by its OOQL identifier
java.lang.String	getRangeProgram() Get the range Program
java.util.Vector<FieldRange>	getRanges() Return the range values/intervals defined for this Field
java.lang.String	getRangesAsString(java.lang.String delim) Return the range values/intervals defined for this Field, as a String
java.util.Vector<java.lang.String>	getRangeValues() Return the range values defined for this Field
int	getReset() Get the Reset option
java.lang.String	getResetAsString(int reset) Convert the reset behavior to OOQL string
java.lang.String	getSaveCommand(boolean force) Return the OOQL command to update this Field object with the modified properties.
java.util.Vector<?>	getTargetNames(java.lang.String composedName, java.util.Vector<java.lang.Object> filterArgs, Framework framework) Return a Vector of administrative object names extracted by using an OOQL selector
Trigger	getTriggerByEvent(java.lang.String event) Get the Program-Trigger for a specific event
java.util.Vector<Trigger>	getTriggers() Return the list of own Triggers defined for this Field
java.lang.String	getTriggersAsString(java.lang.String delim) Return the list of Program-Triggers, as a String
int	getType() Get the Field type
java.lang.String	getTypeAsString() Get the Field type in OOQL format
static int	getTypeFromString(java.lang.String fieldType) Convert Field type from OOQL format
java.util.Vector<java.lang.String>	getUnitMeasures() Return the list of UnitMeasures for this MetricSystem
java.lang.String	getUnitMeasuresAsString(java.lang.String delim) Return the list of UnitMeasure, as a String
int	getUnitMeasureType() Get the Unit Measure type.
UnitMeasure	getUserUnitMeasure(Framework framework, java.util.Hashtable<java.lang.String,java.lang.Integer> counters) Return the UnitMeasure for this Field on the basic of current Framework user
java.lang.String	getUserUnitMeasureName(Framework framework, java.util.Hashtable<java.lang.String,java.lang.Integer> counters) Return the UnitMeasure name for this Field on the basis of current Framework user
java.lang.String	getUserUnitMeasureSymbol(Framework framework, java.util.Hashtable<java.lang.String,java.lang.Integer> counters) Return the UnitMeasure symbol for this Field on the basis of current Framework user
java.lang.String	getWorkflowAsString(java.lang.String delim) Return the list of Workflow-Triggers, as a String
Trigger	getWorkflowByEvent(java.lang.String event) Get the Workflow-Trigger for a specific event
boolean	isDefaultValue(java.lang.String value) Check if a value is equal to the Field default value
boolean	isMultiline() Check if the Field is multiline.
boolean	isMultipleValues() Check if the Field is multiple values.
static boolean	isValidDate(java.lang.String date) Check if a date is correctly formatted
static boolean	isValidDateTime(java.lang.String date) Check if a date-time is correctly formatted
boolean	isValidMultiValue(java.lang.String value) Check if a multivalue is valid for this Field (check the field type and the value ranges for each value).
boolean	isValidValue(java.lang.String value) Check if a value is valid for this Field (check the field type and the value ranges).
void	link(Framework framework, java.util.Hashtable<java.lang.String,java.lang.Integer> counters) Open the Field object: connect the memory instance with the database instance
static Field	open(java.lang.String name, Framework framework) Open an administrative object and read properties from the database or retrieve them from memory cache
static Field	open(java.lang.String name, Framework framework, java.util.Hashtable<java.lang.String,java.lang.Integer> counters) Open an administrative object and read properties from the database or retrieve them from memory cache
org.jdom.Element	rangesToXML(java.lang.String rangeId, java.util.Vector<java.lang.Object> filterArgs, Framework framework) Return the Field-Ranges as XML element tree
void	removeRange(FieldRange range) Remove a Range value/interval from this Field
void	removeTrigger(Trigger trigger) Remove a Trigger from this Field
void	removeUnitMeasure(java.lang.String unitMeasureName) Remove a UnitMeasure from the MetricSystem
void	setDefault(java.lang.String defaultValue) Set the Field default value.
void	setDefaultAsToday() Set the Field default value for dates as today.
void	setMultiline(boolean multiline) Set the multiline flag for this Field.
void	setMultipleValues(boolean multiple) Set the multiple value flag for this Field.
void	setName(java.lang.String name) Set the administrative object Name
void	setRangeProgram(java.lang.String programName) Set a method to generate range values
void	setReset(int reset) Set the Reset option
void	setReset(java.lang.String reset) Set the Reset option
void	setTriggers(java.util.Vector<Trigger> triggers) Set Triggers for this Field;
void	setType(int type) Set the Field type.
void	setUnitMeasureType(int umtype) Set the Unit Measure type.
java.lang.String	toString() Return the Field object basic properties as a single String
java.lang.String	toString(Framework framework) Return the Field object extended properties as a single String
org.jdom.Element	toXML(boolean getImage, boolean fullDump, Framework framework) Return the Field object properties as XML element tree
org.jdom.Element	toXML(Framework framework) Return the Field object properties as XML element tree
void	unlink(Framework framework) Close the object: disconnect the memory instance from the database instance
void	updateRanges(java.util.Vector<FieldRange> ranges) Update the ranges on the basis of a given list
void	updateTriggers(java.util.Vector<Trigger> triggers) Update the triggers on the basis of a given list
void	updateUnitMeasures(java.util.Vector<java.lang.String> unitMeasures) Update the unit measures on the basis of a given list
void	write(boolean force, Framework framework) Update the Field object to the database
void	write(Framework framework) Update the Field object to the database

Methods inherited from class com.oberon.ooql.sdk.AdminBase

addFeature, changedApplication, checkChangeName, checkCounters, checkCounters, getAdminType, getApplication, getCommonProperty, getCommonTargetNames, getCounters, getCreateBasicCommand, getCreateCommand, getCrtDate, getDescription, getEditBasicCommand, getFeature, getFeatures, getFeaturesAsString, getImage, getImage, getImage, getImageData, getImageFile, getModDate, getModUser, getName, getOldName, getPlainFeatures, getSaveCommand, getSVNRevision, getXMLFeatureList, hasImage, isHidden, setApplication, setCounters, setCrtDate, setDescription, setHidden, setImage, setImageData, setImageFile, setModDate, setModUser, setSVNRevision, show, show, toCommonXML, toXML

Methods inherited from class com.oberon.ooql.sdk.OBBase

addChange, addUniqueChange, ChangesFromXML, ChangesToXML, getChanges, getChangesAsString, getId, isLinked, removeChange, resetChanges, setId, setLinked

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ATTRSEP

public static final java.lang.String ATTRSEP

The value separator for multivalue Fields

See Also:

Constant Field Values

MULTIPLE_OPTION

public static final int MULTIPLE_OPTION

The Multiple flag index inside the Option Set

See Also:

Constant Field Values

MULTILINE_OPTION

public static final int MULTILINE_OPTION

The Multiline flag index inside the Option Set

See Also:

Constant Field Values

TYPE_STRING

public static final int TYPE_STRING

String type

See Also:

Constant Field Values

TYPE_INTEGER

public static final int TYPE_INTEGER

Integer type

See Also:

Constant Field Values

TYPE_REAL

public static final int TYPE_REAL

Real number type

See Also:

Constant Field Values

TYPE_BOOLEAN

public static final int TYPE_BOOLEAN

Boolean (true/false) type

See Also:

Constant Field Values

TYPE_DATE

public static final int TYPE_DATE

Date type - the format is yyyy-MM-dd

See Also:

Constant Field Values

TYPE_TEXT

public static final int TYPE_TEXT

Long Text type

See Also:

Constant Field Values

TYPE_DATETIME

public static final int TYPE_DATETIME

DateTime type - the format is yyyy-MM-dd HH:mm:ss zzz

See Also:

Constant Field Values

TYPE_length

public static final int TYPE_length

See Also:

Constant Field Values

RESET_NONE

public static final int RESET_NONE

Field value is never automatically reset

See Also:

Constant Field Values

RESET_ONCREATE

public static final int RESET_ONCREATE

Field value is resetted to default value for all new instances

See Also:

Constant Field Values

RESET_ONREVISE

public static final int RESET_ONREVISE

Field value is reset to default value for the new revision instance

See Also:

Constant Field Values

RESET_ONCLONE

public static final int RESET_ONCLONE

Field value is reset to default value for the new copy instance

See Also:

Constant Field Values

sDefault

public java.lang.String sDefault

Constructor Detail

Field

public Field()

Field

public Field(java.lang.String name)
      throws OberonException

Parameters:

name - the name of the administrative object

Throws:

OberonException - if the name contains invalid characters

Method Detail

setName

public void setName(java.lang.String name)
             throws OberonException

Description copied from class: AdminBase

Set the administrative object Name

Overrides:

setName in class AdminBase

Parameters:

name - the name of the administrative object

Throws:

OberonException - if the name contains the pipe '|' character

open

public static Field open(java.lang.String name,
                         Framework framework)
                  throws OberonException

Open an administrative object and read properties from the database or retrieve them from memory cache

Parameters:

name - the object name

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions

Since:

4.0

open

public static Field open(java.lang.String name,
                         Framework framework,
                         java.util.Hashtable<java.lang.String,java.lang.Integer> counters)
                  throws OberonException

Open an administrative object and read properties from the database or retrieve them from memory cache

Parameters:

name - the object name

framework - the current framework

counters - administrative object synch counters (if null read them from database)

Throws:

OberonException - usually due to DB SQL exceptions

link

public void link(Framework framework,
                 java.util.Hashtable<java.lang.String,java.lang.Integer> counters)
          throws OberonException

Open the Field object: connect the memory instance with the database instance

Specified by:

link in class AdminBase

Parameters:

framework - the current framework

counters - administrative object synch counters (if null read them from database)

Throws:

OberonException - usually due to DB SQL exceptions

create

public void create(Framework framework)
            throws OberonException

Create a new Field object on the database

Specified by:

create in class AdminBase

Parameters:

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

create

public void create(boolean force,
                   Framework framework)
            throws OberonException

Create a new Field object on the database

Parameters:

force - if true ignores optional features

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

Since:

1.6

write

public void write(Framework framework)
           throws OberonException

Update the Field object to the database

Specified by:

write in class AdminBase

Parameters:

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

write

public void write(boolean force,
                  Framework framework)
           throws OberonException

Update the Field object to the database

Parameters:

force - if true ignores optional features

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

Since:

1.6

unlink

public void unlink(Framework framework)
            throws OberonException

Close the object: disconnect the memory instance from the database instance

Specified by:

unlink in class AdminBase

Parameters:

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions

destroy

public void destroy(Framework framework)
             throws OberonException

Remove the Field object from the database

Specified by:

destroy in class AdminBase

Parameters:

framework - the current framework

Throws:

OberonException - usually due to DB SQL exceptions or to limited user access rights

setType

public void setType(int type)

Set the Field type.

Parameters:

type - the Field type

getType

public int getType()

Get the Field type

getTypeAsString

public java.lang.String getTypeAsString()

Get the Field type in OOQL format

getTypeFromString

public static int getTypeFromString(java.lang.String fieldType)

Convert Field type from OOQL format

Returns:

the Field type

setUnitMeasureType

public void setUnitMeasureType(int umtype)

Set the Unit Measure type.

Parameters:

umtype - the Unit Measure type

Since:

2.4

getUnitMeasureType

public int getUnitMeasureType()

Get the Unit Measure type.

setDefault

public void setDefault(java.lang.String defaultValue)
                throws OberonException

Set the Field default value.

Parameters:

defaultValue - the default value

Throws:

OberonException - if the value is not compatible with the Field type

setDefaultAsToday

public void setDefaultAsToday()
                       throws OberonException

Set the Field default value for dates as today. If the default is "today", when an new instance of Link / Object is generated, the value for the field is replaced with the current date or date-time

Throws:

OberonException - if the value is not compatible with the Field type

Since:

3.0

getDefault

public java.lang.String getDefault()

Get the Field default value

isDefaultValue

public boolean isDefaultValue(java.lang.String value)

Check if a value is equal to the Field default value

Parameters:

value - the comparison value

setReset

public void setReset(int reset)

Set the Reset option

Parameters:

reset - the reset constant ( RESET_NONE / RESET_ONCREATE / RESET_ONREVISE / RESET_ONCLONE)

Since:

4.0

getReset

public int getReset()

Get the Reset option

Since:

4.0

See Also:

setReset(int)

getResetAsString

public java.lang.String getResetAsString(int reset)

Convert the reset behavior to OOQL string

Since:

4.0

setReset

public void setReset(java.lang.String reset)

Set the Reset option

Parameters:

reset - the OOQL reset behavior string ( none / oncreate / onrevise / onclone )

Since:

4.0

setMultipleValues

public void setMultipleValues(boolean multiple)

Set the multiple value flag for this Field. When a Field is multiple it can contain one or more range values

Parameters:

multiple - true to define the Field as multiple values

isMultipleValues

public boolean isMultipleValues()

Check if the Field is multiple values.

Returns:

the multiple flag

setMultiline

public void setMultiline(boolean multiline)

Set the multiline flag for this Field. When a Field is multiline it is represented as a form-textarea

Parameters:

multiline - true to define the Field as multiline

isMultiline

public boolean isMultiline()

Check if the Field is multiline.

Returns:

the multiline flag

setRangeProgram

public void setRangeProgram(java.lang.String programName)

Set a method to generate range values

Parameters:

programName - the Program name

getRangeProgram

public java.lang.String getRangeProgram()

Get the range Program

Returns:

the Program name

computeProgramRanges

public java.util.Vector<java.lang.String> computeProgramRanges(java.util.Vector<java.lang.Object> filterArgs,
                                                               Framework framework)

Execute the range Program to compute the Field ranges

Parameters:

filterArgs - extra arguments

framework - the current framework

Returns:

Vector of string values

addUnitMeasure

public void addUnitMeasure(java.lang.String unitMeasureName)

Appends a new UnitMeasure to the MetricSystem

Parameters:

unitMeasureName - the name of the UnitMeasure to add

Since:

2.4

removeUnitMeasure

public void removeUnitMeasure(java.lang.String unitMeasureName)

Remove a UnitMeasure from the MetricSystem

Parameters:

unitMeasureName - the name of the UnitMeasure to add

Since:

2.4

updateUnitMeasures

public void updateUnitMeasures(java.util.Vector<java.lang.String> unitMeasures)

Update the unit measures on the basis of a given list

Parameters:

unitMeasures - list of UnitMeasure's names

Since:

4.0

getUnitMeasures

public java.util.Vector<java.lang.String> getUnitMeasures()

Return the list of UnitMeasures for this MetricSystem

Returns:

a Vector of UnitMeasure names

Since:

2.4

getUnitMeasuresAsString

public java.lang.String getUnitMeasuresAsString(java.lang.String delim)

Return the list of UnitMeasure, as a String

Parameters:

delim - the separator item

Returns:

list of UnitMeasure names separated by the delim characters

Since:

2.4

getUserUnitMeasureName

public java.lang.String getUserUnitMeasureName(Framework framework,
                                               java.util.Hashtable<java.lang.String,java.lang.Integer> counters)

Return the UnitMeasure name for this Field on the basis of current Framework user

Parameters:

framework - the current framework

counters - administrative object synch counters (if null read them from database)

Since:

4.0

getUserUnitMeasureSymbol

public java.lang.String getUserUnitMeasureSymbol(Framework framework,
                                                 java.util.Hashtable<java.lang.String,java.lang.Integer> counters)

Return the UnitMeasure symbol for this Field on the basis of current Framework user

Parameters:

framework - the current framework

counters - administrative object synch counters (if null read them from database)

Since:

2.4

getUserUnitMeasure

public UnitMeasure getUserUnitMeasure(Framework framework,
                                      java.util.Hashtable<java.lang.String,java.lang.Integer> counters)

Return the UnitMeasure for this Field on the basic of current Framework user

Parameters:

framework - the current framework

counters - administrative object synch counters (if null read them from database)

Since:

2.4

convertValueToUserUnitMeasure

public java.lang.String convertValueToUserUnitMeasure(java.lang.String value,
                                                      Framework framework,
                                                      java.util.Hashtable<java.lang.String,java.lang.Integer> counters)

Return the UnitMeasure for this Field on the basis of current Framework user

Parameters:

value - the value to convert

framework - the current framework

counters - administrative object synch counters (if null read them from database)

Since:

2.4

convertValueFromUserUnitMeasure

public java.lang.String convertValueFromUserUnitMeasure(java.lang.String value,
                                                        Framework framework,
                                                        java.util.Hashtable<java.lang.String,java.lang.Integer> counters)

Return the UnitMeasure for this Field on the basis of current Framework user

Parameters:

value - the value to convert

framework - the current framework

counters - administrative object synch counters (if null read them from database)

Since:

2.4

isValidDate

public static boolean isValidDate(java.lang.String date)

Check if a date is correctly formatted

Parameters:

date - the date to check

isValidDateTime

public static boolean isValidDateTime(java.lang.String date)

Check if a date-time is correctly formatted

Parameters:

date - the date-time to check

isValidValue

public boolean isValidValue(java.lang.String value)

Check if a value is valid for this Field (check the field type and the value ranges).

Parameters:

value - the value to check

isValidMultiValue

public boolean isValidMultiValue(java.lang.String value)

Check if a multivalue is valid for this Field (check the field type and the value ranges for each value).

Parameters:

value - the multi-value to check

addRange

public void addRange(FieldRange range)
              throws OberonException

Add a Range value/interval to this Field;

Parameters:

range - the range to add

Throws:

OberonException

removeRange

public void removeRange(FieldRange range)

Remove a Range value/interval from this Field

Parameters:

range - the range to remove

updateRanges

public void updateRanges(java.util.Vector<FieldRange> ranges)
                  throws OberonException

Update the ranges on the basis of a given list

Parameters:

ranges - list of FieldRanges

Throws:

OberonException

Since:

4.0

getRanges

public java.util.Vector<FieldRange> getRanges()

Return the range values/intervals defined for this Field

Returns:

Vector of FieldRanges

getRangeValues

public java.util.Vector<java.lang.String> getRangeValues()

Return the range values defined for this Field

Returns:

Vector of range values

Since:

4.2

getRangesAsString

public java.lang.String getRangesAsString(java.lang.String delim)

Return the range values/intervals defined for this Field, as a String

Parameters:

delim - the separator item

Returns:

list of Ranges separated by the delim characters

See Also:

FieldRange.toString()

setTriggers

public void setTriggers(java.util.Vector<Trigger> triggers)

Set Triggers for this Field;

Parameters:

triggers - a vector of Triggers

addTrigger

public void addTrigger(Trigger trigger)
                throws OberonException

Add a Trigger to this Field;

Parameters:

trigger - the Trigger to add

Throws:

OberonException

removeTrigger

public void removeTrigger(Trigger trigger)

Remove a Trigger from this Field

Parameters:

trigger - the Trigger to remove

updateTriggers

public void updateTriggers(java.util.Vector<Trigger> triggers)
                    throws OberonException

Update the triggers on the basis of a given list

Parameters:

triggers - list of Triggers

Throws:

OberonException

Since:

4.0

getTriggers

public java.util.Vector<Trigger> getTriggers()

Return the list of own Triggers defined for this Field

Returns:

Vector of Triggers

getTriggersAsString

public java.lang.String getTriggersAsString(java.lang.String delim)

Return the list of Program-Triggers, as a String

Parameters:

delim - the separator item

Returns:

list of Triggers separated by the delim characters

See Also:

Trigger.asString()

getWorkflowAsString

public java.lang.String getWorkflowAsString(java.lang.String delim)

Return the list of Workflow-Triggers, as a String

Parameters:

delim - the separator item

Returns:

list of Triggers separated by the delim characters

Since:

2.1

See Also:

Trigger.asString()

getTriggerByEvent

public Trigger getTriggerByEvent(java.lang.String event)

Get the Program-Trigger for a specific event

Parameters:

event - the event name as defined by the OOQL syntax ( example: edit.check )

Returns:

the event Trigger or null if the event is not associated to a Trigger

getWorkflowByEvent

public Trigger getWorkflowByEvent(java.lang.String event)

Get the Workflow-Trigger for a specific event

Parameters:

event - the event name as defined by the OOQL syntax ( example: edit )

Returns:

the event Trigger or null if the event is not associated to a Trigger

Since:

2.1

getClasses

public java.util.Vector<java.lang.String> getClasses(Framework framework)

Return the list of Classes where this Field is used

Parameters:

framework - the current framework

Returns:

vector of Classes names

getClassesAsString

public java.lang.String getClassesAsString(java.lang.String delim,
                                           Framework framework)

Return the list of Classes where this Field is used, as a String

Parameters:

delim - the separator item

framework - the current framework

Returns:

list of Classes separated by the delim characters

getAllClassIds

public java.util.Vector<java.lang.String> getAllClassIds(Framework framework)

Get the IDs of all Classes where the Field is used [INTERNAL USAGE]

getLinkTypes

public java.util.Vector<java.lang.String> getLinkTypes(Framework framework)

Return the list of LinkTypes where this Field is used

Parameters:

framework - the current framework

Returns:

vector of LinkTypes names

getLinkTypesAsString

public java.lang.String getLinkTypesAsString(java.lang.String delim,
                                             Framework framework)

Return the list of LinkTypes where this Field is used, as a String

Parameters:

delim - the separator item

framework - the current framework

Returns:

list of LinkTypes separated by the delim characters

getAllLinkTypeIds

public java.util.Vector<java.lang.String> getAllLinkTypeIds(Framework framework)

Get the IDs of all LinkTypes where the Field is used [INTERNAL USAGE]

getProperty

public java.lang.String getProperty(java.lang.String propertyName,
                                    java.util.Vector<java.lang.Object> filterArgs,
                                    java.lang.String token,
                                    Framework framework)

Get a property for this Field object by its OOQL identifier

Specified by:

getProperty in class OBBase

Parameters:

propertyName - OOQL property identifier/name (example: type , default ...)

filterArgs - extra arguments used to compute properties

token - separator token for complex properties

framework - the current framework

Returns:

the property value

getTargetNames

public java.util.Vector<?> getTargetNames(java.lang.String composedName,
                                          java.util.Vector<java.lang.Object> filterArgs,
                                          Framework framework)

Return a Vector of administrative object names extracted by using an OOQL selector

Specified by:

getTargetNames in class OBBase

Parameters:

composedName - OOQL property identifier/name (example: class, program[edit.action] .. )

filterArgs - extra arguments used to compute properties

framework - the current framework

Returns:

a Vector of target names, used to extract their (sub)properties values

toString

public java.lang.String toString()

Return the Field object basic properties as a single String

Overrides:

toString in class AdminBase

toString

public java.lang.String toString(Framework framework)

Return the Field object extended properties as a single String

Overrides:

toString in class AdminBase

Parameters:

framework - the current framework

rangesToXML

public org.jdom.Element rangesToXML(java.lang.String rangeId,
                                    java.util.Vector<java.lang.Object> filterArgs,
                                    Framework framework)

Return the Field-Ranges as XML element tree

Parameters:

rangeId - the range number or "program" (-1: return all ranges)

filterArgs - extra arguments used to compute the Field ranges

framework - the current framework

toXML

public org.jdom.Element toXML(Framework framework)

Return the Field object properties as XML element tree

Specified by:

toXML in class AdminBase

Parameters:

framework - the current framework

toXML

public org.jdom.Element toXML(boolean getImage,
                              boolean fullDump,
                              Framework framework)

Return the Field object properties as XML element tree

Specified by:

toXML in class AdminBase

Parameters:

getImage - true to include "imagedata" element with the base64 encoded image data

fullDump - true to include detailed information

framework - the current framework

fromXML

public void fromXML(org.jdom.Element rootElement)

Load the Field object properties from XML element tree

Overrides:

fromXML in class AdminBase

getCreateCommand

public java.lang.String getCreateCommand(boolean force)

Return the OOQL command to create this Field object with the settled properties

Specified by:

getCreateCommand in class AdminBase

Parameters:

force - if true append the "force" options at the end

getSaveCommand

public java.lang.String getSaveCommand(boolean force)

Return the OOQL command to update this Field object with the modified properties.
If the object is new, it returns the create command.

Specified by:

getSaveCommand in class AdminBase

Parameters:

force - if true append the "force" options at the end

compareUpdate

public java.lang.String compareUpdate(Field refField,
                                      boolean checkImage,
                                      boolean overwrite,
                                      boolean force,
                                      Framework framework)
                               throws OberonException

Return/apply the OOQL command to update this Field object and let it become equals to another reference object.
This method is useful to import objects from an XML file.

Parameters:

refField - the reference Field object

checkImage - if true compare also the image icon

overwrite - if true update the database object instance

force - if true ignores optional properties

framework - the current framework

Throws:

OberonException

See Also:

fromXML(Element)