Class AbstractOsidRelationshipQuery

java.lang.Object

net.okapia.osid.jamocha.spi.AbstractOsidQuery

net.okapia.osid.jamocha.spi.AbstractOsidIdentifiableQuery

net.okapia.osid.jamocha.spi.AbstractOsidObjectQuery

net.okapia.osid.jamocha.spi.AbstractTemporalOsidObjectQuery

net.okapia.osid.jamocha.spi.AbstractOsidRelationshipQuery

All Implemented Interfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

Direct Known Subclasses:

AbstractActivityQuery, AbstractActivityRegistrationQuery, AbstractAppointmentQuery, AbstractAssessmentEntryQuery, AbstractAuthorizationQuery, AbstractAvailabilityQuery, AbstractAwardEntryQuery, AbstractBidQuery, AbstractBudgetEntryQuery, AbstractBudgetQuery, AbstractCandidateQuery, AbstractChainQuery, AbstractCommentQuery, AbstractCommissionQuery, AbstractCommitmentQuery, AbstractConferralQuery, AbstractContactQuery, AbstractCourseEntryQuery, AbstractCourseOfferingQuery, AbstractCredentialEntryQuery, AbstractCreditQuery, AbstractDeedQuery, AbstractDocetQuery, AbstractEdgeQuery, AbstractEffortQuery, AbstractEnrollmentQuery, AbstractEntryQuery, AbstractGradeEntryQuery, AbstractHoldQuery, AbstractInstructionQuery.OsidRelationshipQuery, AbstractIssueQuery, AbstractLeaseQuery, AbstractLessonQuery, AbstractOfferingQuery, AbstractOrderItemQuery, AbstractParticipantQuery, AbstractPathQuery, AbstractPlanQuery, AbstractProficiencyQuery, AbstractProfileEntryQuery, AbstractProgramEntryQuery, AbstractProgramOfferingQuery, AbstractProvisionableQuery, AbstractProvisionQuery, AbstractRegistrationQuery, AbstractRelationshipQuery, AbstractRelevancyQuery, AbstractRequestQuery, AbstractRequestTransactionQuery, AbstractResourceRelationshipQuery, AbstractResponseQuery, AbstractRouteQuery, AbstractSubscriptionQuery, AbstractVoteQuery

public abstract class AbstractOsidRelationshipQuery
extends AbstractTemporalOsidObjectQuery
implements OsidRelationshipQuery

Defines a OsidRelationshipQuery.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractTemporalOsidObjectQuery

AbstractTemporalOsidObjectQuery.OsidTemporalQuery

Modifier and Type	Class	Description
protected class	AbstractTemporalOsidObjectQuery.OsidTemporalQuery	Composed OsidTemporalQuery.

Nested classes/interfaces inherited from class AbstractOsidObjectQuery

AbstractOsidObjectQuery.OsidBrowsableQuery

Modifier and Type	Class	Description
protected class	AbstractOsidObjectQuery.OsidBrowsableQuery	Composed OsidBrowsableQuery.

Constructor Summary

Constructors

Constructor	Description
AbstractOsidRelationshipQuery()	Constructs a new AbstractOsidRelationshipQuery.

Method Summary

Modifier and Type	Method	Description
void	clearEndReasonIdTerms()	Clears all state Id terms.
void	clearEndReasonTerms()	Clears all end reason state terms.
StateQuery	getEndReasonQuery(boolean match)	Gets the query for the end reason state.
void	matchAnyEndReason(boolean match)	Match any end reason state.
void	matchEndReasonId(Id stateId, boolean match)	Match the Id of the end reason state.
boolean	supportsEndReasonQuery()	Tests if a StateQuery for the rule is available.

Methods inherited from class AbstractTemporalOsidObjectQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date is included within the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

Methods inherited from class AbstractOsidObjectQuery

addRecordType, clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRecordTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getDescriptionTerms, getDisplayNameTerms, getJournalEntryQuery, getRecordTypes, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, hasRecordType, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRecord, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRecordType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Modifier and Type	Method	Description
protected void	addRecordType(Type recordType)	Adds a record type.
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRecordTerms()	Clears all record Type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
protected Collection<StringTerm>	getDescriptionTerms()	Gets all the description query terms.
protected Collection<StringTerm>	getDisplayNameTerms()	Gets all the display name query terms.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
TypeList	getRecordTypes()	Gets the record types available in this object.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.
void	matchAnyComment(boolean match)	Matches an object that has any Comment .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit for the given Meter.
void	matchAnyDescription(boolean match)	Matches any object with a description.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject.
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id.
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects.
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects.

Methods inherited from class AbstractOsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from class AbstractOsidQuery

addStringMatchType, clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
protected void	addStringMatchType(Type stringMatchType)	Adds a string match type.
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AbstractOsidRelationshipQuery

public AbstractOsidRelationshipQuery()

Constructs a new AbstractOsidRelationshipQuery.

Method Details

matchEndReasonId

@OSID
public void matchEndReasonId(Id stateId,
 boolean match)

Match the Id of the end reason state.

Specified by:

matchEndReasonId in interface OsidRelationshipQuery

Parameters:

stateId - Id to match

match - true if for a positive match, false for a negative match

Throws:

NullArgumentException - ruleId is null

clearEndReasonIdTerms

@OSID
public void clearEndReasonIdTerms()

Clears all state Id terms.

Specified by:

clearEndReasonIdTerms in interface OsidRelationshipQuery

supportsEndReasonQuery

@OSID
public boolean supportsEndReasonQuery()

Tests if a StateQuery for the rule is available.

Specified by:

supportsEndReasonQuery in interface OsidRelationshipQuery

Returns:

true if a end reason query is available, false otherwise

getEndReasonQuery

@OSID
public StateQuery getEndReasonQuery(boolean match)

Gets the query for the end reason state. Each retrieval performs a boolean OR.

Specified by:

getEndReasonQuery in interface OsidRelationshipQuery

Parameters:

match - true if for a positive match, false for a negative match

Returns:

the state query

Throws:

UnimplementedException - supportsEndReasonQuery() is false

matchAnyEndReason

@OSID
public void matchAnyEndReason(boolean match)

Match any end reason state.

Specified by:

matchAnyEndReason in interface OsidRelationshipQuery

Parameters:

match - true to match any state, false to match no state

clearEndReasonTerms

@OSID
public void clearEndReasonTerms()

Clears all end reason state terms.

Specified by:

clearEndReasonTerms in interface OsidRelationshipQuery