org.cloudgraph.test.socialgraph.actor.Edge Maven / Gradle / Ivy

Go to download
package org.cloudgraph.test.socialgraph.actor;


import org.cloudgraph.test.socialgraph.actor.Node;
import org.plasma.sdo.PlasmaDataObject;

/**
 * A directed link between two nodes.
 * 
 * Generated interface representing the domain model entity Edge. This SDO interface directly reflects the
 * class (single or multiple) inheritance lattice of the source domain model(s)  and is part of namespace http://cloudgraph.org/test/socialgraph/actor defined within the Configuration.
 *
 * 
 * Data Store Mapping:
 * Corresponds to the physical data store entity EG.
 * 
 *
 * @see org.cloudgraph.test.socialgraph.actor.Node Node
 */
public interface Edge extends PlasmaDataObject
{

	/** The SDO namespace URI associated with the Type for this class. */
	public static final String NAMESPACE_URI = "http://cloudgraph.org/test/socialgraph/actor";

	/** The entity or Type logical name associated with this class. */
	public static final String TYPE_NAME_EDGE = "Edge";
	
	
	
	/**
	 * Represents the logical Property source which is part of the Type Edge.
	 *
	 * 
	 * Data Store Mapping:
	 * Corresponds to the physical data store element EG.SRC.
	 */
	public static final String SOURCE = "source";
	
	/**
	 * Represents the logical Property target which is part of the Type Edge.
	 *
	 * 
	 * Data Store Mapping:
	 * Corresponds to the physical data store element EG.TGT.
	 */
	public static final String TARGET = "target";
	



	/**
	 * Returns true if the source property is set.
	 * @return true if the source property is set.
	 */
	public boolean isSetSource();

	/**
	 * Unsets the source property, the value
	 * of the property of the object being set to the property's
	 * default value. The property will no longer be
	 * considered set.
	 */
	public void unsetSource();

	/**
	 * Creates and returns a new instance of the given subclass Type for abstract base Type {@link Node} automatically establishing a containment relationship through the object's reference property, source.
	 * @param clss the subclass Type
	 * Returns a new instance of the given subclass Type for abstract base Type {@link Node}.
	 */
	public Node createSource(Class clss);

	/**
	 * Returns the value of the source property.
	 * @return the value of the source property.
	 */
	public Node getSource();

	/**
	 * Sets the value of the source property to the given value.
	 */
	public void setSource(Node value);


	/**
	 * Returns true if the target property is set.
	 * @return true if the target property is set.
	 */
	public boolean isSetTarget();

	/**
	 * Unsets the target property, the value
	 * of the property of the object being set to the property's
	 * default value. The property will no longer be
	 * considered set.
	 */
	public void unsetTarget();

	/**
	 * Creates and returns a new instance of the given subclass Type for abstract base Type {@link Node} automatically establishing a containment relationship through the object's reference property, target.
	 * @param clss the subclass Type
	 * Returns a new instance of the given subclass Type for abstract base Type {@link Node}.
	 */
	public Node createTarget(Class clss);

	/**
	 * Returns the value of the target property.
	 * @return the value of the target property.
	 */
	public Node getTarget();

	/**
	 * Sets the value of the target property to the given value.
	 */
	public void setTarget(Node value);
}