Class AbstractContactQueryInspector
java.lang.Object
net.okapia.osid.jamocha.spi.AbstractOsidQueryInspector
net.okapia.osid.jamocha.spi.AbstractOsidIdentifiableQueryInspector
net.okapia.osid.jamocha.spi.AbstractOsidObjectQueryInspector
net.okapia.osid.jamocha.spi.AbstractTemporalOsidObjectQueryInspector
net.okapia.osid.jamocha.spi.AbstractOsidRelationshipQueryInspector
net.okapia.osid.jamocha.contact.contact.spi.AbstractContactQueryInspector
- All Implemented Interfaces:
ContactQueryInspector, Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector
- Direct Known Subclasses:
ContactQueryUninspector
public abstract class AbstractContactQueryInspector
extends AbstractOsidRelationshipQueryInspector
implements ContactQueryInspector
A query inspector template for contacts.
-
Nested Class Summary
Nested classes/interfaces inherited from class AbstractTemporalOsidObjectQueryInspector
AbstractTemporalOsidObjectQueryInspector.OsidTemporalQueryInspectorModifier and TypeClassDescriptionprotected classComposed OsidTemporalQueryInspector.Nested classes/interfaces inherited from class AbstractOsidObjectQueryInspector
AbstractOsidObjectQueryInspector.OsidBrowsableQueryInspectorModifier and TypeClassDescriptionprotected classComposed BrowsableQueryInspector. -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a newAbstractContactQueryInspector. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidaddContactQueryInspectorRecord(ContactQueryInspectorRecord contactQueryInspectorRecord, Type contactRecordType) Adds a record to this contact query.IdTerm[]Gets the address bookIdterms.Gets the address book terms.IdTerm[]Gets the resourceIdterms.Gets the resource terms.IdTerm[]Gets the addressIdterms.Gets the address terms.getContactQueryInspectorRecord(Type contactRecordType) Gets the record corresponding to the given contact query inspector recordType.IdTerm[]Gets the referenceIdterms.Methods inherited from class AbstractOsidRelationshipQueryInspector
getEndReasonIdTerms, getEndReasonTermsModifier and TypeMethodDescriptionIdTerm[]Gets the end reaosn stateIdquery terms.Gets the end reason state query terms.Methods inherited from class AbstractTemporalOsidObjectQueryInspector
getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTermsModifier and TypeMethodDescriptionGets the date query terms.Gets the effective query terms.Gets the end date query terms.Gets the start date query terms.Methods inherited from class AbstractOsidObjectQueryInspector
addRecordType, getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRecordTypes, getRecordTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms, hasRecordTypeModifier and TypeMethodDescriptionprotected voidaddRecordType(Type recordType) Adds a record type.IdTerm[]Gets the commentIdquery terms.Gets the comment query terms.IdTerm[]Gets the creditIdquery terms.Gets the credit query terms.Gets the description query terms.Gets the display name query terms.TypeTerm[]Gets the genus type query terms.IdTerm[]Gets the journal entryIdquery terms.Gets the journal entry query terms.TypeTerm[]Gets the parent genus type query terms.Gets the record types available in this object.TypeTerm[]Gets the record type query terms.IdTerm[]Gets the relationshipIdquery terms.IdTerm[]Gets the relationship peerIdquery terms.Gets the relationship query terms.IdTerm[]Gets the stateIdquery terms.Gets the state query terms.Gets the statistic query terms.IdTerm[]Gets the subjectIdquery terms.Gets the relevancy query terms.Gets the subject query terms.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from class AbstractOsidIdentifiableQueryInspector
getIdTermsMethods inherited from class AbstractOsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.
-
Constructor Details
-
AbstractContactQueryInspector
public AbstractContactQueryInspector()Constructs a newAbstractContactQueryInspector.
-
-
Method Details
-
getReferenceIdTerms
Gets the referenceIdterms.- Specified by:
getReferenceIdTermsin interfaceContactQueryInspector- Returns:
- the reference
Idterms
-
getAddresseeIdTerms
Gets the resourceIdterms.- Specified by:
getAddresseeIdTermsin interfaceContactQueryInspector- Returns:
- the resource
Idterms
-
getAddresseeTerms
Gets the resource terms.- Specified by:
getAddresseeTermsin interfaceContactQueryInspector- Returns:
- the resource terms
-
getAddressIdTerms
Gets the addressIdterms.- Specified by:
getAddressIdTermsin interfaceContactQueryInspector- Returns:
- the address
Idterms
-
getAddressTerms
Gets the address terms.- Specified by:
getAddressTermsin interfaceContactQueryInspector- Returns:
- the address terms
-
getAddressBookIdTerms
Gets the address bookIdterms.- Specified by:
getAddressBookIdTermsin interfaceContactQueryInspector- Returns:
- the address book
Idterms
-
getAddressBookTerms
Gets the address book terms.- Specified by:
getAddressBookTermsin interfaceContactQueryInspector- Returns:
- the address book terms
-
getContactQueryInspectorRecord
@OSID public ContactQueryInspectorRecord getContactQueryInspectorRecord(Type contactRecordType) throws OperationFailedException Gets the record corresponding to the given contact query inspector recordType.This method must be used to retrieve a contact implementing the requested record.- Specified by:
getContactQueryInspectorRecordin interfaceContactQueryInspector- Parameters:
contactRecordType- a contact record type- Returns:
- the contact query inspsector record
- Throws:
NullArgumentException-contactRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(contactRecordType)isfalse
-
addContactQueryInspectorRecord
protected void addContactQueryInspectorRecord(ContactQueryInspectorRecord contactQueryInspectorRecord, Type contactRecordType) Adds a record to this contact query.- Parameters:
contactQueryInspectorRecord- contact query inspector recordcontactRecordType- contact record type- Throws:
NullArgumentException-recordisnull
-