Collection.java

/*******************************************************************************
 * Copyright (c) 2004, 2007-2008 IBM Corporation and Cambridge Semantics Incorporated.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 * 
 * File:        $Source$
 * Created by:  Generated Source from org.openanzo.jdbc.utils.opgen.jet
 * Created on:  Generated Source from org.openanzo.jdbc.utils.opgen.jet
 * Revision:	$Id$
 * 
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *	   Cambridge Semantics Incorporated - Fork to Anzo
 *******************************************************************************/
package org.openanzo.rdf.jastor.collections;

/**
 * Interface for Collection ontology class<br>
 * Use the org.openanzo.rdf.jastor.collections.CollectionsFactory to create instances of this interface.
 * <p>(URI: http://openanzo.org/ontologies/2008/07/Collections#Collection)</p>
 * <br>
 * <br>
 * <br>
 */
public interface Collection extends org.openanzo.rdf.jastor.Thing {
	
	/**
	 * The rdf:type for this ontology class
     */
	public static final org.openanzo.rdf.URI TYPE = org.openanzo.rdf.jastor.ThingFactory.valueFactory.createURI("http://openanzo.org/ontologies/2008/07/Collections#Collection");
	

	/**
	 * The Anzo Property for item 
	 * <p>(URI: http://openanzo.org/ontologies/2008/07/Collections#item)</p>
	 * <br>  
	 */
	public static org.openanzo.rdf.URI itemProperty = org.openanzo.rdf.jastor.ThingFactory.valueFactory.createURI("http://openanzo.org/ontologies/2008/07/Collections#item");




	/**
	 * Get an Iterator the 'item' property values.  This Iteartor
	 * may be used to remove all such values.
	 * @return		{@link java.util.Collection} of {@link org.openanzo.rdf.jastor.collections.Item}
	 * @see			#itemProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */
	public java.util.Collection<org.openanzo.rdf.jastor.collections.Item> getItem() throws org.openanzo.rdf.jastor.JastorException;

	/**
	 * Get an Iterator the 'item' property values.  This Iteartor
	 * may be used to remove all such values.
	 * @param 		includeEntireDataset Get the properties from the entire dataset, and not just the namedgraph
	 * @return		{@link java.util.Collection} of {@link org.openanzo.rdf.jastor.collections.Item}
	 * @see			#itemProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */
	public java.util.Collection<org.openanzo.rdf.jastor.collections.Item> getItem(boolean includeEntireDataset) throws org.openanzo.rdf.jastor.JastorException;
	

	/**
	 * Adds a value for the 'item' property
	 * @param	item	The {@link org.openanzo.rdf.jastor.collections.Item} to add
	 * @see			#itemProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */
	public void addItem(org.openanzo.rdf.jastor.collections.Item item) throws org.openanzo.rdf.jastor.JastorException;
	
	/**
	 * Adds an anonymous value for the 'item' property
	 * @return		The anoymous {@link org.openanzo.rdf.jastor.collections.Item} created
	 * @see			#itemProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */
	public org.openanzo.rdf.jastor.collections.Item addItem() throws org.openanzo.rdf.jastor.JastorException;
	
	/**
	 * Adds a value for the 'item' property.  This
	 * method is equivalent constructing a new instance of {@link org.openanzo.rdf.jastor.collections.Item} with the factory
	 * and calling addItem(org.openanzo.rdf.jastor.collections.Item item)
	 * The resource argument have rdf:type http://openanzo.org/ontologies/2008/07/Collections#Item.  That is, this method
	 * should not be used as a shortcut for creating new objects in the model.
	 * @param	resource	The {@link org.openanzo.rdf.Resource} to add
	 * @return org.openanzo.rdf.jastor.collections.Item, value added
	 * @see			#itemProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */
	public org.openanzo.rdf.jastor.collections.Item addItem(org.openanzo.rdf.Resource resource) throws org.openanzo.rdf.jastor.JastorException;
	
	/**
	 * Removes a value for the 'item' property.  This method should not
	 * be invoked while iterator through values.  In that case, the remove() method of the Iterator
	 * itself should be used.
	 * @param	item	The {@link org.openanzo.rdf.jastor.collections.Item} to remove
	 * @see			#itemProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */
	public void removeItem(org.openanzo.rdf.jastor.collections.Item item) throws org.openanzo.rdf.jastor.JastorException;

		
	/**
	 * Removes a value for the 'item' property.  This method should not
	 * be invoked while iterator through values.  In that case, the remove() method of the Iterator
	 * itself should be used.
	 * @param	item	The {@link org.openanzo.rdf.Resource} to remove
	 * @see			#itemProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */
	public void removeItem(org.openanzo.rdf.Resource item) throws org.openanzo.rdf.jastor.JastorException;


/**
	 * Clears all values for 'item'. 
	 * @param 		includeEntireDataset Delete the properties from the entire dataset, and not just the namedgraph
	 * @see			#itemProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */
	public void clearItem(boolean includeEntireDataset) throws org.openanzo.rdf.jastor.JastorException;

}