org.osid.personnel

Interface OrganizationQueryInspector

All Superinterfaces:

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

public interface OrganizationQueryInspector
extends OsidObjectQueryInspector, OsidFederateableQueryInspector, OsidTemporalQueryInspector

The query inspectors provide a means of accessing the match terms of a query. These interfaces are used to examine the actual query terms used in a search or that may be used to create a smart catalog. Query inspectors may be converted to OsidQuery interfaces for reuse or modification in the search sessions.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorOrganizationIdTerms() Gets the ancestor organization Id query terms.
OrganizationQueryInspector[]	getAncestorOrganizationTerms() Gets the ancestor organization query terms.
IdTerm[]	getDescendantOrganizationIdTerms() Gets the descendant organization Id query terms.
OrganizationQueryInspector[]	getDescendantOrganizationTerms() Gets the descendant organization query terms.
StringTerm[]	getDisplayLabelTerms() Gets the display label query terms.
OrganizationQueryInspectorRecord	getOrganizationQueryInspectorRecord(Type organizationRecordType) Gets the organization query inspector record corresponding to the given Organization record Type.
IdTerm[]	getRealmIdTerms() Gets the realm Id query terms.
RealmQueryInspector[]	getRealmTerms() Gets the realm 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

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getDisplayLabelTerms

StringTerm[] getDisplayLabelTerms()

Gets the display label query terms.

Returns:

the display label terms

Compliance:

mandatory - This method must be implemented.

getAncestorOrganizationIdTerms

IdTerm[] getAncestorOrganizationIdTerms()

Gets the ancestor organization Id query terms.

Returns:

the ancestor organization Id terms

Compliance:

mandatory - This method must be implemented.

getAncestorOrganizationTerms

OrganizationQueryInspector[] getAncestorOrganizationTerms()

Gets the ancestor organization query terms.

Returns:

the ancestor organization terms

Compliance:

mandatory - This method must be implemented.

getDescendantOrganizationIdTerms

IdTerm[] getDescendantOrganizationIdTerms()

Gets the descendant organization Id query terms.

Returns:

the descendant organization Id terms

Compliance:

mandatory - This method must be implemented.

getDescendantOrganizationTerms

OrganizationQueryInspector[] getDescendantOrganizationTerms()

Gets the descendant organization query terms.

Returns:

the descendant organization terms

Compliance:

mandatory - This method must be implemented.

getRealmIdTerms

IdTerm[] getRealmIdTerms()

Gets the realm Id query terms.

Returns:

the realm Id terms

Compliance:

mandatory - This method must be implemented.

getRealmTerms

RealmQueryInspector[] getRealmTerms()

Gets the realm query terms.

Returns:

the realm terms

Compliance:

mandatory - This method must be implemented.

getOrganizationQueryInspectorRecord

OrganizationQueryInspectorRecord getOrganizationQueryInspectorRecord(Type organizationRecordType)
                                                                     throws OperationFailedException

Gets the organization query inspector record corresponding to the given Organization record Type.

Parameters:

organizationRecordType - an organization record type

Returns:

the organization inspector query record

Throws:

NullArgumentException - organizationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(organizationRecordType) is false

Compliance:

mandatory - This method must be implemented.