001: /**********************************************************************************
002: * $URL: https://source.sakaiproject.org/svn/metaobj/tags/sakai_2-4-1/metaobj-api/api/src/java/org/sakaiproject/metaobj/shared/mgt/ReadableObjectHome.java $
003: * $Id: ReadableObjectHome.java 9469 2006-05-15 14:52:05Z chmaurer@iupui.edu $
004: ***********************************************************************************
005: *
006: * Copyright (c) 2004, 2005, 2006 The Sakai Foundation.
007: *
008: * Licensed under the Educational Community License, Version 1.0 (the "License");
009: * you may not use this file except in compliance with the License.
010: * You may obtain a copy of the License at
011: *
012: * http://www.opensource.org/licenses/ecl1.php
013: *
014: * Unless required by applicable law or agreed to in writing, software
015: * distributed under the License is distributed on an "AS IS" BASIS,
016: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017: * See the License for the specific language governing permissions and
018: * limitations under the License.
019: *
020: **********************************************************************************/package org.sakaiproject.metaobj.shared.mgt;
021:
022: import java.io.InputStream;
023: import java.util.Collection;
024:
025: import org.sakaiproject.metaobj.shared.model.Agent;
026: import org.sakaiproject.metaobj.shared.model.Artifact;
027: import org.sakaiproject.metaobj.shared.model.FinderException;
028: import org.sakaiproject.metaobj.shared.model.Id;
029: import org.sakaiproject.metaobj.shared.model.PersistenceException;
030: import org.sakaiproject.metaobj.shared.model.Type;
031:
032: /**
033: * Created by IntelliJ IDEA.
034: * User: John Ellis
035: * Date: Apr 8, 2004
036: * Time: 5:16:38 PM
037: * To change this template use File | Settings | File Templates.
038: */
039: public interface ReadableObjectHome {
040:
041: public Type getType();
042:
043: /**
044: * Used to get an externally unique type to identify this home
045: * across running osp instances
046: *
047: * @return an externally unique type suitable for storage and later import
048: */
049: public String getExternalType();
050:
051: /**
052: * Load the object from the
053: * backing store.
054: *
055: * @param id Uniquely identifies the object.
056: * @return The loaded object
057: */
058: public Artifact load(Id id) throws PersistenceException;
059:
060: /**
061: * Creates an empty instance of this home's object
062: *
063: * @return An empty object instance
064: */
065: public Artifact createInstance();
066:
067: public void prepareInstance(Artifact object);
068:
069: /**
070: * Creates a sample instance of the
071: * object with each field filled in with some
072: * representative data.
073: *
074: * @return An object instance with sample data filled in.
075: */
076: public Artifact createSample();
077:
078: /**
079: * Find all the instances of this home's
080: * objects that are owned by the supplied owner.
081: * How do we handle permissions here?
082: *
083: * @param owner The owner in question.
084: * @return A list of objects.
085: */
086: public Collection findByOwner(Agent owner) throws FinderException;
087:
088: /**
089: * Determines if the supplied object is handled by this home.
090: *
091: * @param testObject the object to be tested.
092: * @return true if the supplied object is handled by this home
093: */
094: public boolean isInstance(Artifact testObject);
095:
096: /**
097: * re-initialize any configuration
098: */
099: public void refresh();
100:
101: public String getExternalUri(Id artifactId, String name);
102:
103: public InputStream getStream(Id artifactId);
104:
105: public boolean isSystemOnly();
106:
107: public Class getInterface();
108: }
|