CustomFieldValue (Cyclos 4.6 Scripting API Documentation)

java.lang.Object
- org.cyclos.entities.SimpleEntity
- - org.cyclos.entities.BaseEntity
  - - org.cyclos.entities.system.CustomFieldValue<CF,C,PV,O>

All Implemented Interfaces:

java.lang.Cloneable, HasEntityImportance, ProcessableForDataTranslation, IEntity, ICustomFieldValue, ICustomFieldValueWithSet<PV,C>

Direct Known Subclasses:

AdCustomFieldValue, RecordCustomFieldValue, TransactionCustomFieldValue, UserCustomFieldValue
```
@MappedSuperclass
public abstract class CustomFieldValue<CF extends CustomField<CF,C,PV>,C extends CustomFieldPossibleValueCategory<CF,C,PV>,PV extends CustomFieldPossibleValue<CF,C,PV>,O extends BaseEntity>
extends BaseEntity
implements ICustomFieldValueWithSet<PV,C>
```
Base class to be used as custom field value

Author:

luis

Constructor Summary

Constructors
Constructor and Description

CustomFieldValue()

Constructors
Constructor and Description
`CustomFieldValue()`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.Boolean`	`getBooleanValue()`
`abstract java.lang.Class<CF>`	`getCustomFieldClass()`
`IDate`	`getDateValue()`
`java.math.BigDecimal`	`getDecimalValue()`
`abstract java.util.Set<PV>`	`getEnumeratedValues()`
`abstract CF`	`getField()`
`java.lang.Integer`	`getIntegerValue()`
`java.lang.Long`	`getLinkedEntityId()`
`LinkedEntityVO`	`getLinkedEntityValue()`
`Network`	`getNetwork()`
`abstract O`	`getOwner()`
`abstract java.lang.Class<PV>`	`getPossibleValueClass()`
`java.lang.String`	`getRichTextValue()`
`java.lang.String`	`getStringValue()`
`java.lang.String`	`getTextValue()`
`java.lang.Object`	`getValue()`
`void`	`setBooleanValue(java.lang.Boolean booleanValue)`
`void`	`setDateValue(IDate dateValue)`
`void`	`setDecimalValue(java.math.BigDecimal decimalValue)`
`abstract void`	`setEnumeratedValues(java.util.Set<PV> enumeratedValues)`
`abstract void`	`setField(CF field)`
`void`	`setIntegerValue(java.lang.Integer integerValue)`
`void`	`setLinkedEntityId(java.lang.Long linkedEntityId)`
`void`	`setLinkedEntityValue(LinkedEntityVO value)`
`abstract void`	`setOwner(O owner)`
`void`	`setRichTextValue(java.lang.String richTextValue)`
`void`	`setStringValue(java.lang.String stringValue)`
`void`	`setTextValue(java.lang.String textValue)`
`void`	`setValue(java.lang.Object value)`

Methods inherited from class org.cyclos.entities.BaseEntity
getDataTranslationType, getLogType, getVersion, isGlobal, isPersistent, isTransient

Methods inherited from class org.cyclos.entities.SimpleEntity
clone, equals, getEntityImportance, getId, getId, getIds, getUniqueIds, getUniqueIds, hashCode, toString

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cyclos.model.IEntity
getId

- Constructor Detail
  - CustomFieldValue
```
public CustomFieldValue()
```
- Method Detail
  - getBooleanValue
```
public java.lang.Boolean getBooleanValue()
```
    Specified by:
    
    getBooleanValue in interface ICustomFieldValue
  - getCustomFieldClass
```
public abstract java.lang.Class<CF> getCustomFieldClass()
```
  - getDateValue
```
public IDate getDateValue()
```
    Specified by:
    
    getDateValue in interface ICustomFieldValue
  - getDecimalValue
```
public java.math.BigDecimal getDecimalValue()
```
    Specified by:
    
    getDecimalValue in interface ICustomFieldValue
  - getEnumeratedValues
```
public abstract java.util.Set<PV> getEnumeratedValues()
```
    Specified by:
    
    getEnumeratedValues in interface ICustomFieldValueWithSet<PV extends CustomFieldPossibleValue<CF,C,PV>,C extends CustomFieldPossibleValueCategory<CF,C,PV>>
  - getField
```
public abstract CF getField()
```
    Specified by:
    
    getField in interface ICustomFieldValue
  - getIntegerValue
```
public java.lang.Integer getIntegerValue()
```
    Specified by:
    
    getIntegerValue in interface ICustomFieldValue
  - getLinkedEntityId
```
public java.lang.Long getLinkedEntityId()
```
  - getLinkedEntityValue
```
public LinkedEntityVO getLinkedEntityValue()
```
    Specified by:
    
    getLinkedEntityValue in interface ICustomFieldValue
  - getNetwork
```
public Network getNetwork()
```
    Specified by:
    
    getNetwork in class BaseEntity
    
    Returns:
    
    the network this entity belongs to
  - getOwner
```
public abstract O getOwner()
```
  - getPossibleValueClass
```
public abstract java.lang.Class<PV> getPossibleValueClass()
```
  - getRichTextValue
```
public java.lang.String getRichTextValue()
```
    Specified by:
    
    getRichTextValue in interface ICustomFieldValue
  - getStringValue
```
public java.lang.String getStringValue()
```
    Specified by:
    
    getStringValue in interface ICustomFieldValue
  - getTextValue
```
public java.lang.String getTextValue()
```
    Specified by:
    
    getTextValue in interface ICustomFieldValue
  - getValue
```
public java.lang.Object getValue()
```
  - setBooleanValue
```
public void setBooleanValue(java.lang.Boolean booleanValue)
```
    Specified by:
    
    setBooleanValue in interface ICustomFieldValue
  - setDateValue
```
public void setDateValue(IDate dateValue)
```
    Specified by:
    
    setDateValue in interface ICustomFieldValue
  - setDecimalValue
```
public void setDecimalValue(java.math.BigDecimal decimalValue)
```
    Specified by:
    
    setDecimalValue in interface ICustomFieldValue
  - setEnumeratedValues
```
public abstract void setEnumeratedValues(java.util.Set<PV> enumeratedValues)
```
    Specified by:
    
    setEnumeratedValues in interface ICustomFieldValueWithSet<PV extends CustomFieldPossibleValue<CF,C,PV>,C extends CustomFieldPossibleValueCategory<CF,C,PV>>
  - setField
```
public abstract void setField(CF field)
```
  - setIntegerValue
```
public void setIntegerValue(java.lang.Integer integerValue)
```
    Specified by:
    
    setIntegerValue in interface ICustomFieldValue
  - setLinkedEntityId
```
public void setLinkedEntityId(java.lang.Long linkedEntityId)
```
  - setLinkedEntityValue
```
public void setLinkedEntityValue(LinkedEntityVO value)
```
    Specified by:
    
    setLinkedEntityValue in interface ICustomFieldValue
  - setOwner
```
public abstract void setOwner(O owner)
```
  - setRichTextValue
```
public void setRichTextValue(java.lang.String richTextValue)
```
    Specified by:
    
    setRichTextValue in interface ICustomFieldValue
  - setStringValue
```
public void setStringValue(java.lang.String stringValue)
```
    Specified by:
    
    setStringValue in interface ICustomFieldValue
  - setTextValue
```
public void setTextValue(java.lang.String textValue)
```
    Specified by:
    
    setTextValue in interface ICustomFieldValue
  - setValue
```
public void setValue(java.lang.Object value)
```

Class CustomFieldValue<CF extends CustomField<CF,C,PV>,C extends CustomFieldPossibleValueCategory<CF,C,PV>,PV extends CustomFieldPossibleValue<CF,C,PV>,O extends BaseEntity>

Constructor Summary

Method Summary

Methods inherited from class org.cyclos.entities.BaseEntity

Methods inherited from class org.cyclos.entities.SimpleEntity

Methods inherited from class java.lang.Object

Methods inherited from interface org.cyclos.model.IEntity

Constructor Detail

CustomFieldValue

Method Detail

getBooleanValue

getCustomFieldClass

getDateValue

getDecimalValue

getEnumeratedValues

getField

getIntegerValue

getLinkedEntityId

getLinkedEntityValue

getNetwork

getOwner

getPossibleValueClass

getRichTextValue

getStringValue

getTextValue

getValue

setBooleanValue

setDateValue

setDecimalValue

setEnumeratedValues

setField

setIntegerValue

setLinkedEntityId

setLinkedEntityValue

setOwner

setRichTextValue

setStringValue

setTextValue

setValue