org.osid.resourcing

Interface FoundryQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface FoundryQuery
extends OsidCatalogQuery

This is the query for searching foundries. Each method match 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	clearAncestorFoundryIdTerms() Clears the ancestor foundry Id query terms.
void	clearAncestorFoundryTerms() Clears the ancestor foundry query terms.
void	clearAvailabilityIdTerms() Clears the availability Id query terms.
void	clearAvailabilityTerms() Clears the availability query terms.
void	clearCommissionIdTerms() Clears the commission Id query terms.
void	clearCommissionTerms() Clears the commission query terms.
void	clearDescendantFoundryIdTerms() Clears the descendant foundry Id query terms.
void	clearDescendantFoundryTerms() Clears the descendant foundry query terms.
void	clearEffortIdTerms() Clears the effort Id query terms.
void	clearEffortTerms() Clears the effort query terms.
void	clearJobIdTerms() Clears the job query terms.
void	clearJobTerms() Clears the job query terms.
void	clearWorkIdTerms() Clears the work Id query terms.
void	clearWorkTerms() Clears the work query terms.
FoundryQuery	getAncestorFoundryQuery() Gets the query for a foundry.
AvailabilityQuery	getAvailabilityQuery() Gets the query for a availability.
CommissionQuery	getCommissionQuery() Gets the query for a commission.
FoundryQuery	getDescendantFoundryQuery() Gets the query for a foundry/ Multiple retrievals produce a nested OR term.
EffortQuery	getEffortQuery() Gets the query for an effort.
FoundryQueryRecord	getFoundryQueryRecord(Type foundryRecordType) Gets the foundry query record corresponding to the given Foundry record Type.
JobQuery	getJobQuery() Gets the query for a job.
WorkQuery	getWorkQuery() Gets the query for a work.
void	matchAncestorFoundryId(Id foundryId, boolean match) Sets the foundry Id for this query to match foundries that have the specified foundry as an ancestor.
void	matchAnyAncestorFoundry(boolean match) Matches foundries with any ancestor.
void	matchAnyAvailability(boolean match) Matches foundries that have any availability.
void	matchAnyCommission(boolean match) Matches foundries that have any commission.
void	matchAnyDescendantFoundry(boolean match) Matches foundries with any descendant.
void	matchAnyEffort(boolean match) Matches foundries with any effort.
void	matchAnyJob(boolean match) Matches foundries that have any job.
void	matchAnyWork(boolean match) Matches foundries that have any work.
void	matchAvailabilityId(Id availabilityId, boolean match) Sets the availability Id for this query to match foundries that have a related availability.
void	matchCommissionId(Id commissionId, boolean match) Sets the commission Id for this query.
void	matchDescendantFoundryId(Id foundryId, boolean match) Sets the foundry Id for this query to match foundries that have the specified foundry as a descendant.
void	matchEffortId(Id effortId, boolean match) Sets the effort Id for this query.
void	matchJobId(Id jobId, boolean match) Sets the effort Id for this query to match foundries containing jobs.
void	matchWorkId(Id workId, boolean match) Sets the work Id for this query.
boolean	supportsAncestorFoundryQuery() Tests if a FoundryQuery is available.
boolean	supportsAvailabilityQuery() Tests if a AvailabilityQuery is available.
boolean	supportsCommissionQuery() Tests if a CommissionQuery is available.
boolean	supportsDescendantFoundryQuery() Tests if a FoundryQuery is available.
boolean	supportsEffortQuery() Tests if an EffortQuery is available.
boolean	supportsJobQuery() Tests if a JobQuery is available.
boolean	supportsWorkQuery() Tests if a WorkQuery 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.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchJobId

void matchJobId(Id jobId,
              boolean match)

Sets the effort Id for this query to match foundries containing jobs.

Parameters:

jobId - the job Id

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

Throws:

NullArgumentException - jobId is null

Compliance:

mandatory - This method must be implemented.

clearJobIdTerms

