org.eclipse.higgins.idas.api
Interface IDigitalSubject

All Superinterfaces:

IHasAttributes, IHasMetadata

public interface IDigitalSubject

extends IHasMetadata, IHasAttributes

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

TODO (Doc): Finish javadoc on methods

Method Summary

IContext	getContext()
IDigitalSubjectModel	getModel() Returns a model of this type of Digital Subjects as it defined in the context's schema.
String	getSubjectID() Returns the Contextually Unique Identifier of this Digital Subject
URI	getType() Returns the type of this Digital Subject.
void	remove() Removes this Digital Subject from its Context.

Methods inherited from interface org.eclipse.higgins.idas.api.IHasMetadata

addMetadata, addMetadata, equals, getMetadata, getMetadataSet

Methods inherited from interface org.eclipse.higgins.idas.api.IHasAttributes

addAttribute, addAttribute, equals, getAttribute, getAttributes, getSingleValuedAttribute, removeAttribute, removeAttributeValue, removeAttributeValue

Method Detail

getContext

public IContext getContext()
                    throws IdASException

Returns:

The Context holding this Digital Subject.

Throws:

IdASException

getSubjectID

public String getSubjectID()
                    throws IdASException

Returns the Contextually Unique Identifier of this Digital Subject

Returns:

Contextually Unique Identifier of this Digital Subject

Throws:

IdASException

getType

public URI getType()
            throws IdASException

Returns the type of this Digital Subject. For example: http://www.eclipse.org/higgins/ontologies/2006/person#Person

Returns:

This Digital Subject's type

Throws:

IdASException

remove

public void remove()
            throws IdASException

Removes this Digital Subject from its Context. Note: This operation is only applied to any backing data store after IContext.applyUpdates() is called.
Note: It is invalid to call subsequent update operations on this IDigitalSubject instance or on any elements held by this Digital Subject or by any of its sub-elements.

Throws:

IdASException

getModel

public IDigitalSubjectModel getModel()
                              throws IdASException

Returns a model of this type of Digital Subjects as it defined in the context's schema. Returned model could be used to discover what attributes are defined in the context's schema for this type of Digital Subjects.

Returns:

the model of this Digital Subject

Throws:

IdASException