Interface OsidObjectQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidQuery, Suppliable
All Known Subinterfaces:
AcademyQuery, AccountQuery, ActionEnablerQuery, ActionGroupQuery, ActionQuery, ActivityQuery, ActivityQuery, ActivityQuery, ActivityRegistrationQuery, ActivityUnitQuery, AddressBookQuery, AddressQuery, AgencyQuery, AgendaQuery, AgentQuery, AnswerQuery, AntimatroidQuery, AppointmentQuery, AssessmentEntryQuery, AssessmentOfferedQuery, AssessmentPartQuery, AssessmentQuery, AssessmentTakenQuery, AssetContentQuery, AssetQuery, AuctionConstrainerEnablerQuery, AuctionConstrainerQuery, AuctionHouseQuery, AuctionProcessorEnablerQuery, AuctionProcessorQuery, AuctionQuery, AuditConstrainerEnablerQuery, AuditConstrainerQuery, AuditEnablerQuery, AuditProcessorEnablerQuery, AuditProcessorQuery, AuditQuery, AuthorizationEnablerQuery, AuthorizationQuery, AvailabilityEnablerQuery, AvailabilityQuery, AwardEntryQuery, AwardQuery, BallotConstrainerEnablerQuery, BallotConstrainerQuery, BallotQuery, BankQuery, BidEnablerQuery, BidQuery, BillingQuery, BinQuery, BlockQuery, BlogQuery, BookQuery, BranchQuery, BrokerConstrainerEnablerQuery, BrokerConstrainerQuery, BrokerEnablerQuery, BrokerProcessorEnablerQuery, BrokerProcessorQuery, BrokerQuery, BudgetEntryQuery, BudgetQuery, BuildingQuery, BusinessQuery, BusinessQuery, CalendarQuery, CampusQuery, CandidateQuery, CanonicalUnitEnablerQuery, CanonicalUnitProcessorEnablerQuery, CanonicalUnitProcessorQuery, CanonicalUnitQuery, CatalogEnablerQuery, CatalogQuery, CatalogueQuery, CategoryQuery, ChainQuery, ChecklistQuery, CheckQuery, CommentQuery, CommissionEnablerQuery, CommissionQuery, CommitmentEnablerQuery, CommitmentQuery, CompetencyQuery, CompositionEnablerQuery, CompositionQuery, ConferralQuery, ConfigurationQuery, ContactEnablerQuery, ContactQuery, ControllerQuery, ConvocationQuery, CookbookQuery, CourseCatalogQuery, CourseEntryQuery, CourseOfferingQuery, CourseQuery, CourseRegistrationQuery, CourseRequirementQuery, CredentialEntryQuery, CredentialQuery, CreditQuery, CustomerQuery, CyclicEventQuery, CyclicTimePeriodQuery, DeedQuery, DemographicEnablerQuery, DemographicQuery, DepotQuery, DeviceEnablerQuery, DeviceQuery, DictionaryQuery, DirectionQuery, DirectoryEntryQuery, DirectoryQuery, DispatchConstrainerEnablerQuery, DispatchConstrainerQuery, DispatchEnablerQuery, DispatchProcessorEnablerQuery, DispatchProcessorQuery, DispatchQuery, DistributorQuery, DocetQuery, EdgeEnablerQuery, EdgeQuery, EffortQuery, EngineQuery, EngineQuery, EnrollmentQuery, EntryQuery, EntryQuery, EntryQuery, EntryQuery, EventQuery, FamilyQuery, FileQuery, FiscalPeriodQuery, FloorQuery, ForumQuery, FoundryQuery, FrontOfficeQuery, FunctionQuery, GradebookColumnQuery, GradebookColumnSummaryQuery, GradebookQuery, GradeEntryQuery, GradeQuery, GradeSystemQuery, GraphQuery, HierarchyQuery, HoldEnablerQuery, HoldQuery, IdiomQuery, IngredientQuery, InputEnablerQuery, InputQuery, InquestQuery, InquiryEnablerQuery, InquiryQuery, InstallationContentQuery, InstallationQuery, InstructionQuery, IntersectionQuery, InventoryQuery, IssueConstrainerEnablerQuery, IssueConstrainerQuery, IssueEnablerQuery, IssueProcessorEnablerQuery, IssueProcessorQuery, IssueQuery, IssueQuery, ItemQuery, ItemQuery, ItemQuery, ItemQuery, JobConstrainerEnablerQuery, JobConstrainerQuery, JobProcessorEnablerQuery, JobProcessorQuery, JobQuery, JournalEntryQuery, JournalQuery, KeyQuery, LeaseQuery, LessonQuery, LocationQuery, LogEntryQuery, LogEntryQuery, LogQuery, MailboxQuery, MapQuery, MessageQuery, MeterQuery, ModelQuery, ModuleQuery, NodeQuery, ObjectiveBankQuery, ObjectiveQuery, ObstacleEnablerQuery, ObstacleQuery, OfferingConstrainerEnablerQuery, OfferingConstrainerQuery, OfferingQuery, OfficeQuery, OffsetEventEnablerQuery, OffsetEventQuery, OntologyQuery, OrderQuery, OrganizationQuery, OsidCatalogQuery, OsidCompendiumQuery, OsidConstrainerQuery, OsidEffectuatorQuery, OsidEnablerQuery, OsidGovernatorQuery, OsidOperatorQuery, OsidProcessorQuery, OsidRelationshipQuery, OsidRequestQuery, OsidRuleApplicatorQuery, OsidRuleQuery, OublietteQuery, PackageQuery, ParameterProcessorEnablerQuery, ParameterProcessorQuery, ParameterQuery, ParameterQuery, ParticipantQuery, PathQuery, PathQuery, PayerQuery, PaymentQuery, PeriodQuery, PersonQuery, PlanQuery, PollsQuery, PoolConstrainerEnablerQuery, PoolConstrainerQuery, PoolEnablerQuery, PoolProcessorEnablerQuery, PoolProcessorQuery, PoolQuery, PositionQuery, PostEntryQuery, PostQuery, PostQuery, PressQuery, PriceEnablerQuery, PriceQuery, PriceScheduleQuery, ProcedureQuery, ProcessConstrainerEnablerQuery, ProcessConstrainerQuery, ProcessEnablerQuery, ProcessProcessorEnablerQuery, ProcessProcessorQuery, ProcessQuery, ProcessQuery, ProductQuery, ProficiencyQuery, ProfileEntryEnablerQuery, ProfileEntryQuery, ProfileItemQuery, ProfileQuery, ProgramEntryQuery, ProgramOfferingQuery, ProgramQuery, ProjectQuery, ProvisionableEnablerQuery, ProvisionableQuery, ProvisionEnablerQuery, ProvisionQuery, ProvisionReturnQuery, PublisherQuery, QualifierQuery, QuestionQuery, QueueConstrainerEnablerQuery, QueueConstrainerEnablerQuery, QueueConstrainerQuery, QueueConstrainerQuery, QueueEnablerQuery, QueueEnablerQuery, QueueProcessorEnablerQuery, QueueProcessorEnablerQuery, QueueProcessorQuery, QueueProcessorQuery, QueueQuery, QueueQuery, RaceConstrainerEnablerQuery, RaceConstrainerQuery, RaceProcessorEnablerQuery, RaceProcessorQuery, RaceQuery, RealmQuery, ReceiptQuery, RecipeQuery, RecurringEventEnablerQuery, RecurringEventQuery, RegistrationQuery, RegistrationRequestItemQuery, RegistrationRequestQuery, RegistrationTargetQuery, RelationshipEnablerQuery, RelationshipQuery, RelevancyEnablerQuery, RelevancyQuery, RenovationQuery, ReplyQuery, RepositoryQuery, RequestQuery, RequestTransactionQuery, RequisiteQuery, ResourceQuery, ResourceRelationshipQuery, ResponseQuery, ResultQuery, RoomQuery, RouteQuery, RouteSegmentQuery, RuleQuery, SceneQuery, ScheduleQuery, ScheduleSlotQuery, SequenceRuleEnablerQuery, SequenceRuleQuery, SettingQuery, ShipmentQuery, SignalEnablerQuery, SignalQuery, SiteQuery, SpeedZoneEnablerQuery, SpeedZoneQuery, StateQuery, StatisticQuery, StepConstrainerEnablerQuery, StepConstrainerQuery, StepEnablerQuery, StepProcessorEnablerQuery, StepProcessorQuery, StepQuery, StockQuery, StoreQuery, SubjectQuery, SubscriptionEnablerQuery, SubscriptionQuery, SummaryQuery, SupersedingEventEnablerQuery, SupersedingEventQuery, SyllabusQuery, SystemQuery, TermQuery, TextQuery, TimePeriodQuery, TodoProducerQuery, TodoQuery, TriggerEnablerQuery, TriggerQuery, UtilityQuery, ValueEnablerQuery, ValueQuery, VaultQuery, VoteEnablerQuery, VoteQuery, WarehouseQuery, WorkflowEventQuery, WorkQuery, WorkQuery
public interface OsidObjectQuery extends OsidIdentifiableQuery, OsidExtensibleQuery, OsidBrowsableQuery

