Skip navigation links

oracle.imaging
Class Application.FieldDefinition

java.lang.Object
oracle.imaging.BaseId
oracle.imaging.Application.FieldDefinition

Enclosing class:

Application

public static class Application.FieldDefinition

extends BaseId

A data struture specifying the definition of a single meta data field column in an imaging application. An array of these strutures is used when filling in the FieldDefinition section of the Application data structure. This section is used during the ApplicationService.addApplication operation to initially create the primary application index and in the ApplicationService.updateApplication operation to make changes to the primary application index.

Field Summary

protected long	id
protected java.lang.String	name

Fields inherited from class oracle.imaging.BaseId

ID_COMPARATOR, NAME_COMPARATOR

Constructor Summary

Application.FieldDefinition()

Application.FieldDefinition(java.lang.String name, FieldType type)

Method Summary

java.lang.Object	getDefaultValue() Gets the DefaultValue property for the ApplicationFieldDefinition The class type of the object returned must be determined by the setting of the ApplicationFieldDefinition type property.
long	getId() Returns the Id property value.
int	getLength() Gets the Length property The length property applies only to text fields.
java.lang.String	getName() Returns the Name property value.
PickList	getPickList() Gets the FieldDefinition Picklist Picklist.Pair items can be added or removed from the list.
int	getScale() Gets the scale property For the Decimal field type, the scale specifies the number of decimal places to the right of the decimal point.
FieldType	getType() Gets the Type property.
boolean	isIndexed() Gets the Indexed property If true, the field will be available for use in search for documents in the application.
boolean	isRequired() Gets the Required property If true, a valid value must be supplied for the field when a document is indexed into the applicaiton.
protected void	postLoad()
protected void	prePersist()
void	setDefaultValue(java.lang.Object defaultValue) Sets the default value for the FieldDefinitions The class type of the value must be consistent with the ApplicationFieldDefinition type property.
void	setId(long id) Sets the Id property value.
void	setIndexed(boolean indexed) Sets the Indexed property If true, the field will be available for use in search for documents in the application.
void	setLength(int length) Sets the Length property The length property applies only to text fields.
void	setName(java.lang.String name) Sets the Name property value.
void	setRequired(boolean required) Sets the Required property If true, a valid value must be supplied for the field when a document is indexed into the applicaiton.
void	setScale(int scale) Sets the scale property For the Decimal field type, the scale specifies the number of decimal places to the right of the decimal point.
void	setType(FieldType type) Sets the Type property The field definition type property can be set when the field is first created and added to an application definitions.
java.lang.String	toString()

Methods inherited from class oracle.imaging.BaseId

equals, hashCode, nameTrimOrNull, toNameId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

protected long id

name

protected java.lang.String name

Constructor Detail

Application.FieldDefinition

public Application.FieldDefinition()

Application.FieldDefinition

public Application.FieldDefinition(java.lang.String name,
                                   FieldType type)

Method Detail

setId

public void setId(long id)

Sets the Id property value.

Specified by:

setId in class BaseId

Parameters:

id - The new Id property value.

getId

public long getId()

Returns the Id property value.

Specified by:

getId in class BaseId

Returns:

The Id property value.

setName

public void setName(java.lang.String name)

Sets the Name property value. The maximum length of this property is determined by the ImagingConstants.NAME_LENGTH constant.

Specified by:

setName in class BaseId

Parameters:

name - The new Name property value.

getName

public java.lang.String getName()

Returns the Name property value.

Specified by:

getName in class BaseId

Returns:

The Name Property value.

setType

public void setType(FieldType type)

Sets the Type property The field definition type property can be set when the field is first created and added to an application definitions. Any changes to this property for an existing field definition will be ignored.

Parameters:

type - The new ApplicationFieldDefinition Type property value.

getType

public FieldType getType()

Gets the Type property.

Returns:

The ApplicationFieldDefinition Type property value.

setDefaultValue

public void setDefaultValue(java.lang.Object defaultValue)

Sets the default value for the FieldDefinitions The class type of the value must be consistent with the ApplicationFieldDefinition type property.

Parameters:

defaultValue - The new ApplicationFieldDefinition DefaultValue property value.

getDefaultValue

public java.lang.Object getDefaultValue()

Gets the DefaultValue property for the ApplicationFieldDefinition The class type of the object returned must be determined by the setting of the ApplicationFieldDefinition type property.

Returns:

The ApplicationFieldDefinition DefaultValue property value.

setRequired

public void setRequired(boolean required)

Sets the Required property If true, a valid value must be supplied for the field when a document is indexed into the applicaiton. If false, the field value may be left blank when indexing a document into the application. If a field is left blank, the DefaultValue for the field will be used.

Parameters:

required - The new ApplicationFieldDefinition Required property value.

isRequired

public boolean isRequired()

Gets the Required property If true, a valid value must be supplied for the field when a document is indexed into the applicaiton. If false, the field value may be left blank when indexing a document into the application. If a field is left blank, the DefaultValue for the field will be used.

Returns:

The ApplicationFieldDefinition Required property value.

setIndexed

public void setIndexed(boolean indexed)

Sets the Indexed property If true, the field will be available for use in search for documents in the application. If false, the field will not be available for use in search for documents in the application.

Parameters:

indexed - The new ApplicationFieldDefinition Indexed property value.

isIndexed

public boolean isIndexed()

Gets the Indexed property If true, the field will be available for use in search for documents in the application. If false, the field will not be available for use in search for documents in the application.

Returns:

The ApplicationFieldDefinition Indexed property value.

setLength

public void setLength(int length)

Sets the Length property The length property applies only to text fields. It specifies the maximum number of characters that can be entered into the field.

Parameters:

length - The new ApplicationFieldDefinition Length property value.

getLength

public int getLength()

Gets the Length property The length property applies only to text fields. It specifies the maximum number of characters that can be entered into the field.

Returns:

The ApplicationFieldDefinition Length property value.

setScale

public void setScale(int scale)

Sets the scale property For the Decimal field type, the scale specifies the number of decimal places to the right of the decimal point.

Parameters:

scale - The new ApplicationFieldDefinition scale property value.

getScale

public int getScale()

Gets the scale property For the Decimal field type, the scale specifies the number of decimal places to the right of the decimal point.

Returns:

The ApplicationFieldDefinition scale property value.

getPickList

public PickList getPickList()

Gets the FieldDefinition Picklist Picklist.Pair items can be added or removed from the list.

Returns:

the FieldDefinition PickList property value;

toString

public java.lang.String toString()

Overrides:

toString in class BaseId

postLoad

protected void postLoad()

prePersist

protected void prePersist()

Skip navigation links