Class AbstractOsidRelationship

java.lang.Object

net.okapia.osid.jamocha.spi.AbstractIdentifiable

net.okapia.osid.jamocha.spi.AbstractOsidObject

net.okapia.osid.jamocha.spi.AbstractTemporalOsidObject

net.okapia.osid.jamocha.spi.AbstractOsidRelationship

All Implemented Interfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

Direct Known Subclasses:

AbstractActivity, AbstractActivityRegistration, AbstractAppointment, AbstractAssessmentEntry, AbstractAuthorization, AbstractAvailability, AbstractAwardEntry, AbstractBid, AbstractBudget, AbstractBudgetEntry, AbstractCandidate, AbstractComment, AbstractCommission, AbstractCommitment, AbstractConferral, AbstractContact, AbstractCourseEntry, AbstractCourseOffering, AbstractCourseRegistration, AbstractCredentialEntry, AbstractCredit, AbstractDeed, AbstractDocet, AbstractEdge, AbstractEffort, AbstractEnrollment, AbstractEntry, AbstractGradeEntry, AbstractHold, AbstractInput, AbstractInstruction.OsidRelationship, AbstractIssue, AbstractLease, AbstractLesson, AbstractOffering, AbstractOrderItem, AbstractParticipant, AbstractPath, AbstractPlan, AbstractProficiency, AbstractProfileEntry, AbstractProgramEntry, AbstractProgramOffering, AbstractProvision, AbstractProvisionable, AbstractRegistration, AbstractRelationship, AbstractRelevancy, AbstractRequest, AbstractRequestTransaction, AbstractResourceRelationship, AbstractResponse, AbstractRoute, AbstractSubscription, AbstractVote

public abstract class AbstractOsidRelationship
extends AbstractTemporalOsidObject
implements OsidRelationship

Defines a simple OSID relationship to draw from. using this abstract class requires that setId() must be done before passing this interface to a consumer in order to maintain compliance with the OSID specification.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractTemporalOsidObject

AbstractTemporalOsidObject.Temporal

Modifier and Type	Class	Description
protected class	AbstractTemporalOsidObject.Temporal	Composed Temporal.

Nested classes/interfaces inherited from class AbstractOsidObject

AbstractOsidObject.Browsable

Modifier and Type	Class	Description
protected class	AbstractOsidObject.Browsable	Composed Browsable.

Constructor Summary

Constructors

Constructor	Description
AbstractOsidRelationship()	Constructs a new AbstractOsidRelationship.

Method Summary

Modifier and Type	Method	Description
State	getEndReason()	Gets a state indicating why this relationship has ended.
Id	getEndReasonId()	Gets a state Id indicating why this relationship has ended.
boolean	hasEndReason()	Tests if a reason this relationship came to an end is known.
protected void	setEndReason(State state)	Sets the end state.

Methods inherited from class AbstractTemporalOsidObject

getEndDate, getStartDate, isEffective, setEndDate, setStartDate

Modifier and Type	Method	Description
DateTime	getEndDate()	Gets the end date.
DateTime	getStartDate()	Gets the start date.
boolean	isEffective()	Tests if the current date is within the start end end dates inclusive.
protected void	setEndDate(DateTime date)	Sets the end date.
protected void	setStartDate(DateTime date)	Sets the start date.

Methods inherited from class AbstractOsidObject

addProperties, addRecordType, getDescription, getDisplayName, getGenusType, getProperties, getPropertiesByRecordType, getRecordTypes, hasRecordType, isOfGenusType, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
protected void	addProperties(Collection<Property> set, Type recordType)	Adds a property set.
protected void	addRecordType(Type recordType)	Adds a record type.
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
PropertyList	getProperties()	Gets a list of all properties of this object including those corresponding to data within this object's records.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets the properties by record type.
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type.
protected void	setDescription(DisplayText description)	Sets the description of this object.
protected void	setDisplayName(DisplayText displayName)	Sets the displayName for this object.
protected void	setGenusType(Type genusType)	Sets a genus type.

Methods inherited from class AbstractIdentifiable

current, equals, getId, hashCode, isCurrent, setId, stale, toString

Modifier and Type	Method	Description
protected void	current()	Sets the current flag to true.
final boolean	equals(Object obj)	Determines if the given Id is equal to this one.
Id	getId()	Gets the Id associated with this instance of this OSID object.
int	hashCode()	Returns a hash code value for this OsidObject based on the Id.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.
protected void	setId(Id id)	Sets the Id associated with this instance of this OSID object.
protected void	stale()	Sets the current flag to false.
String	toString()	Returns a string representation of this OsidObject.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AbstractOsidRelationship

public AbstractOsidRelationship()

Constructs a new AbstractOsidRelationship.

Method Details

hasEndReason

@OSID
public boolean hasEndReason()

Tests if a reason this relationship came to an end is known.

Specified by:

hasEndReason in interface OsidRelationship

Returns:

true if an end reason is available, false otherwise

Throws:

IllegalStateException - isEffective is true

getEndReasonId

@OSID
public Id getEndReasonId()

Gets a state Id indicating why this relationship has ended.

Specified by:

getEndReasonId in interface OsidRelationship

Returns:

a state Id

Throws:

IllegalStateException - hasEndReason() is false

getEndReason

@OSID
public State getEndReason()
                   throws OperationFailedException

Gets a state indicating why this relationship has ended.

Specified by:

getEndReason in interface OsidRelationship

Returns:

a state

Throws:

IllegalStateException - hasEndReason() is false

OperationFailedException - unable to complete request

setEndReason

protected void setEndReason(State state)

Sets the end state.

Parameters:

state - the end state

Throws:

NullArgumentException - state is null