systems.dmx.core

Interface DMXObject

Show UML class diagram

All Superinterfaces:

Identifiable, JSONEnabled

All Known Subinterfaces:

Association, AssociationDefinition, AssociationType, DMXType, RelatedAssociation, RelatedObject, RelatedTopic, Topic, TopicType

All Known Implementing Classes:

AssociationDefinitionImpl, AssociationImpl, AssociationTypeImpl, DMXObjectImpl, DMXTypeImpl, RelatedAssociationImpl, RelatedTopicImpl, TopicImpl, TopicTypeImpl

public interface DMXObject
extends Identifiable, JSONEnabled

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes the DMX object in its entirety, that is - the object itself (the parent) - all child topics associated via "dmx.core.composition", recusively - all the remaining direct associations, e.g.
Association	getAssociation(String assocTypeUri, String myRoleTypeUri, String othersRoleTypeUri, long othersTopicId)
List<Association>	getAssociations() Fetches all associations this object is a player in.
ChildTopics	getChildTopics()
Object	getDatabaseVendorObject()
long	getId()
DMXObjectModel	getModel()
Object	getProperty(String propUri) Returns this object's property value associated with the given property URI.
RelatedAssociation	getRelatedAssociation(String assocTypeUri, String myRoleTypeUri, String othersRoleTypeUri, String othersAssocTypeUri)
List<RelatedAssociation>	getRelatedAssociations(String assocTypeUri, String myRoleTypeUri, String othersRoleTypeUri, String othersAssocTypeUri)
RelatedTopic	getRelatedTopic(String assocTypeUri, String myRoleTypeUri, String othersRoleTypeUri, String othersTopicTypeUri) Fetches and returns a related topic or null if no such topic extists.
List<RelatedTopic>	getRelatedTopics(List assocTypeUris, String myRoleTypeUri, String othersRoleTypeUri, String othersTopicTypeUri)
List<RelatedTopic>	getRelatedTopics(String assocTypeUri)
List<RelatedTopic>	getRelatedTopics(String assocTypeUri, String myRoleTypeUri, String othersRoleTypeUri, String othersTopicTypeUri)
SimpleValue	getSimpleValue()
DMXType	getType() Returns the type of this object.
String	getTypeUri()
String	getUri()
boolean	hasProperty(String propUri) Checks whether for this object a property value is associated with a given property URI.
DMXObject	loadChildTopics()
DMXObject	loadChildTopics(String assocDefUri)
void	removeProperty(String propUri) Removes this object's property associated with the given property URI.
void	setChildTopics(ChildTopicsModel childTopics)
void	setProperty(String propUri, Object propValue, boolean addToIndex)
void	setSimpleValue(boolean value)
void	setSimpleValue(int value)
void	setSimpleValue(long value)
void	setSimpleValue(SimpleValue value)
void	setSimpleValue(String value)
void	setTypeUri(String typeUri)
void	setUri(String uri)
void	updateChildTopics(ChildTopicsModel updateModel, AssociationDefinition assocDef)

Methods inherited from interface systems.dmx.core.JSONEnabled

toJSON

Method Detail

getId

long getId()

Specified by:

getId in interface Identifiable

getUri

String getUri()

setUri

void setUri(String uri)

getTypeUri

String getTypeUri()

setTypeUri

void setTypeUri(String typeUri)

getSimpleValue

SimpleValue getSimpleValue()

setSimpleValue

void setSimpleValue(String value)

setSimpleValue

void setSimpleValue(int value)

setSimpleValue

void setSimpleValue(long value)

setSimpleValue

void setSimpleValue(boolean value)

setSimpleValue

void setSimpleValue(SimpleValue value)

getChildTopics

ChildTopics getChildTopics()

setChildTopics

void setChildTopics(ChildTopicsModel childTopics)

loadChildTopics

DMXObject loadChildTopics()

loadChildTopics

DMXObject loadChildTopics(String assocDefUri)

getType

DMXType getType()

Returns the type of this object.

No access control is performed as Implicit READ permission applies: if a user has READ access to an object she has READ access to its type as well.

Note: if the user would have no READ access to this object the DMX Core would not instantiate it in the first place, but throw an AccessControlException.

getModel

DMXObjectModel getModel()

updateChildTopics

void updateChildTopics(ChildTopicsModel updateModel,
                       AssociationDefinition assocDef)

delete

void delete()

Deletes the DMX object in its entirety, that is - the object itself (the parent) - all child topics associated via "dmx.core.composition", recusively - all the remaining direct associations, e.g. "dmx.core.instantiation"

getRelatedTopic

RelatedTopic getRelatedTopic(String assocTypeUri,
                             String myRoleTypeUri,
                             String othersRoleTypeUri,
                             String othersTopicTypeUri)

Fetches and returns a related topic or null if no such topic extists.

Parameters:

assocTypeUri - may be null

myRoleTypeUri - may be null

othersRoleTypeUri - may be null

othersTopicTypeUri - may be null

getRelatedTopics

List<RelatedTopic> getRelatedTopics(String assocTypeUri)

getRelatedTopics

List<RelatedTopic> getRelatedTopics(String assocTypeUri,
                                    String myRoleTypeUri,
                                    String othersRoleTypeUri,
                                    String othersTopicTypeUri)

Parameters:

assocTypeUri - may be null

myRoleTypeUri - may be null

othersRoleTypeUri - may be null

othersTopicTypeUri - may be null

getRelatedTopics

List<RelatedTopic> getRelatedTopics(List assocTypeUris,
                                    String myRoleTypeUri,
                                    String othersRoleTypeUri,
                                    String othersTopicTypeUri)

Parameters:

assocTypeUris - may *not* be null

myRoleTypeUri - may be null

othersRoleTypeUri - may be null

othersTopicTypeUri - may be null

getRelatedAssociation

RelatedAssociation getRelatedAssociation(String assocTypeUri,
                                         String myRoleTypeUri,
                                         String othersRoleTypeUri,
                                         String othersAssocTypeUri)

Parameters:

assocTypeUri - may be null

myRoleTypeUri - may be null

othersRoleTypeUri - may be null

othersAssocTypeUri - may be null

getRelatedAssociations

List<RelatedAssociation> getRelatedAssociations(String assocTypeUri,
                                                String myRoleTypeUri,
                                                String othersRoleTypeUri,
                                                String othersAssocTypeUri)

Parameters:

assocTypeUri - may be null

myRoleTypeUri - may be null

othersRoleTypeUri - may be null

othersAssocTypeUri - may be null

getAssociation

Association getAssociation(String assocTypeUri,
                           String myRoleTypeUri,
                           String othersRoleTypeUri,
                           long othersTopicId)

getAssociations

List<Association> getAssociations()

Fetches all associations this object is a player in.

getProperty

Object getProperty(String propUri)

Returns this object's property value associated with the given property URI. If there's no property value associated with the property URI an exception is thrown.

hasProperty

boolean hasProperty(String propUri)

Checks whether for this object a property value is associated with a given property URI.

setProperty

void setProperty(String propUri,
                 Object propValue,
                 boolean addToIndex)

removeProperty

void removeProperty(String propUri)

Removes this object's property associated with the given property URI. If there's no property value associated with the property URI nothing is performed.

getDatabaseVendorObject

Object getDatabaseVendorObject()