org.osid.workflow

Interface WorkQuery

All Superinterfaces:

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

public interface WorkQuery
extends OsidObjectQuery

This is the query for searching works. 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	clearOfficeIdTerms() Clears the office Id query terms.
void	clearOfficeTerms() Clears the office query terms.
void	clearProcessIdTerms() Clears the process Id query terms.
void	clearProcessTerms() Clears the process query terms.
void	clearStepIdTerms() Clears the step Id query terms.
void	clearStepTerms() Clears the step query terms.
void	clearSuspendedTerms() Clears the suspended query terms.
OfficeQuery	getOfficeQuery() Gets the query for a office.
ProcessQuery	getProcessQuery() Gets the query for a process.
StepQuery	getStepQuery() Gets the query for a step Multiple retrievals produce a nested OR term.
WorkQueryRecord	getWorkQueryRecord(Type workRecordType) Gets the work query record corresponding to the given Work record Type.
void	matchAnyStep(boolean match) Matches processes that have any step.
void	matchOfficeId(Id officeId, boolean match) Sets the office Id for this query to match works assigned to offices.
void	matchProcessId(Id processId, boolean match) Sets the process Id for this query.
void	matchStepId(Id stepId, boolean match) Sets the step Id for this query.
void	matchSuspended(boolean match) Matches suspended work.
boolean	supportsOfficeQuery() Tests if a OfficeQuery is available.
boolean	supportsProcessQuery() Tests if a ProcessQuery is available.
boolean	supportsStepQuery() Tests if a StepQuery 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

Method Detail

matchSuspended

void matchSuspended(boolean match)

Matches suspended work.

Parameters:

match - true to match suspended work, false otherwise

Compliance:

mandatory - This method must be implemented.

clearSuspendedTerms

void clearSuspendedTerms()

Clears the suspended query terms.

Compliance:

mandatory - This method must be implemented.

matchProcessId

void matchProcessId(Id processId,
                  boolean match)

Sets the process Id for this query.

Parameters:

processId - the process Id

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

Throws:

NullArgumentException - processId is null

Compliance:

mandatory - This method must be implemented.

clearProcessIdTerms

void clearProcessIdTerms()

Clears the process Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsProcessQuery

boolean supportsProcessQuery()

Tests if a ProcessQuery is available.

Returns:

true if a process query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getProcessQuery

ProcessQuery getProcessQuery()

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

Returns:

the process query

Throws:

UnimplementedException - supportsProcessQuery() is false

Compliance:

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

clearProcessTerms

void clearProcessTerms()

Clears the process query terms.

Compliance:

mandatory - This method must be implemented.

matchStepId

void matchStepId(Id stepId,
               boolean match)

Sets the step Id for this query.

Parameters:

stepId - the step Id

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

Throws:

NullArgumentException - stepId is null

Compliance:

mandatory - This method must be implemented.

clearStepIdTerms

void clearStepIdTerms()

Clears the step Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsStepQuery

boolean supportsStepQuery()

Tests if a StepQuery is available.

Returns:

true if a step query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getStepQuery

StepQuery getStepQuery()

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

Returns:

the step query

Throws:

UnimplementedException - supportsStepyQuery() is false

Compliance:

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

matchAnyStep

void matchAnyStep(boolean match)

Matches processes that have any step.

Parameters:

match - true to match processes with any step, false to match processes with no step

Compliance:

mandatory - This method must be implemented.

clearStepTerms

void clearStepTerms()

Clears the step query terms.

Compliance:

mandatory - This method must be implemented.

matchOfficeId

void matchOfficeId(Id officeId,
                 boolean match)

Sets the office Id for this query to match works assigned to offices.

Parameters:

officeId - the office Id

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

Throws:

NullArgumentException - officeId is null

Compliance:

mandatory - This method must be implemented.

clearOfficeIdTerms

void clearOfficeIdTerms()

Clears the office Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsOfficeQuery

boolean supportsOfficeQuery()

Tests if a OfficeQuery is available.

Returns:

true if a office query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOfficeQuery

OfficeQuery getOfficeQuery()

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

Returns:

the office query

Throws:

UnimplementedException - supportsOfficeQuery() is false

Compliance:

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

clearOfficeTerms

void clearOfficeTerms()

Clears the office query terms.

Compliance:

mandatory - This method must be implemented.

getWorkQueryRecord

WorkQueryRecord getWorkQueryRecord(Type workRecordType)
                                   throws OperationFailedException

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

Parameters:

workRecordType - a work record type

Returns:

the work query record

Throws:

NullArgumentException - workRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(workRecordType) is false

Compliance:

mandatory - This method must be implemented.