OrderedCollection.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 OrderedCollection 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#OrderedCollection)</p>
 * <br>
 * <br>
 * <br>
 */
public interface OrderedCollection extends 
org.openanzo.rdf.jastor.collections.Collection, 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#OrderedCollection");
	

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


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




		
	/**
	 * 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;
	/**
	 * Gets the 'collectionSize' property value from the given graph
	 * @return		{@link java.lang.Integer}
	 * @see			#collectionSizeProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */
	public java.lang.Integer getCollectionSize() throws org.openanzo.rdf.jastor.JastorException;
	
	/**
	 * Gets the 'collectionSize' property value
	 * @param 		includeEntireDataset Get the properties from the entire dataset, and not just the namedgraph
	 * @return		{@link java.lang.Integer}
	 * @see			#collectionSizeProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */
	public java.lang.Integer getCollectionSize(boolean includeEntireDataset) throws org.openanzo.rdf.jastor.JastorException;

	/**
	 * Sets the 'collectionSize' property value
	 * @param	collectionSize	{@link java.lang.Integer}, the value to set
	 * @see			#collectionSizeProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */
	public void setCollectionSize(java.lang.Integer collectionSize) throws org.openanzo.rdf.jastor.JastorException;

/**
	 * Clears all values for 'collectionSize'. 
	 * @param 		includeEntireDataset Delete the properties from the entire dataset, and not just the namedgraph
	 * @see			#collectionSizeProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */
	public void clearCollectionSize(boolean includeEntireDataset) throws org.openanzo.rdf.jastor.JastorException;
	/**
	 * Gets the 'firstItem' property value
	 * @return		{@link org.openanzo.rdf.jastor.collections.OrderedItem}
	 * @see			#firstItemProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */
	public org.openanzo.rdf.jastor.collections.OrderedItem getFirstItem() throws org.openanzo.rdf.jastor.JastorException;
	
	/**
	 * Gets the 'firstItem' property value
	 * @param 		includeEntireDataset Get the properties from the entire dataset, and not just the namedgraph
	 * @return		{@link org.openanzo.rdf.jastor.collections.OrderedItem}
	 * @see			#firstItemProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */
	public org.openanzo.rdf.jastor.collections.OrderedItem getFirstItem(boolean includeEntireDataset) throws org.openanzo.rdf.jastor.JastorException;

	/**
	 * Sets the 'firstItem' property value
	 * @param	firstItem	{@link org.openanzo.rdf.jastor.collections.OrderedItem}, value to set
	 * @see			#firstItemProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */
	public void setFirstItem(org.openanzo.rdf.jastor.collections.OrderedItem firstItem) throws org.openanzo.rdf.jastor.JastorException;
	
	/**
	 * Sets the 'firstItem' property value to an anonymous node
	 * @return		{@link org.openanzo.rdf.jastor.collections.OrderedItem}, the created value
	 * @see			#firstItemProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */	
	public org.openanzo.rdf.jastor.collections.OrderedItem setFirstItem() throws org.openanzo.rdf.jastor.JastorException;
	
	/**
	 * Sets the 'firstItem' property value to the given resource, and add's rdf:type properties.  This
	 * method is equivalent constructing a new instance of {@link org.openanzo.rdf.jastor.collections.OrderedItem} with the factory.
	 * and calling setFirstItem(org.openanzo.rdf.jastor.collections.OrderedItem firstItem)
	 * The resource argument have rdf:type http://openanzo.org/ontologies/2008/07/Collections#OrderedItem.  That is, this method
	 * should not be used as a shortcut for creating new objects in the model.
	 * @param	resource	{@link org.openanzo.rdf.Resource} must not be be null.
	 * @return		{@link org.openanzo.rdf.jastor.collections.OrderedItem}, the newly created value
	 * @see			#firstItemProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */
	public org.openanzo.rdf.jastor.collections.OrderedItem setFirstItem(org.openanzo.rdf.Resource resource) throws org.openanzo.rdf.jastor.JastorException;
	
/**
	 * Clears all values for 'firstItem'. 
	 * @param 		includeEntireDataset Delete the properties from the entire dataset, and not just the namedgraph
	 * @see			#firstItemProperty
	 * @throws org.openanzo.rdf.jastor.JastorException
	 */
	public void clearFirstItem(boolean includeEntireDataset) throws org.openanzo.rdf.jastor.JastorException;

}