The OsidObjectQuery is used to assemble search queries. An OsidObjectQuery is available from an OsidSession and defines methods to query for an OsidObject that includes setting a display name and a description. Once the desired parameters are set, the OsidQuery is given to the designated search method. The same OsidQuery returned from the session must be used in the search as the provider may utilize implementation-specific data wiithin the object.

If multiple data elements are set in this interface, the results matching all the given data (eg: AND) are returned.

Any match method inside an OsidObjectQuery may be invoked multiple times. In the case of a match method, each invocation adds an element to an OR expression. Any of these terms may also be negated through the match flag. 

OsidObjectQuery { OsidQuery.matchDisplayName AND (OsidQuery.matchDescription OR OsidObjectQuery.matchDescription)}
OsidObjects allow for the definition of an additonal records and the OsidQuery parallels this mechanism. An interface type of an OsidObject record must also define the corresponding OsidQuery record which is available through query interfaces. Multiple requests of these typed interfaces may return the same underlying object and thus it is only useful to request once.

String searches are described using a string search Type that indicates the type of regular expression or wildcarding encoding. Compatibility with a strings search Type can be tested within this interface.

As with all aspects of OSIDs, nulls cannot be used. Separate tests are available for querying for unset values except for required fields.

An example to find all objects whose name starts with "Fred" or whose name starts with "Barney", but the word "dinosaur" does not appear in the description and not the color is not purple. ColorQuery is a record of the object that defines a color. 

