org.osid

Interface OsidRelationshipQuery

All Superinterfaces:

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

All Known Subinterfaces:

ActivityQuery, ActivityRegistrationQuery, AppointmentQuery, AssessmentEntryQuery, AuthorizationQuery, AvailabilityQuery, AwardEntryQuery, BidQuery, BudgetEntryQuery, BudgetQuery, CandidateQuery, CommentQuery, CommissionQuery, CommitmentQuery, ConferralQuery, ContactQuery, CourseEntryQuery, CourseOfferingQuery, CredentialEntryQuery, CreditQuery, DeedQuery, DocetQuery, EdgeQuery, EffortQuery, EnrollmentQuery, EntryQuery, GradeEntryQuery, HoldQuery, InstructionQuery, IssueQuery, ItemQuery, LeaseQuery, LessonQuery, OfferingQuery, ParticipantQuery, PathQuery, PlanQuery, ProficiencyQuery, ProfileEntryQuery, ProgramEntryQuery, ProgramOfferingQuery, ProvisionableQuery, ProvisionQuery, RegistrationQuery, RelationshipQuery, RelevancyQuery, RequestQuery, RequestTransactionQuery, ResourceRelationshipQuery, ResponseQuery, RouteQuery, SubscriptionQuery, VoteQuery

public interface OsidRelationshipQuery
extends OsidObjectQuery, OsidTemporalQuery

This is the query interface for searching relationships. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and 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 end reason is available.

Methods inherited from interface org.osid.OsidObjectQuery

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

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidTemporalQuery

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

Method Detail

matchEndReasonId

void matchEndReasonId(Id stateId,
                    boolean match)

Match the Id of the end reason state.

Parameters:

stateId - Id to match

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

Throws:

NullArgumentException - ruleId is null

Compliance:

mandatory - This method must be implemented.

clearEndReasonIdTerms

void clearEndReasonIdTerms()

Clears all state Id terms.

Compliance:

mandatory - This method must be implemented.

supportsEndReasonQuery

boolean supportsEndReasonQuery()

Tests if a StateQuery for the end reason is available.

Returns:

true if a end reason query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEndReasonQuery

StateQuery getEndReasonQuery(boolean match)

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

Parameters:

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

Returns:

the state query

Throws:

UnimplementedException - supportsEndReasonQuery() is false

Compliance:

optional - This method must be implemented if supportsEndReasonQuery() is true.

matchAnyEndReason

void matchAnyEndReason(boolean match)

Match any end reason state.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearEndReasonTerms

void clearEndReasonTerms()

Clears all end reason state terms.

Compliance:

mandatory - This method must be implemented.