Package com.mendix.systemwideinterfaces.core

Interface IMendixObjectMember<T>

All Known Subinterfaces:

MendixAutoNumber, MendixBinary, MendixBoolean, MendixDateTime, MendixDecimal, MendixEnum, MendixHashString, MendixInteger, MendixLong, MendixObjectReference, MendixObjectReferenceSet, MendixString

public interface IMendixObjectMember<T>

Represents a Mendix object member (attribute or association).

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	IMendixObjectMember.MemberState	Defines the object member states.
static class	IMendixObjectMember.MemberValueState	Defines the object member's value states.

Method Summary

Modifier and Type	Method	Description
IMendixObjectMember.MemberValueState	getMemberValueState(IContext context)	Returns the object member's value state.
java.lang.String	getName()	Returns the name of the object member.
T	getOriginalValue(IContext context)	Returns the original value of this member.
IMendixObjectMember.MemberState	getState()	Returns the object member's changed state.
T	getValue(IContext context)	Returns the value of this object member.
T	getValueFromString(java.lang.String stringValue)	Parses and returns a value for this object member from a string.
boolean	hasReadAccess(IContext context)	Returns whether retrieving the value of this member is allowed or not.
boolean	hasWriteAccess(IContext context)	Returns whether changing the value of this member is allowed or not.
boolean	isVirtual()	Returns whether this object member is virtual.
void	parseValueFromString(IContext context, java.lang.String stringValue)	Parses the value for this object member from a string.
java.lang.String	parseValueToString(IContext context)	Returns a string representation of this object member's value.
void	setValue(IContext context, T value)	Sets the value of this object member.
void	setValue(IContext context, T value, boolean performDataValidation)	Deprecated. since 9.24.
java.lang.String	toString()	Returns a string representation of this object member.

Method Detail

getValue

T getValue(IContext context)

Returns the value of this object member.

Parameters:

context - the context

Returns:

the value

setValue

void setValue(IContext context,
              T value)

Sets the value of this object member.

Parameters:

context - the context

value - the value to set

setValue

@Deprecated
void setValue(IContext context,
              T value,
              boolean performDataValidation)

Deprecated.

since 9.24. Use setValue instead as this is for internal use.

Sets the value this object member.

Parameters:

context - the context

value - the value to set

performDataValidation - indicates whether to perform data validation

parseValueToString

java.lang.String parseValueToString(IContext context)

Returns a string representation of this object member's value.

Parameters:

context - the context

Returns:

the string representation

getValueFromString

T getValueFromString(java.lang.String stringValue)

Parses and returns a value for this object member from a string.

Parameters:

stringValue - the string to parse

Returns:

the parsed value

parseValueFromString

void parseValueFromString(IContext context,
                          java.lang.String stringValue)

Parses the value for this object member from a string.

Parameters:

context - the context

stringValue - the string to parse

toString

java.lang.String toString()

Returns a string representation of this object member.

Overrides:

toString in class java.lang.Object

Returns:

the string representation

isVirtual

boolean isVirtual()

Returns whether this object member is virtual.

Returns:

true if the member is virtual, false otherwise

getOriginalValue

T getOriginalValue(IContext context)

Returns the original value of this member. This is the value it had before any (uncommitted) changes were made.

Parameters:

context - the context

Returns:

the original value

getState

IMendixObjectMember.MemberState getState()

Returns the object member's changed state.

Returns:

CHANGED if the member was changed, UNCHANGED otherwise

getMemberValueState

IMendixObjectMember.MemberValueState getMemberValueState(IContext context)

Returns the object member's value state.

Parameters:

context - the context object for checking permissions

Returns:

SET if the member has a value, NOT_SET if empty

getName

java.lang.String getName()

Returns the name of the object member.

Returns:

the name

hasReadAccess

boolean hasReadAccess(IContext context)

Returns whether retrieving the value of this member is allowed or not.

Parameters:

context - the context object for checking permissions

Returns:

true if reading is allowed, false otherwise

hasWriteAccess

boolean hasWriteAccess(IContext context)

Returns whether changing the value of this member is allowed or not.

Parameters:

context - the context object for checking permissions

Returns:

true if writing is allowed, false otherwise