Mendix Runtime
Documentation for the Mendix Runtime Environment API
com.mendix.core.objectmanagement.member.MendixObjectReferenceSet Class Reference

Inherits MendixObjectMember< List< IMendixIdentifier > >.

List of all members.

Public Member Functions

 MendixObjectReferenceSet (String name, String referenceType, boolean isBoth)
final String getReferenceType (IContext context)
void setValue (IContext context, List< IMendixIdentifier > value)
void setInitialValue (List< IMendixIdentifier > ids)
void setBothAddedValue (IContext context, IMendixIdentifier valueInstance)
void setBothRemovedValue (IContext context, IMendixIdentifier valueInstance)
List< IMendixIdentifiergetValue (IContext context)
IMendixIdentifier getValue (IContext context, int index)
boolean contains (IContext context, IMendixIdentifier id)
boolean remove (IContext context, IMendixIdentifier id)
boolean isBoth (IContext context)
List< IMendixIdentifiergetValueFromString (String s)
void parseValueFromString (IContext context, String s)
String parseValueToString (IContext context)
void addValue (IContext context, IMendixIdentifier id)
List< IMendixIdentifiergetAddedIds (IContext context)
List< IMendixIdentifiergetRemovedIds (IContext context)
void clearAddedIds ()
void clearRemovedIds ()

Protected Member Functions

MendixObjectReferenceSet clone () throws CloneNotSupportedException

Detailed Description

Member representing a reference to a set of other objects
This member cannot be virtual.

TODO: monitor changes per id instead this member at whole.


Constructor & Destructor Documentation

com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.MendixObjectReferenceSet ( String  name,
String  referenceType,
boolean  isBoth 
)

Creates MendixObjectReferenceSet for given referenceType

Parameters:
namethe name of the reference set
referenceTypethe type of object this reference refers to
isBothboolean indicating whether the reference owner is of type both

Member Function Documentation

void com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.addValue ( IContext  context,
IMendixIdentifier  id 
)

Adds value to referenceSet

Parameters:
context
id
void com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.clearAddedIds ( )

clears added ids

void com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.clearRemovedIds ( )

clear removes ids

MendixObjectReferenceSet com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.clone ( ) throws CloneNotSupportedException [protected]
boolean com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.contains ( IContext  context,
IMendixIdentifier  id 
)

Check if the given IMendixIdentifier exists in this reference set

Parameters:
context
id
Returns:
returns true if the given IMendixIdentifier exists in this reference set, otherwise false
Exceptions:
CoreException
List<IMendixIdentifier> com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.getAddedIds ( IContext  context)
Parameters:
context
Returns:
the added ids
final String com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.getReferenceType ( IContext  context)
Returns:
the referenceType
List<IMendixIdentifier> com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.getRemovedIds ( IContext  context)
Parameters:
context
Returns:
the removed ids
List<IMendixIdentifier> com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.getValue ( IContext  context)
IMendixIdentifier com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.getValue ( IContext  context,
int  index 
)

Returns the identifier of the referenced object on the given index

Parameters:
context
index
Returns:
the identifier of the referenced object on the given index
Exceptions:
CoreException
List<IMendixIdentifier> com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.getValueFromString ( String  s)
Parameters:
sthe string
Returns:
a list of identifiers constructed from the string
boolean com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.isBoth ( IContext  context)
Parameters:
context
Returns:
whether the reference set owner is of type both
void com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.parseValueFromString ( IContext  context,
String  s 
)

Parse value of this ObjectMember from a String

Parameters:
context
sa string representing a JSONArray -> [123345,123345,345666]
String com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.parseValueToString ( IContext  context)
boolean com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.remove ( IContext  context,
IMendixIdentifier  id 
)

Removes the given IMendixIdentifier from this reference set

Parameters:
context
id
Returns:
returns true if removed successfully
Exceptions:
CoreException
void com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.setBothAddedValue ( IContext  context,
IMendixIdentifier  valueInstance 
)

Set value for both relation

Parameters:
context
valueInstance
void com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.setBothRemovedValue ( IContext  context,
IMendixIdentifier  valueInstance 
)

Set value for both relation

Parameters:
context
valueInstance
void com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.setInitialValue ( List< IMendixIdentifier ids)
void com.mendix.core.objectmanagement.member.MendixObjectReferenceSet.setValue ( IContext  context,
List< IMendixIdentifier value 
)

The documentation for this class was generated from the following file: