org.osid.profile

Interface ProfileItemQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface ProfileItemQueryInspector
extends OsidObjectQueryInspector

This is the query inspector for examining profile item queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getProfileEntryIdTerms() Gets the profile entry Id query terms.
ProfileEntryQueryInspector[]	getProfileEntryTerms() Gets the profile entry query terms.
IdTerm[]	getProfileIdTerms() Gets the profile Id query terms.
ProfileItemQueryInspectorRecord	getProfileItemQueryInspectorRecord(Type profileItemRecordType) Gets the profile item query inspector record corresponding to the given ProfileItem record Type.
ProfileQueryInspector[]	getProfileTerms() Gets the profile query terms.

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

Method Detail

getProfileEntryIdTerms

IdTerm[] getProfileEntryIdTerms()

Gets the profile entry Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProfileEntryTerms

ProfileEntryQueryInspector[] getProfileEntryTerms()

Gets the profile entry 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.

getProfileItemQueryInspectorRecord

ProfileItemQueryInspectorRecord getProfileItemQueryInspectorRecord(Type profileItemRecordType)
                                                                   throws OperationFailedException

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

Parameters:

profileItemRecordType - a profile item record type

Returns:

the profile item query inspector record

Throws:

NullArgumentException - profileItemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(profileItemRecordType) is false

Compliance:

mandatory - This method must be implemented.