Class PropertyAssignment
- java.lang.Object
-
- ch.systemsx.cisd.openbis.generic.server.jython.api.v1.impl.PropertyAssignment
-
- All Implemented Interfaces:
IPropertyAssignment
,IPropertyAssignmentImmutable
public class PropertyAssignment extends java.lang.Object implements IPropertyAssignment
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getDefaultValue()
EntityKind
getEntityKind()
Return the kind of the assigned entity type.java.lang.String
getEntityTypeCode()
Return the code of the assigned entity type.java.lang.Long
getPositionInForms()
Return the position at which the property will be rendered when editing/registering objects of the specified entity type.java.lang.String
getPropertyTypeCode()
Return the code of the assigned property type.java.lang.String
getScriptName()
Return the name of the script in case of a dynamic or managed propertyjava.lang.String
getSection()
Return the name of the form section.boolean
isDynamic()
Returntrue
if the property is dynamicboolean
isManaged()
Returntrue
if the property is managedboolean
isMandatory()
Returntrue
if the property is mandatory for the assigned entity type.void
setDefaultValue(java.lang.String defaultValue)
Any already existing entity types will receive the specified default value.void
setDynamic(boolean dynamic)
Set totrue
if the dynamic property is handled by a script.void
setManaged(boolean managed)
Set totrue
if the managed property is handled by a script.void
setMandatory(boolean mandatory)
Set totrue
if the property is mandatory for the assigned entity type.void
setPositionInForms(java.lang.Long ordinal)
Sets the position where the property will appear in forms.void
setScriptName(java.lang.String scriptName)
If handled by a script, the name is set here as a reference.void
setSection(java.lang.String section)
Set the name of the form section.void
setShownEdit(boolean edit)
Set totrue
if the sript-handled property should be shown in the edit mode.boolean
shownInEditViews()
Returntrue
if the property is shown in the edit views
-
-
-
Method Detail
-
isMandatory
public boolean isMandatory()
Description copied from interface:IPropertyAssignmentImmutable
Returntrue
if the property is mandatory for the assigned entity type.- Specified by:
isMandatory
in interfaceIPropertyAssignmentImmutable
-
setMandatory
public void setMandatory(boolean mandatory)
Description copied from interface:IPropertyAssignment
Set totrue
if the property is mandatory for the assigned entity type.- Specified by:
setMandatory
in interfaceIPropertyAssignment
-
getDefaultValue
public java.lang.String getDefaultValue()
-
setDefaultValue
public void setDefaultValue(java.lang.String defaultValue)
Description copied from interface:IPropertyAssignment
Any already existing entity types will receive the specified default value.- Specified by:
setDefaultValue
in interfaceIPropertyAssignment
-
getSection
public java.lang.String getSection()
Description copied from interface:IPropertyAssignmentImmutable
Return the name of the form section.- Specified by:
getSection
in interfaceIPropertyAssignmentImmutable
-
setSection
public void setSection(java.lang.String section)
Description copied from interface:IPropertyAssignment
Set the name of the form section. It will appear when editing objects of the specified entity in openBIS. Specifying a section name is optional.- Specified by:
setSection
in interfaceIPropertyAssignment
-
getPositionInForms
public java.lang.Long getPositionInForms()
Description copied from interface:IPropertyAssignmentImmutable
Return the position at which the property will be rendered when editing/registering objects of the specified entity type.- Specified by:
getPositionInForms
in interfaceIPropertyAssignmentImmutable
-
setPositionInForms
public void setPositionInForms(java.lang.Long ordinal)
Description copied from interface:IPropertyAssignment
Sets the position where the property will appear in forms. If not specified the property will be displayed at the bottom of the form.- Specified by:
setPositionInForms
in interfaceIPropertyAssignment
-
getEntityTypeCode
public java.lang.String getEntityTypeCode()
Description copied from interface:IPropertyAssignmentImmutable
Return the code of the assigned entity type.- Specified by:
getEntityTypeCode
in interfaceIPropertyAssignmentImmutable
-
getPropertyTypeCode
public java.lang.String getPropertyTypeCode()
Description copied from interface:IPropertyAssignmentImmutable
Return the code of the assigned property type.- Specified by:
getPropertyTypeCode
in interfaceIPropertyAssignmentImmutable
-
getEntityKind
public EntityKind getEntityKind()
Description copied from interface:IPropertyAssignmentImmutable
Return the kind of the assigned entity type.- Specified by:
getEntityKind
in interfaceIPropertyAssignmentImmutable
-
shownInEditViews
public boolean shownInEditViews()
Description copied from interface:IPropertyAssignmentImmutable
Returntrue
if the property is shown in the edit views- Specified by:
shownInEditViews
in interfaceIPropertyAssignmentImmutable
-
getScriptName
public java.lang.String getScriptName()
Description copied from interface:IPropertyAssignmentImmutable
Return the name of the script in case of a dynamic or managed property- Specified by:
getScriptName
in interfaceIPropertyAssignmentImmutable
-
isDynamic
public boolean isDynamic()
Description copied from interface:IPropertyAssignmentImmutable
Returntrue
if the property is dynamic- Specified by:
isDynamic
in interfaceIPropertyAssignmentImmutable
-
isManaged
public boolean isManaged()
Description copied from interface:IPropertyAssignmentImmutable
Returntrue
if the property is managed- Specified by:
isManaged
in interfaceIPropertyAssignmentImmutable
-
setScriptName
public void setScriptName(java.lang.String scriptName)
Description copied from interface:IPropertyAssignment
If handled by a script, the name is set here as a reference.- Specified by:
setScriptName
in interfaceIPropertyAssignment
-
setDynamic
public void setDynamic(boolean dynamic)
Description copied from interface:IPropertyAssignment
Set totrue
if the dynamic property is handled by a script.- Specified by:
setDynamic
in interfaceIPropertyAssignment
-
setManaged
public void setManaged(boolean managed)
Description copied from interface:IPropertyAssignment
Set totrue
if the managed property is handled by a script.- Specified by:
setManaged
in interfaceIPropertyAssignment
-
setShownEdit
public void setShownEdit(boolean edit)
Description copied from interface:IPropertyAssignment
Set totrue
if the sript-handled property should be shown in the edit mode.- Specified by:
setShownEdit
in interfaceIPropertyAssignment
-
-