Package org.cyclos.entities.users

Class UserCustomField

java.lang.Object

org.cyclos.entities.SimpleEntity

org.cyclos.entities.NetworkedEntity

org.cyclos.entities.BaseEntity

org.cyclos.entities.NamedEntity

org.cyclos.entities.ConfigurationEntity

org.cyclos.entities.ConfigurationOrderableEntity

org.cyclos.entities.system.CustomField<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue>

org.cyclos.entities.users.UserCustomField

All Implemented Interfaces:

Cloneable, Comparable<NamedEntity>, HasNetwork, HasOrder, ProcessableForProxying, DefinesNetwork, IEntity, IInternalNamedEntity, INamedEntity, IUnqualifiedInternalNamedEntity, HasValueMatch, ICustomField, UsesScript, ProfileField

@Entity
public class UserCustomField
extends CustomField<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue>
implements DefinesNetwork, ProfileField

A custom field for users

Nested Class Summary

Nested classes/interfaces inherited from class org.cyclos.entities.SimpleEntity

SimpleEntity.EntityLoadNotifier

Field Summary

Fields inherited from interface org.cyclos.model.users.users.ProfileField

PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
UserCustomField()

Method Summary

Modifier and Type	Method	Description
int	compareTo(NamedEntity o)
DataTranslationType	getDataTranslationType()	If this entity allows data translation, should return the translation type
FieldVisibility	getDefaultVisibility()
CustomFieldNature	getNature()
Network	getNetwork()	Returns the network this entity belongs to
String	getOidcClaim()
List<UserCustomFieldPossibleValueCategory>	getPossibleValueCategories()
Class<UserCustomFieldPossibleValueCategory>	getPossibleValueCategoryClass()
Class<UserCustomFieldPossibleValue>	getPossibleValueClass()
List<UserCustomFieldPossibleValue>	getPossibleValues()
CustomFieldPrincipalType	getPrincipalType()
CustomScriptUsedInType	getScriptUsedInType()	Returns the type of script usage
UserSection	getSection()
boolean	isIncludeInExport()
boolean	isPurgeValues()
void	setDefaultVisibility(FieldVisibility defaultVisibility)
void	setIncludeInExport(boolean includeInExport)
void	setNetwork(Network network)
void	setOidcClaim(String oidcClaim)
void	setPurgeValues(boolean purgeValues)
void	setSection(UserSection section)

Methods inherited from class org.cyclos.entities.system.CustomField

getAllowedMimeTypes, getAllSelectedLabel, getControl, getDecimalDigits, getDecimalValueRange, getDefaultBooleanValue, getDefaultDateValue, getDefaultDecimalValue, getDefaultIntegerValue, getDefaultRichTextValue, getDefaultStringValue, getDefaultTextValue, getInformationText, getIntegerValueRange, getLengthConstraint, getLinkedEntityRecordType, getLinkedEntityType, getLoadValuesScript, getLoadValuesScriptParameters, getMaxFiles, getMaxWordSize, getOtherMimeTypes, getPattern, getShowQrCodeScan, getSize, getStorageDirectory, getType, getValidationScript, getValidationScriptParameters, getValueMatch, isAllowedAsSearchFilter, isDefaultDateToday, isExactMatch, isExpandedCategories, isIgnoreSanitizer, isRequired, isUnique, setAllowedMimeTypes, setAllSelectedLabel, setControl, setDecimalDigits, setDecimalValueRange, setDefaultBooleanValue, setDefaultDateToday, setDefaultDateValue, setDefaultDecimalValue, setDefaultIntegerValue, setDefaultRichTextValue, setDefaultStringValue, setDefaultTextValue, setExpandedCategories, setIgnoreSanitizer, setInformationText, setIntegerValueRange, setLengthConstraint, setLinkedEntityRecordType, setLinkedEntityType, setLoadValuesScript, setLoadValuesScriptParameters, setMaxFiles, setMaxWordSize, setOtherMimeTypes, setPattern, setRequired, setShowQrCodeScan, setSize, setStorageDirectory, setType, setUnique, setValidationScript, setValidationScriptParameters, setValueMatch

