|
Oracle® Fusion Middleware Oracle Imaging and Process Management Java API Reference 11g Release 1 (11.1.1) E12853-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.imaging.BaseId
oracle.imaging.Application.FieldDefinition
public static class Application.FieldDefinition
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 |
---|
protected long id
protected java.lang.String name
Constructor Detail |
---|
public Application.FieldDefinition()
public Application.FieldDefinition(java.lang.String name, FieldType type)
Method Detail |
---|
public void setId(long id)
setId
in class BaseId
id
- The new Id property value.public long getId()
getId
in class BaseId
public void setName(java.lang.String name)
ImagingConstants.NAME_LENGTH
constant.setName
in class BaseId
name
- The new Name property value.public java.lang.String getName()
getName
in class BaseId
public void setType(FieldType type)
type
- The new ApplicationFieldDefinition Type property value.public FieldType getType()
public void setDefaultValue(java.lang.Object defaultValue)
defaultValue
- The new ApplicationFieldDefinition DefaultValue property value.public java.lang.Object getDefaultValue()
public void setRequired(boolean required)
required
- The new ApplicationFieldDefinition Required property value.public boolean isRequired()
public void setIndexed(boolean indexed)
indexed
- The new ApplicationFieldDefinition Indexed property value.public boolean isIndexed()
public void setLength(int length)
length
- The new ApplicationFieldDefinition Length property value.public int getLength()
public void setScale(int scale)
scale
- The new ApplicationFieldDefinition scale property value.public int getScale()
public PickList getPickList()
public java.lang.String toString()
toString
in class BaseId
protected void postLoad()
protected void prePersist()
|
Oracle® Fusion Middleware Oracle Imaging and Process Management Java API Reference 11g Release 1 (11.1.1) E12853-02 |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |