org.osid.profile

Interface ProfileEntryQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface ProfileEntryQueryInspector
extends OsidRelationshipQueryInspector

The query inspector to examine profile entry queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAgentIdTerms() Gets the agent Id query terms.
AgentQueryInspector[]	getAgentTerms() Gets the agent query terms.
BooleanTerm[]	getImplicitTerms() Gets the implicit profile entries query terms.
ProfileEntryQueryInspectorRecord	getProfileEntryQueryInspectorRecord(Type profileEntryRecordType) Gets the profile item query inspector corresponding to the given ProfileEntry record Type.
IdTerm[]	getProfileIdTerms() Gets the profile Id query terms.
IdTerm[]	getProfileItemIdTerms() Gets the profile item Id query terms.
ProfileItemQueryInspector[]	getProfileItemTerms() Gets the profile item query terms.
ProfileQueryInspector[]	getProfileTerms() Gets the profile query terms.
IdTerm[]	getRelatedProfileEntryIdTerms() Gets the related profile entry Id query terms.
ProfileEntryQueryInspector[]	getRelatedProfileEntryTerms() Gets the related profile entry query terms.
IdTerm[]	getResourceIdTerms() Gets the resource Id query terms.
ResourceQueryInspector[]	getResourceTerms() Gets the resource query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getImplicitTerms

BooleanTerm[] getImplicitTerms()

Gets the implicit profile entries query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRelatedProfileEntryIdTerms

IdTerm[] getRelatedProfileEntryIdTerms()

Gets the related profile entry Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRelatedProfileEntryTerms

ProfileEntryQueryInspector[] getRelatedProfileEntryTerms()

Gets the related profile entry query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getResourceIdTerms

IdTerm[] getResourceIdTerms()

Gets the resource Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getResourceTerms

ResourceQueryInspector[] getResourceTerms()

Gets the resource query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAgentIdTerms

IdTerm[] getAgentIdTerms()

Gets the agent Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAgentTerms

AgentQueryInspector[] getAgentTerms()

Gets the agent query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProfileItemIdTerms

IdTerm[] getProfileItemIdTerms()

Gets the profile item Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProfileItemTerms

ProfileItemQueryInspector[] getProfileItemTerms()

Gets the profile item query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProfileIdTerms

IdTerm[] getProfileIdTerms()

Gets the profile Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProfileTerms

ProfileQueryInspector[] getProfileTerms()

Gets the profile query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProfileEntryQueryInspectorRecord

ProfileEntryQueryInspectorRecord getProfileEntryQueryInspectorRecord(Type profileEntryRecordType)
                                                                     throws OperationFailedException

Gets the profile item query inspector corresponding to the given ProfileEntry record Type.

Parameters:

profileEntryRecordType - a profile entry record type

Returns:

the profile entry query inspector record

Throws:

NullArgumentException - profileEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.