Package ch.ivyteam.ivy.system
Interface IPropertyBase
-
- All Known Subinterfaces:
ICustomProperty
,IProperty
,ISystemProperty
public interface IPropertyBase
Base interface for all properties- API:
- This is a public API.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
getBooleanValue()
Gets the property value asboolean
int
getIntValue()
Gets the property value asint
long
getLongValue()
Gets the property value aslong
String
getName()
Gets the property nameString
getValue()
Gets the property value asString
void
setValue(boolean value)
Sets the value of the propertyvoid
setValue(int value)
Sets the value of the propertyvoid
setValue(long value)
Sets the value of the propertyvoid
setValue(String value)
Sets the value of the property
-
-
-
Method Detail
-
getName
String getName()
Gets the property name- Returns:
- property name
- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
- Security:
- ApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyRead PERMISSION OR OWNS ApplicationCustomPropertyRead@SYSTEM PERMISSION
NewApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyRead PERMISSION OR OWNS ApplicationCustomPropertyRead@SYSTEM PERMISSION
-
getValue
String getValue()
Gets the property value asString
- Returns:
- property value.
- Throws:
PersistencyException
- if persistency access fails- See Also:
setValue(String)
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
- Security:
- ApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyRead PERMISSION OR OWNS ApplicationCustomPropertyRead@SYSTEM PERMISSION
NewApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyRead PERMISSION OR OWNS ApplicationCustomPropertyRead@SYSTEM PERMISSION
-
getIntValue
int getIntValue()
Gets the property value asint
- Returns:
- property value as int
- Throws:
PersistencyException
- if persistency access failsNumberFormatException
- if int value cannot be parsed- See Also:
setValue(int)
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
- Security:
- ApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyRead PERMISSION OR OWNS ApplicationCustomPropertyRead@SYSTEM PERMISSION
NewApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyRead PERMISSION OR OWNS ApplicationCustomPropertyRead@SYSTEM PERMISSION
-
getLongValue
long getLongValue()
Gets the property value aslong
- Returns:
- property value as long
- Throws:
PersistencyException
- if persistency access failsNumberFormatException
- if long value cannot be parsed- See Also:
setValue(long)
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
- Security:
- ApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyRead PERMISSION OR OWNS ApplicationCustomPropertyRead@SYSTEM PERMISSION
NewApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyRead PERMISSION OR OWNS ApplicationCustomPropertyRead@SYSTEM PERMISSION
-
getBooleanValue
boolean getBooleanValue()
Gets the property value asboolean
- Returns:
- property value as boolean
- Throws:
PersistencyException
- if persistency access fails- See Also:
setValue(boolean)
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
- Security:
- ApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyRead PERMISSION OR OWNS ApplicationCustomPropertyRead@SYSTEM PERMISSION
NewApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyRead PERMISSION OR OWNS ApplicationCustomPropertyRead@SYSTEM PERMISSION
-
setValue
void setValue(String value)
Sets the value of the property- Parameters:
value
- the new value- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
- Security:
- ApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyWrite PERMISSION OR OWNS ApplicationCustomPropertyWrite@SYSTEM PERMISSION
NewApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyWrite PERMISSION OR OWNS ApplicationCustomPropertyWrite@SYSTEM PERMISSION
-
setValue
void setValue(int value)
Sets the value of the property- Parameters:
value
- the new value- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
- Security:
- ApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyWrite PERMISSION OR OWNS ApplicationCustomPropertyWrite@SYSTEM PERMISSION
NewApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyWrite PERMISSION OR OWNS ApplicationCustomPropertyWrite@SYSTEM PERMISSION
-
setValue
void setValue(long value)
Sets the value of the property- Parameters:
value
- the new value- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
- Security:
- ApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyWrite PERMISSION OR OWNS ApplicationCustomPropertyWrite@SYSTEM PERMISSION
NewApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyWrite PERMISSION OR OWNS ApplicationCustomPropertyWrite@SYSTEM PERMISSION
-
setValue
void setValue(boolean value)
Sets the value of the property- Parameters:
value
- the new value- Throws:
PersistencyException
- if persistency access fails- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
- Security:
- ApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyWrite PERMISSION OR OWNS ApplicationCustomPropertyWrite@SYSTEM PERMISSION
NewApplicationCustomProperty: SESSION OWNS ApplicationCustomPropertyWrite PERMISSION OR OWNS ApplicationCustomPropertyWrite@SYSTEM PERMISSION
-
-