Methods inherited from class org.cyclos.entities.ConfigurationOrderableEntity

getOrder, setOrder, toString

Methods inherited from class org.cyclos.entities.ConfigurationEntity

getDescription, getInternalName, setDescription, setInternalName, toShortString

Methods inherited from class org.cyclos.entities.NamedEntity

getName, getNames, setName

Methods inherited from class org.cyclos.entities.BaseEntity

getVersion

Methods inherited from class org.cyclos.entities.NetworkedEntity

isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity

equals, getId, hashCode, id, ids, isPersistent, isTransient, register, setId, uniqueIds, uniqueIds

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.model.system.fields.HasValueMatch

getValueMatch

Methods inherited from interface org.cyclos.model.IEntity

getId, matches

Methods inherited from interface org.cyclos.model.IInternalNamedEntity

getInternalName, matches, setInternalName

Methods inherited from interface org.cyclos.model.INamedEntity

getName, setName

Methods inherited from interface org.cyclos.entities.ProcessableForProxying

getProxyClass

Methods inherited from interface org.cyclos.model.system.scripts.UsesScript

isEnabled

Constructor Detail

UserCustomField

public UserCustomField()

Method Detail

compareTo

public int compareTo(NamedEntity o)

Specified by:

compareTo in interface Comparable<NamedEntity>

Overrides:

compareTo in class ConfigurationOrderableEntity

getDataTranslationType

public DataTranslationType getDataTranslationType()

Description copied from class: BaseEntity

If this entity allows data translation, should return the translation type

Overrides:

getDataTranslationType in class BaseEntity

getDefaultVisibility

public FieldVisibility getDefaultVisibility()

getNature

public CustomFieldNature getNature()

Specified by:

getNature in class CustomField<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue>

getNetwork

public Network getNetwork()

Description copied from interface: HasNetwork

Returns the network this entity belongs to

Specified by:

getNetwork in interface HasNetwork

getOidcClaim

public String getOidcClaim()

getPossibleValueCategories

public List<UserCustomFieldPossibleValueCategory> getPossibleValueCategories()

Specified by:

getPossibleValueCategories in class CustomField<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue>

getPossibleValueCategoryClass

public Class<UserCustomFieldPossibleValueCategory> getPossibleValueCategoryClass()

Specified by:

getPossibleValueCategoryClass in class CustomField<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue>

getPossibleValueClass

public Class<UserCustomFieldPossibleValue> getPossibleValueClass()

Specified by:

getPossibleValueClass in class CustomField<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue>

getPossibleValues

public List<UserCustomFieldPossibleValue> getPossibleValues()

Specified by:

getPossibleValues in class CustomField<UserCustomField,UserCustomFieldPossibleValueCategory,UserCustomFieldPossibleValue>

getPrincipalType

public CustomFieldPrincipalType getPrincipalType()

getScriptUsedInType

public CustomScriptUsedInType getScriptUsedInType()

Description copied from interface: UsesScript

Returns the type of script usage

Specified by:

getScriptUsedInType in interface UsesScript

getSection

public UserSection getSection()

isIncludeInExport

public boolean isIncludeInExport()

isPurgeValues

public boolean isPurgeValues()

setDefaultVisibility

public void setDefaultVisibility(FieldVisibility defaultVisibility)

setIncludeInExport

public void setIncludeInExport(boolean includeInExport)

setNetwork

public void setNetwork(Network network)

Specified by:

setNetwork in interface DefinesNetwork

setOidcClaim

public void setOidcClaim(String oidcClaim)

setPurgeValues

public void setPurgeValues(boolean purgeValues)

setSection

public void setSection(UserSection section)