ObjectObjectQuery query;            
  
query = session.getObjectQuery();
query.matchDisplayName("Fred*", wildcardStringMatchType, true);
query.matchDisplayName("Barney*", wildcardStringMatchType, true);
query.matchDescriptionMatch("dinosaur", wordStringMatchType, false);

ColorQuery recordQuery;
recordQuery = query.getObjectRecord(colorRecordType);
recordQuery.matchColor("purple", false);
ObjectList list = session.getObjectsByQuery(query);

  • Method Details

    • matchDisplayName

      void matchDisplayName(String displayName, Type stringMatchType, boolean match)
      Adds a display name to match. Multiple display name matches can be added to perform a boolean OR among them.
      Parameters:
      displayName - display name to match
      stringMatchType - the string match type
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - displayName is not of stringMatchType
      NullArgumentException - displayName or stringMatchType is null
      UnsupportedException - supportsStringMatchType(stringMatchType) is false
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyDisplayName

      void matchAnyDisplayName(boolean match)
      Matches any object with a display name.
      Parameters:
      match - true to match any display name, false to match objects with no display name
      Compliance:
      mandatory - This method must be implemented.

    • clearDisplayNameTerms

      void clearDisplayNameTerms()
      Clears all display name terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDescription

      void matchDescription(String description, Type stringMatchType, boolean match)
      Adds a description name to match. Multiple description matches can be added to perform a boolean OR among them.
      Parameters:
      description - description to match
      stringMatchType - the string match type
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - description is not of stringMatchType
      NullArgumentException - description or stringMatchType is null
      UnsupportedException - supportsStringMatchType(stringMatchType) is false
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyDescription

      void matchAnyDescription(boolean match)
      Matches a description that has any value.
      Parameters:
      match - true to match any description, false to match descriptions with no values
      Compliance:
      mandatory - This method must be implemented.

    • clearDescriptionTerms

      void clearDescriptionTerms()
      Clears all description terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchGenusType

      void matchGenusType(Type genusType, boolean match)
      Sets a Type for querying objects of a given genus. A genus type matches if the specified type is the same genus as the object genus type.
      Parameters:
      genusType - the object genus type
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - genusType is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyGenusType

      void matchAnyGenusType(boolean match)
      Matches an object that has any genus type.
      Parameters:
      match - true to match any genus type, false to match objects with no genus type
      Compliance:
      mandatory - This method must be implemented.

    • clearGenusTypeTerms

      void clearGenusTypeTerms()
      Clears all genus type terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchParentGenusType

      void matchParentGenusType(Type genusType, boolean match)
      Sets a Type for querying objects of a given genus. A genus type matches if the specified type is the same genus as the object or if the specified type is an ancestor of the object genus in a type hierarchy.
      Parameters:
      genusType - the object genus type
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - genusType is null
      Compliance:
      mandatory - This method must be implemented.

    • clearParentGenusTypeTerms

      void clearParentGenusTypeTerms()
      Clears all genus type terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchSubjectId

      void matchSubjectId(Id subjectId, boolean match)
      Matches an object with a relationship to the given subject.
      Parameters:
      subjectId - a subject Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - subjectId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearSubjectIdTerms

      void clearSubjectIdTerms()
      Clears all subject Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubjectQuery

      boolean supportsSubjectQuery()
      Tests if a SubjectQuery is available.
      Returns:
      true if a subject query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSubjectQuery

      SubjectQuery getSubjectQuery()
      Gets the query for a subject. Multiple retrievals produce a nested OR term.
      Returns:
      the subject query
      Throws:
      UnimplementedException - supportsSubjectQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubjectQuery()} is {@code true} .

    • matchAnySubject

      void matchAnySubject(boolean match)
      Matches an object that has any relationship to a Subject .
      Parameters:
      match - true to match any subject, false to match objects with no subjects
      Compliance:
      mandatory - This method must be implemented.

    • clearSubjectTerms

      void clearSubjectTerms()
      Clears all subject terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubjectRelevancyQuery

      boolean supportsSubjectRelevancyQuery()
      Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .
      Returns:
      true if a relevancy entry query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSubjectRelevancyQuery

      RelevancyQuery getSubjectRelevancyQuery()
      Gets the query for a subject relevancy. Multiple retrievals produce a nested OR term.
      Returns:
      the relevancy query
      Throws:
      UnimplementedException - supportsSubjectRelevancyQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubjectRelevancyQuery()} is {@code true} .

    • clearSubjectRelevancyTerms

      void clearSubjectRelevancyTerms()
      Clears all subject relevancy terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchStateId

      void matchStateId(Id stateId, boolean match)
      Matches an object mapped to the given state.
      Parameters:
      stateId - a state Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - stateId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearStateIdTerms

      void clearStateIdTerms()
      Clears all state Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsStateQuery

      boolean supportsStateQuery()
      Tests if a StateQuery is available to provide queries of processed objects.
      Returns:
      true if a state query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getStateQuery

      StateQuery getStateQuery()
      Gets the query for a state. Multiple retrievals produce a nested OR term.
      Returns:
      the journal entry query
      Throws:
      UnimplementedException - supportsStateQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStateQuery()} is {@code true} .

    • matchAnyState

      void matchAnyState(boolean match)
      Matches an object that has any mapping to a State in the given Process .
      Parameters:
      match - true to match any state, false to match objects with no states
      Compliance:
      mandatory - This method must be implemented.

    • clearStateTerms

      void clearStateTerms()
      Clears all state terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCommentId

      void matchCommentId(Id commentId, boolean match)
      Matches an object that has the given comment.
      Parameters:
      commentId - a comment Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - commentId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCommentIdTerms

      void clearCommentIdTerms()
      Clears all comment Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCommentQuery

      boolean supportsCommentQuery()
      Tests if a CommentQuery is available.
      Returns:
      true if a comment query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCommentQuery

      CommentQuery getCommentQuery()
      Gets the query for a comment. Multiple retrievals produce a nested OR term.
      Returns:
      the comment query
      Throws:
      UnimplementedException - supportsCommentQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCommentQuery()} is {@code true} .

    • matchAnyComment

      void matchAnyComment(boolean match)
      Matches an object that has any Comment in the given Book .
      Parameters:
      match - true to match any comment, false to match objects with no comments
      Compliance:
      mandatory - This method must be implemented.

    • clearCommentTerms

      void clearCommentTerms()
      Clears all comment terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchJournalEntryId

      void matchJournalEntryId(Id journalEntryId, boolean match)
      Matches an object that has the given journal entry.
      Parameters:
      journalEntryId - a journal entry Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - journalEntryId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearJournalEntryIdTerms

      void clearJournalEntryIdTerms()
      Clears all journal entry Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsJournalEntryQuery

      boolean supportsJournalEntryQuery()
      Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
      Returns:
      true if a journal entry query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getJournalEntryQuery

      JournalEntryQuery getJournalEntryQuery()
      Gets the query for a journal entry. Multiple retrievals produce a nested OR term.
      Returns:
      the journal entry query
      Throws:
      UnimplementedException - supportsJournalEntryQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsJournalEntryQuery()} is {@code true} .

    • matchAnyJournalEntry

      void matchAnyJournalEntry(boolean match)
      Matches an object that has any JournalEntry in the given Journal .
      Parameters:
      match - true to match any journal entry, false to match objects with no journal entries
      Compliance:
      mandatory - This method must be implemented.

    • clearJournalEntryTerms

      void clearJournalEntryTerms()
      Clears all journal entry terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsStatisticQuery

      boolean supportsStatisticQuery()
      Tests if a StatisticQuery is available to provide statistical queries.
      Returns:
      true if a statistic query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getStatisticQuery

      StatisticQuery getStatisticQuery()
      Gets the query for a statistic. Multiple retrievals produce a nested OR term.
      Returns:
      the statistic query
      Throws:
      UnimplementedException - supportsStatisticQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStatisticQuery()} is {@code true} .

    • matchAnyStatistic

      void matchAnyStatistic(boolean match)
      Matches an object that has any Statistic .
      Parameters:
      match - true to match any statistic, false to match objects with no statistics
      Compliance:
      mandatory - This method must be implemented.

    • clearStatisticTerms

      void clearStatisticTerms()
      Clears all statistic terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCreditId

      void matchCreditId(Id creditId, boolean match)
      Matches an object that has the given credit.
      Parameters:
      creditId - a credit Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - creditId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCreditIdTerms

      void clearCreditIdTerms()
      Clears all credit Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsCreditQuery

      boolean supportsCreditQuery()
      Tests if a CreditQuery is available to provide queries of related acknowledgements.
      Returns:
      true if a credit query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCreditQuery

      CreditQuery getCreditQuery()
      Gets the query for an ackowledgement credit. Multiple retrievals produce a nested OR term.
      Returns:
      the credit query
      Throws:
      UnimplementedException - supportsCreditQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsCreditQuery()} is {@code true} .

    • matchAnyCredit

      void matchAnyCredit(boolean match)
      Matches an object that has any Credit .
      Parameters:
      match - true to match any credit, false to match objects with no credits
      Compliance:
      mandatory - This method must be implemented.

    • clearCreditTerms

      void clearCreditTerms()
      Clears all credit terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchRelationshipId

      void matchRelationshipId(Id relationshipId, boolean match)
      Matches an object that has the given relationship.
      Parameters:
      relationshipId - a relationship Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - relationshipId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearRelationshipIdTerms

      void clearRelationshipIdTerms()
      Clears all relationship Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelationshipQuery

      boolean supportsRelationshipQuery()
      Tests if a RelationshipQuery is available.
      Returns:
      true if a relationship query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRelationshipQuery

      RelationshipQuery getRelationshipQuery()
      Gets the query for relationship. Multiple retrievals produce a nested OR term.
      Returns:
      the relationship query
      Throws:
      UnimplementedException - supportsRelationshipQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelationshipQuery()} is {@code true} .

    • matchAnyRelationship

      void matchAnyRelationship(boolean match)
      Matches an object that has any Relationship .
      Parameters:
      match - true to match any relationship, false to match objects with no relationships
      Compliance:
      mandatory - This method must be implemented.

    • clearRelationshipTerms

      void clearRelationshipTerms()
      Clears all relationship terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchRelationshipPeerId

      void matchRelationshipPeerId(Id peerId, boolean match)
      Matches an object that has a relationship to the given peer Id .
      Parameters:
      peerId - a relationship peer Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - peerId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearRelationshipPeerIdTerms

      void clearRelationshipPeerIdTerms()
      Clears all relationship Id terms.
      Compliance:
      mandatory - This method must be implemented.