Package com.mendix.core.objectmanagement.member

Interface MendixObjectReferenceSet

All Superinterfaces:

IMendixObjectMember<List<IMendixIdentifier>>

public interface MendixObjectReferenceSet
extends IMendixObjectMember<List<IMendixIdentifier>>

Provides the interface for a Mendix association with type Reference Set.

Nested Class Summary

Nested classes/interfaces inherited from interface com.mendix.systemwideinterfaces.core.IMendixObjectMember

IMendixObjectMember.MemberState, IMendixObjectMember.MemberValueState

Method Summary

Modifier and Type	Method	Description
void	addValue(IContext context, IMendixIdentifier valueToAdd)	Adds valueToAdd to this reference set.
Boolean	contains(IMendixIdentifier id)	Returns whether this reference set contain an object reference.
Set<IMendixIdentifier>	getAddedIds()	Deprecated. since 9.7.0.
Set<IMendixIdentifier>	getRemovedIds()	Deprecated. since 9.7.0.
Set<IMendixIdentifier>	getValueFromStringSet(String stringValue)	Parses string to a set of object references.
Boolean	isBoth()	Returns whether this reference set is bidirectional.
IMetaAssociation	modelReference()	Returns the meta-object for this reference set.
String	referenceType()	Returns the type of the referenced objects.
void	removeValue(IContext context, IMendixIdentifier valueToRemove)	Removes valueToRemove from this reference set.
void	setValue(IContext context, Set<IMendixIdentifier> valueToSet, Boolean performValidation)	Sets the value of this reference set to valueToSet.
void	setValueFromDeserialization(IContext context, Set<IMendixIdentifier> ids)	Deprecated. since 9.7.0.

Methods inherited from interface com.mendix.systemwideinterfaces.core.IMendixObjectMember

getMemberValueState, getName, getOriginalValue, getState, getValue, getValueFromString, hasReadAccess, hasWriteAccess, isVirtual, parseValueFromString, parseValueToString, setValue, setValue, toString

Method Details

modelReference

IMetaAssociation modelReference()

Returns the meta-object for this reference set.

Returns:

the meta-object

referenceType

String referenceType()

Returns the type of the referenced objects.

Returns:

the reference type

addValue

void addValue(IContext context,
 IMendixIdentifier valueToAdd)

Adds valueToAdd to this reference set.

Parameters:

context - the context

valueToAdd - the object reference to add

removeValue

void removeValue(IContext context,
 IMendixIdentifier valueToRemove)

Removes valueToRemove from this reference set.

Parameters:

context - the context

valueToRemove - the object reference to remove

getAddedIds

@Deprecated
Set<IMendixIdentifier> getAddedIds()

Deprecated.

since 9.7.0. This method was exposed for an internal optimization which is implemented differently now. There is no replacement.

Returns the object references that were added to this reference set.

Returns:

the identifiers of the added objects

getRemovedIds

@Deprecated
Set<IMendixIdentifier> getRemovedIds()

Deprecated.

since 9.7.0. This method was exposed for an internal optimization which is implemented differently now. There is no replacement.

Returns the object references that were removed from this reference set.

Returns:

the identifiers of the removed objects

setValue

void setValue(IContext context,
 Set<IMendixIdentifier> valueToSet,
 Boolean performValidation)

Sets the value of this reference set to valueToSet.

Parameters:

context - the context

valueToSet - the value to set

performValidation - indicates whether to perform data validation

setValueFromDeserialization

@Deprecated
void setValueFromDeserialization(IContext context,
 Set<IMendixIdentifier> ids)

Deprecated.

since 9.7.0. This method was exposed for internal purposes. There is no replacement.

Sets the value of this reference set from a set of referenced identifiers.

Parameters:

context - the context

ids - the identifiers of the objects to set

isBoth

Boolean isBoth()

Returns whether this reference set is bidirectional.

Returns:

true if the set is bidirectional, false otherwise

contains

Boolean contains(IMendixIdentifier id)

Returns whether this reference set contain an object reference.

Parameters:

id - the identifier of the object to check

Returns:

true if the object is referenced, false otherwise

getValueFromStringSet

Set<IMendixIdentifier> getValueFromStringSet(String stringValue)

Parses string to a set of object references. The specified string should contain a comma-separated list of UUIDs.

Parameters:

stringValue - the string to parse

Returns:

the object identifiers