void clearJobIdTerms()

Clears the job query terms.

Compliance:

mandatory - This method must be implemented.

supportsJobQuery

boolean supportsJobQuery()

Tests if a JobQuery is available.

Returns:

true if a job query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getJobQuery

JobQuery getJobQuery()

Gets the query for a job. Multiple retrievals produce a nested OR term.

Returns:

the job query

Throws:

UnimplementedException - supportsJobQuery() is false

Compliance:

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

matchAnyJob

void matchAnyJob(boolean match)

Matches foundries that have any job.

Parameters:

match - true to match foundries with any job, false to match foundries with no job

Compliance:

mandatory - This method must be implemented.

clearJobTerms

void clearJobTerms()

Clears the job query terms.

Compliance:

mandatory - This method must be implemented.

matchWorkId

void matchWorkId(Id workId,
               boolean match)

Sets the work Id for this query.

Parameters:

workId - the work Id

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

Throws:

NullArgumentException - workId is null

Compliance:

mandatory - This method must be implemented.

clearWorkIdTerms

void clearWorkIdTerms()

Clears the work Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsWorkQuery

boolean supportsWorkQuery()

Tests if a WorkQuery is available.

Returns:

true if a work query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getWorkQuery

WorkQuery getWorkQuery()

Gets the query for a work. Multiple retrievals produce a nested OR term.

Returns:

the work query

Throws:

UnimplementedException - supportsWorkQuery() is false

Compliance:

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

matchAnyWork

void matchAnyWork(boolean match)

Matches foundries that have any work.

Parameters:

match - true to match foundries with any work, false to match foundries with no job

Compliance:

mandatory - This method must be implemented.

clearWorkTerms

void clearWorkTerms()

Clears the work query terms.

Compliance:

mandatory - This method must be implemented.

matchAvailabilityId

void matchAvailabilityId(Id availabilityId,
                       boolean match)

Sets the availability Id for this query to match foundries that have a related availability.

Parameters:

availabilityId - a availability Id

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

Throws:

NullArgumentException - availabilityId is null

Compliance:

mandatory - This method must be implemented.

clearAvailabilityIdTerms

void clearAvailabilityIdTerms()

Clears the availability Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAvailabilityQuery

boolean supportsAvailabilityQuery()

Tests if a AvailabilityQuery is available.

Returns:

true if a availability query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAvailabilityQuery

AvailabilityQuery getAvailabilityQuery()

Gets the query for a availability. Multiple retrievals produce a nested OR term.

Returns:

the availability query

Throws:

UnimplementedException - supportsAvailabilityQuery() is false

Compliance:

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

matchAnyAvailability

void matchAnyAvailability(boolean match)

Matches foundries that have any availability.

Parameters:

match - true to match foundries with any availability, false to match foundries with no availability

Compliance:

mandatory - This method must be implemented.

clearAvailabilityTerms

void clearAvailabilityTerms()

Clears the availability query terms.

Compliance:

mandatory - This method must be implemented.

matchCommissionId

void matchCommissionId(Id commissionId,
                     boolean match)

Sets the commission Id for this query.

Parameters:

commissionId - the commission Id

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

Throws:

NullArgumentException - commissionId is null

Compliance:

mandatory - This method must be implemented.

clearCommissionIdTerms

void clearCommissionIdTerms()

Clears the commission Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsCommissionQuery

boolean supportsCommissionQuery()

Tests if a CommissionQuery is available.

Returns:

true if a commission query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCommissionQuery

CommissionQuery getCommissionQuery()

Gets the query for a commission. Multiple retrievals produce a nested OR term.

Returns:

the commission query

Throws:

UnimplementedException - supportsCommissionQuery() is false

Compliance:

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

matchAnyCommission

void matchAnyCommission(boolean match)

Matches foundries that have any commission.

Parameters:

match - true to match foundries with any commission, false to match foundries with no commission

Compliance:

mandatory - This method must be implemented.

