Class AbstractOsidRule

java.lang.Object

net.okapia.osid.jamocha.spi.AbstractIdentifiable

net.okapia.osid.jamocha.spi.AbstractOsidObject

net.okapia.osid.jamocha.spi.AbstractOperableOsidObject

net.okapia.osid.jamocha.spi.AbstractOsidRule

All Implemented Interfaces:

Browsable, Extensible, Identifiable, Operable, OsidObject, OsidRule

Direct Known Subclasses:

AbstractAction, AbstractAgenda, AbstractAssessmentRequirement, AbstractAwardRequirement, AbstractCheck, AbstractCourseRequirement, AbstractCredentialRequirement, AbstractDemographic, AbstractFunction, AbstractGradebookColumnCalculation, AbstractGradeSystemTransform, AbstractInquiry, AbstractLearningObjectiveRequirement, AbstractOffsetEvent, AbstractOsidConstrainer, AbstractOsidEnabler, AbstractOsidProcessor, AbstractParameter, AbstractPrice, AbstractProgramRequirement, AbstractRecurringEvent, AbstractRequisiteRequirement, AbstractRule, AbstractSequenceRule, AbstractSignal, AbstractSpeedZone, AbstractStep, AbstractSupersedingEvent, AbstractTodoProducer, AbstractTrigger

public abstract class AbstractOsidRule
extends AbstractOperableOsidObject
implements OsidRule

Defines a simple OSID rule 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 AbstractOperableOsidObject

AbstractOperableOsidObject.Operable

Modifier and Type	Class	Description
protected class	AbstractOperableOsidObject.Operable	The composed OPerable.

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
AbstractOsidRule()	Constructs a new AbstractOsidRule.

Method Summary

Modifier and Type	Method	Description
protected void	addConditionRecordType(Type conditionRecordType)	Adds a condition record type.
TypeList	getConditionRecordTypes()	Gets the list of OsidCondition record Types this rule requires.
Rule	getRule()	Gets the rule.
Id	getRuleId()	Gets the rule Id .
boolean	hasRule()	Tests if an explicit rule is available.
protected void	setRule(Rule rule)	Sets the rule.

Methods inherited from class AbstractOperableOsidObject

isActive, isDisabled, isEnabled, isOperational, setDisabled, setEnabled, setOperational

Modifier and Type	Method	Description
boolean	isActive()	Tests if this operable is active.
boolean	isDisabled()	Tests if this operable is administravely disabled.
boolean	isEnabled()	Tests if this operable is administravely enabled.
boolean	isOperational()	Tests if this operable is operational in that all rules pertaining to this operation except for an administrative disable are true.
protected void	setDisabled(boolean disabled)	Sets the disabled flag.
protected void	setEnabled(boolean enabled)	Sets the enabled flag.
protected void	setOperational(boolean operational)	Sets the operational flag.

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

AbstractOsidRule

public AbstractOsidRule()

Constructs a new AbstractOsidRule.

Method Details

hasRule

@OSID
public boolean hasRule()

Tests if an explicit rule is available.

Specified by:

hasRule in interface OsidRule

Returns:

true if an explicit rule is available, false otherwise

getRuleId

@OSID
public Id getRuleId()

Gets the rule Id .

Specified by:

getRuleId in interface OsidRule

Returns:

the rule Id

Throws:

IllegalStateException - hasRule() is false

getRule

@OSID
public Rule getRule()
             throws OperationFailedException

Gets the rule.

Specified by:

getRule in interface OsidRule

Returns:

the rule

Throws:

IllegalStateException - hasRule() is false

OperationFailedException - unable to complete request

setRule

protected void setRule(Rule rule)

Sets the rule.

Parameters:

rule - the rule

Throws:

NullArgumentException - rule is null

getConditionRecordTypes

@OSID
public TypeList getConditionRecordTypes()

Gets the list of OsidCondition record Types this rule requires.

Specified by:

getConditionRecordTypes in interface OsidRule

Returns:

a list of OsidCondition record types

addConditionRecordType

protected void addConditionRecordType(Type conditionRecordType)

Adds a condition record type.

Parameters:

conditionRecordType - the condition record type to add

Throws:

NullArgumentException - conditionRecordType is null