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.StringgetDefaultValue()EntityKindgetEntityKind()Return the kind of the assigned entity type.java.lang.StringgetEntityTypeCode()Return the code of the assigned entity type.java.lang.LonggetPositionInForms()Return the position at which the property will be rendered when editing/registering objects of the specified entity type.java.lang.StringgetPropertyTypeCode()Return the code of the assigned property type.java.lang.StringgetScriptName()Return the name of the script in case of a dynamic or managed propertyjava.lang.StringgetSection()Return the name of the form section.booleanisDynamic()Returntrueif the property is dynamicbooleanisManaged()Returntrueif the property is managedbooleanisMandatory()Returntrueif the property is mandatory for the assigned entity type.voidsetDefaultValue(java.lang.String defaultValue)Any already existing entity types will receive the specified default value.voidsetDynamic(boolean dynamic)Set totrueif the dynamic property is handled by a script.voidsetManaged(boolean managed)Set totrueif the managed property is handled by a script.voidsetMandatory(boolean mandatory)Set totrueif the property is mandatory for the assigned entity type.voidsetPositionInForms(java.lang.Long ordinal)Sets the position where the property will appear in forms.voidsetScriptName(java.lang.String scriptName)If handled by a script, the name is set here as a reference.voidsetSection(java.lang.String section)Set the name of the form section.voidsetShownEdit(boolean edit)Set totrueif the sript-handled property should be shown in the edit mode.booleanshownInEditViews()Returntrueif the property is shown in the edit views
-
-
-
Method Detail
-
isMandatory
public boolean isMandatory()
Description copied from interface:IPropertyAssignmentImmutableReturntrueif the property is mandatory for the assigned entity type.- Specified by:
isMandatoryin interfaceIPropertyAssignmentImmutable
-
setMandatory
public void setMandatory(boolean mandatory)
Description copied from interface:IPropertyAssignmentSet totrueif the property is mandatory for the assigned entity type.- Specified by:
setMandatoryin interfaceIPropertyAssignment
-
getDefaultValue
public java.lang.String getDefaultValue()
-
setDefaultValue
public void setDefaultValue(java.lang.String defaultValue)
Description copied from interface:IPropertyAssignmentAny already existing entity types will receive the specified default value.- Specified by:
setDefaultValuein interfaceIPropertyAssignment
-
getSection
public java.lang.String getSection()
Description copied from interface:IPropertyAssignmentImmutableReturn the name of the form section.- Specified by:
getSectionin interfaceIPropertyAssignmentImmutable
-
setSection
public void setSection(java.lang.String section)
Description copied from interface:IPropertyAssignmentSet 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:
setSectionin interfaceIPropertyAssignment
-
getPositionInForms
public java.lang.Long getPositionInForms()
Description copied from interface:IPropertyAssignmentImmutableReturn the position at which the property will be rendered when editing/registering objects of the specified entity type.- Specified by:
getPositionInFormsin interfaceIPropertyAssignmentImmutable
-
setPositionInForms
public void setPositionInForms(java.lang.Long ordinal)
Description copied from interface:IPropertyAssignmentSets 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:
setPositionInFormsin interfaceIPropertyAssignment
-
getEntityTypeCode
public java.lang.String getEntityTypeCode()
Description copied from interface:IPropertyAssignmentImmutableReturn the code of the assigned entity type.- Specified by:
getEntityTypeCodein interfaceIPropertyAssignmentImmutable
-
getPropertyTypeCode
public java.lang.String getPropertyTypeCode()
Description copied from interface:IPropertyAssignmentImmutableReturn the code of the assigned property type.- Specified by:
getPropertyTypeCodein interfaceIPropertyAssignmentImmutable
-
getEntityKind
public EntityKind getEntityKind()
Description copied from interface:IPropertyAssignmentImmutableReturn the kind of the assigned entity type.- Specified by:
getEntityKindin interfaceIPropertyAssignmentImmutable
-
shownInEditViews
public boolean shownInEditViews()
Description copied from interface:IPropertyAssignmentImmutableReturntrueif the property is shown in the edit views- Specified by:
shownInEditViewsin interfaceIPropertyAssignmentImmutable
-
getScriptName
public java.lang.String getScriptName()
Description copied from interface:IPropertyAssignmentImmutableReturn the name of the script in case of a dynamic or managed property- Specified by:
getScriptNamein interfaceIPropertyAssignmentImmutable
-
isDynamic
public boolean isDynamic()
Description copied from interface:IPropertyAssignmentImmutableReturntrueif the property is dynamic- Specified by:
isDynamicin interfaceIPropertyAssignmentImmutable
-
isManaged
public boolean isManaged()
Description copied from interface:IPropertyAssignmentImmutableReturntrueif the property is managed- Specified by:
isManagedin interfaceIPropertyAssignmentImmutable
-
setScriptName
public void setScriptName(java.lang.String scriptName)
Description copied from interface:IPropertyAssignmentIf handled by a script, the name is set here as a reference.- Specified by:
setScriptNamein interfaceIPropertyAssignment
-
setDynamic
public void setDynamic(boolean dynamic)
Description copied from interface:IPropertyAssignmentSet totrueif the dynamic property is handled by a script.- Specified by:
setDynamicin interfaceIPropertyAssignment
-
setManaged
public void setManaged(boolean managed)
Description copied from interface:IPropertyAssignmentSet totrueif the managed property is handled by a script.- Specified by:
setManagedin interfaceIPropertyAssignment
-
setShownEdit
public void setShownEdit(boolean edit)
Description copied from interface:IPropertyAssignmentSet totrueif the sript-handled property should be shown in the edit mode.- Specified by:
setShownEditin interfaceIPropertyAssignment
-
-