clearCommissionTerms

void clearCommissionTerms()

Clears the commission query terms.

Compliance:

mandatory - This method must be implemented.

matchEffortId

void matchEffortId(Id effortId,
                 boolean match)

Sets the effort Id for this query.

Parameters:

effortId - the effort Id

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

Throws:

NullArgumentException - effortId is null

Compliance:

mandatory - This method must be implemented.

clearEffortIdTerms

void clearEffortIdTerms()

Clears the effort Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsEffortQuery

boolean supportsEffortQuery()

Tests if an EffortQuery is available.

Returns:

true if an effort query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEffortQuery

EffortQuery getEffortQuery()

Gets the query for an effort. Multiple retrievals produce a nested OR term.

Returns:

the effort query

Throws:

UnimplementedException - supportsEffortQuery() is false

Compliance:

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

matchAnyEffort

void matchAnyEffort(boolean match)

Matches foundries with any effort.

Parameters:

match - true to match foundries with any effort, false to match foundries with no effort

Compliance:

mandatory - This method must be implemented.

clearEffortTerms

void clearEffortTerms()

Clears the effort query terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorFoundryId

void matchAncestorFoundryId(Id foundryId,
                          boolean match)

Sets the foundry Id for this query to match foundries that have the specified foundry as an ancestor.

Parameters:

foundryId - a foundry Id

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

Throws:

NullArgumentException - foundryId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorFoundryIdTerms

void clearAncestorFoundryIdTerms()

Clears the ancestor foundry Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorFoundryQuery

boolean supportsAncestorFoundryQuery()

Tests if a FoundryQuery is available.

Returns:

true if a foundry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorFoundryQuery

FoundryQuery getAncestorFoundryQuery()

Gets the query for a foundry. Multiple retrievals produce a nested OR term.

Returns:

the foundry query

Throws:

UnimplementedException - supportsAncestorFoundryQuery() is false

Compliance:

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

matchAnyAncestorFoundry

void matchAnyAncestorFoundry(boolean match)

Matches foundries with any ancestor.

Parameters:

match - true to match foundries with any ancestor, false to match root foundries

Compliance:

mandatory - This method must be implemented.

clearAncestorFoundryTerms

void clearAncestorFoundryTerms()

Clears the ancestor foundry query terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantFoundryId

void matchDescendantFoundryId(Id foundryId,
                            boolean match)

Sets the foundry Id for this query to match foundries that have the specified foundry as a descendant.

Parameters:

foundryId - a foundry Id

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

Throws:

NullArgumentException - foundryId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantFoundryIdTerms

void clearDescendantFoundryIdTerms()

Clears the descendant foundry Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantFoundryQuery

boolean supportsDescendantFoundryQuery()

Tests if a FoundryQuery is available.

Returns:

true if a foundry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantFoundryQuery

FoundryQuery getDescendantFoundryQuery()

Gets the query for a foundry/ Multiple retrievals produce a nested OR term.

Returns:

the foundry query

Throws:

UnimplementedException - supportsDescendantFoundryQuery() is false

Compliance:

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

matchAnyDescendantFoundry

void matchAnyDescendantFoundry(boolean match)

Matches foundries with any descendant.

Parameters:

match - true to match foundries with any descendant, false to match leaf foundries

Compliance:

mandatory - This method must be implemented.

clearDescendantFoundryTerms

void clearDescendantFoundryTerms()

Clears the descendant foundry query terms.

Compliance:

mandatory - This method must be implemented.

getFoundryQueryRecord

FoundryQueryRecord getFoundryQueryRecord(Type foundryRecordType)
                                         throws OperationFailedException

Gets the foundry query record corresponding to the given Foundry record Type. Multiple record retrievals produce a nested OR term.

Parameters:

foundryRecordType - a foundry record type

Returns:

the foundry query record

Throws:

NullArgumentException - foundryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(foundryRecordType) is false

Compliance:

mandatory - This method must be implemented.