Sepasoft MES Module Suite
Machine Recipe Value Security Info
This object contains the list of security roles for a recipe value.
Creation
The following scripting functions can be used to create this type of object:
Properties
addSecurityRole(securityRole, allowEdit, minValue, maxValue)
Description
This script function will add a new recipe value security role to the recipe item.
Syntax
addSecurityRole(securityRole, allowEdit, minValue, maxValue)
- Parameters
String securityRole - The security role to be added.
boolean allowEdit - Set it to True if editing should be allowed and False otherwise.
Object minValue - The minimum value of the range.
Object maxValue - The maximum value of the range.
- Returns
Nothing
checkWithinRange(value, min, max)
Description
Checks if the given value is within the minimum and maximum value.
Syntax
checkWithinRange(value, min, max)
- Parameters
Object value - The value to be checked for.
Object min - The minimum value of the range.
Object max - The maximum value of the range.
- Returns
boolean True if the value is between minimum and maximum value and False otherwise.
convertValue(value)
Description
Converts the value of the recipe item to the new value.
Syntax
convertValue(value)
- Parameters
String value - The value to set the recipe for.
- Returns
Object itemRecipeValue - The recipe item with the new value.
getAssignedBy()
Description
Returns the description of where this recipe value was assigned by.
Syntax
getAssignedBy()
- Parameters
None
- Returns
Description corresponding to the recipe value.
getItemPath()
Description
Returns the item path of the recipe value.
Syntax
getItemPath()
- Parameters
None
- Returns
The item path to a production line, cell, cell group or location corresponding to the recipe value.
getItemRecipeValue()
Description
Returns a ItemRecipeValue object.
Syntax
getItemRecipeValue()
- Parameters
None
- Returns
The Item recipe value object.
getMin(value1, value2)
Description
Get the object containing the minimum value.
Syntax
getMin(value1, value2)
- Parameters
Object value1 - The first object with value 1.
Object value2 - The second object with value 2.
- Returns
The object with minimum value.
getMax(value1, value2)
Description
Get the object containing the maximum value.
Syntax
getMax(value1, value2)
- Parameters
Object value1 - The first object with value 1.
Object value2 - The second object with value 2.
- Returns
The object with maximum value.
getSecurityRole(roleName)
Description
Returns a RecipeValueSecurityRole object.
Syntax
getSecurityRole(roleName)
- Parameters
String roleName - Role to be assigned to the security object.
- Returns
The RecipeValueSecurityRole object.
isInherit()
Description
Checks if the recipe value is inherited or not.
Syntax
isInherit()
- Parameters
None
- Returns
boolean True, if the recipe value is inherited and False otherwise.
removeSecurityRole(roleName)
Description
Removes the security role with the given role name.
Syntax
removeSecurityRole(roleName)
- Parameters
String roleName - The role name for the security role to be removed for.
- Returns
Nothing
setAssignedBy(assignedBy)
Description
Sets the assignedBy property to the recipe item.
Syntax
setAssignedBy(assignedBy)
- Parameters
String assignedBy - The assignedBy property value for the recipe item.
- Returns
Nothing
setInherit(inherit)
Description
Sets the inherit property for the recipe item.
Syntax
setInherit(inherit)
- Parameters
boolean inherit - Set to True if the recipe item should inherit the security from the parent and False otherwise.
- Returns
Nothing
validateValue(value)
Sepasoft MES Module Suite