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

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


import org.cloudgraph.test.socialgraph.actor.Node;
import org.cloudgraph.test.socialgraph.actor.Topic;
import org.cloudgraph.test.socialgraph.story.Story;

/**
 * Generated interface representing the domain model entity Topic. 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 TP.
 * 
 *
 * @see org.cloudgraph.test.socialgraph.actor.Node Node
 * @see org.cloudgraph.test.socialgraph.actor.Topic Topic
 * @see org.cloudgraph.test.socialgraph.story.Story Story
 */
public interface Topic extends Node
{

	/** 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_TOPIC = "Topic";
	
	
	
	/**
	 * Represents the logical Property parent which is part of the Type Topic.
	 *
	 * 
	 * Data Store Mapping:
	 * Corresponds to the physical data store element TP.PNT.
	 */
	public static final String PARENT = "parent";
	
	/**
	 * Represents the logical Property child which is part of the Type Topic.
	 *
	 * 
	 * Data Store Mapping:
	 * Corresponds to the physical data store element TP.CHD.
	 */
	public static final String CHILD = "child";
	
	/**
	 * Represents the logical Property story which is part of the Type Topic.
	 *
	 * 
	 * Data Store Mapping:
	 * Corresponds to the physical data store element TP.STY.
	 */
	public static final String STORY = "story";
	



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

	/**
	 * Unsets the parent 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 unsetParent();

	/**
	 * Creates and returns a new instance of Type {@link Topic} automatically establishing a containment relationship through the object's reference property, parent.
	 * @return a new instance of Type {@link Topic} automatically establishing a containment relationship through the object's reference property parent.
	 */
	public Topic createParent();

	/**
	 * Returns the value of the parent property.
	 * @return the value of the parent property.
	 */
	public Topic getParent();

	/**
	 * Sets the value of the parent property to the given value.
	 */
	public void setParent(Topic value);


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

	/**
	 * Unsets the child property, clearing the underlying collection. The property will no longer be
	 * considered set.
	 */
	public void unsetChild();

	/**
	 * Creates and returns a new instance of Type {@link Topic} automatically establishing a containment relationship through the object's reference property, child.
	 * @return a new instance of Type {@link Topic} automatically establishing a containment relationship through the object's reference property child.
	 */
	public Topic createChild();

	/**
	 * Returns an array of Topic set for the object's multi-valued property child.
	 * @return an array of Topic set for the object's multi-valued property child.
	 */
	public Topic[] getChild();

	/**
	 * Returns the Topic set for the object's multi-valued property child based on the given index.
	 * @param idx the index
	 * @return the Topic set for the object's multi-valued property child based on the given index.
	 */
	public Topic getChild(int idx);

	/**
	 * Returns a count for multi-valued property child.
	 * @return a count for multi-valued property child.
	 */
	public int getChildCount();

	/**
	 * Sets the given array of Type Topic for the object's multi-valued property child.
	 * @param value the array value
	 */
	public void setChild(Topic[] value);

	/**
	 * Adds the given value of Type Topic for the object's multi-valued property child.
	 * @param value the value to add
	 */
	public void addChild(Topic value);

	/**
	 * Removes the given value of Type Topic for the object's multi-valued property child.
	 * @param value the value to remove
	 */
	public void removeChild(Topic value);


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

	/**
	 * Unsets the story property, clearing the underlying collection. The property will no longer be
	 * considered set.
	 */
	public void unsetStory();

	/**
	 * Creates and returns a new instance of Type {@link Story} automatically establishing a containment relationship through the object's reference property, story.
	 * @return a new instance of Type {@link Story} automatically establishing a containment relationship through the object's reference property story.
	 */
	public Story createStory();

	/**
	 * Returns an array of Story set for the object's multi-valued property story.
	 * @return an array of Story set for the object's multi-valued property story.
	 */
	public Story[] getStory();

	/**
	 * Returns the Story set for the object's multi-valued property story based on the given index.
	 * @param idx the index
	 * @return the Story set for the object's multi-valued property story based on the given index.
	 */
	public Story getStory(int idx);

	/**
	 * Returns a count for multi-valued property story.
	 * @return a count for multi-valued property story.
	 */
	public int getStoryCount();

	/**
	 * Sets the given array of Type Story for the object's multi-valued property story.
	 * @param value the array value
	 */
	public void setStory(Story[] value);

	/**
	 * Adds the given value of Type Story for the object's multi-valued property story.
	 * @param value the value to add
	 */
	public void addStory(Story value);

	/**
	 * Removes the given value of Type Story for the object's multi-valued property story.
	 * @param value the value to remove
	 */
	public void removeStory(Story value);
}