org.eclipse.higgins.idas
Interface IDigitalSubject

Package class diagram package IDigitalSubject
All Superinterfaces:
IHasAttributes, IHasMetadata, IHasRelationships<IDigitalSubjectRef>

public interface IDigitalSubject
extends IHasMetadata, IHasAttributes, IHasRelationships<IDigitalSubjectRef>

As defined at http://spwiki.editme.com/DigitalSubjectM4 and http://spwiki.editme.com/ContextProvider, This interface holds a set of IDigitalSubject objects.

TODO: Finish javadoc on methods


Method Summary
 IContext getContext()
           
 String getType()
          Returns the type of this Digital Subject.
 String getUniqueID()
          Returns the Contextually Unique Identifier of this Digital Subject
 
Methods inherited from interface org.eclipse.higgins.idas.IHasMetadata
addMetadata, createMetadata, getMetadataSet, removeMetadata
 
Methods inherited from interface org.eclipse.higgins.idas.IHasAttributes
addAttribute, createAttribute, createAttribute, getAttribute, getAttributes, removeAttribute
 
Methods inherited from interface org.eclipse.higgins.idas.IHasRelationships
addRelationship, createRelationship, getRelationships, removeRelationship
 

Method Detail

getContext

IContext getContext()
                    throws IdASException
Returns:
The Context holding this Digital Subject.
Throws:
IdASException

getUniqueID

String getUniqueID()
                   throws IdASException
Returns the Contextually Unique Identifier of this Digital Subject

Returns:
Contextually Unique Identifier of this Digital Subject
Throws:
IdASException

getType

String getType()
               throws IdASException
Returns the type of this Digital Subject.

As all Digital Subjects are required to have a type attribute, this is a shortcut for calling getAttribute("").

TODO: The above comment presumes we have a higgins-defined attribute type called "type". Do we need this?

TODO: We decided to make the type be a String rather than URI -- need to remember why, and document it.

Returns:
Throws:
IdASException


Copyright © 2006 Novell Inc. 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

Contributors:
  Jim Sermersheim (Novell, Inc.) - initial API and implementation