Interface ICustomProperty
-
- All Superinterfaces:
IPropertyBase
public interface ICustomProperty extends IPropertyBase
A property that can be used to store custom specific data. For storing custom specific settings or preferences that can be managed and changed by the user on the Admin UI you may want to useIGlobalVariable
.- See Also:
IGlobalVariable
- API:
- This is a public API.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
getBooleanValue(boolean defaultValue)
Returns the value as long.int
getIntValue(int defaultValue)
Returns the value as int.long
getLongValue(long defaultValue)
Returns the value as long.String
getValue(String defaultValue)
Returns the value asString
if this property has one, otherwise the givendefaultValue
.boolean
hasValue()
Returns true if the value of the property has ever been set before.-
Methods inherited from interface ch.ivyteam.ivy.system.IPropertyBase
getBooleanValue, getIntValue, getLongValue, getName, getValue, setValue, setValue, setValue, setValue
-
-
-
-
Method Detail
-
hasValue
boolean hasValue() throws PersistencyException
Returns true if the value of the property has ever been set before. To delete the value useICustomProperties.delete(String)
.- Returns:
- true if the value of this property has been set
- Throws:
PersistencyException
- if persistency access fails- See Also:
ICustomProperties.delete(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
-
getValue
String getValue(String defaultValue) throws PersistencyException
Returns the value asString
if this property has one, otherwise the givendefaultValue
.- Parameters:
defaultValue
-- Returns:
- the value if this property has one, otherwise the given
defaultValue
- Throws:
PersistencyException
- if persistency access fails- See Also:
IPropertyBase.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(int defaultValue) throws PersistencyException
Returns the value as int. If this property has no value or it is not a validint
the givendefaultValue
is returned.- Parameters:
defaultValue
-- Returns:
- the value as int. If there is no value or it is not a valid
int
the givendefaultValue
is returned - Throws:
PersistencyException
- if persistency access fails- See Also:
IPropertyBase.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(long defaultValue) throws PersistencyException
Returns the value as long. If this property has no value or it is not a validlong
the givendefaultValue
is returned- Parameters:
defaultValue
-- Returns:
- the value as long. If there is no value or it is not a valid
long
the givendefaultValue
is returned - Throws:
PersistencyException
- if persistency access fails- See Also:
IPropertyBase.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(boolean defaultValue) throws PersistencyException
Returns the value as long. If this property has no value or it is not a validlong
the givendefaultValue
is returned- Parameters:
defaultValue
-- Returns:
- the value as long. If there is no value or it is not a valid
long
the givendefaultValue
is returned - Throws:
PersistencyException
- if persistency access fails- See Also:
IPropertyBase.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
-
-