topic Element

The topic element conveys all of the information that relates to a single topic, including the associations that the topic participates in.

<tm:topic
    oid="OID"
    version="VERSION"
    psi="VERSION"
    stub="true|false">
  <tm:subjectIdentifiers>
    <tm:locator href="URI"/>
  </tm:subjectIdentifiers>
  <tm:subjectLocators>
    <tm:locator href="URI"/>
  </tm:subjectLocators>
  <tm:sourceLocators>
    <tm:locator href="URI"/>
  </tm:sourceLocators>
  <tm:topicTypes>
    <tm:topicref ... />
  </tm:topicTypes>
  <tm:names>
    <tm:name ... > ... </tm:name>
  </tm:names>
  <tm:occurrences>
    <tm:occurrence ... > ... </tm:occurrence>
  </tm:occurrences>
  <tm:associations>
    <tm:association ... > ... </tm:association>
  </tm:associations>
</tm:topic>
tm:topic

The container for information relating to a single topic.

tm:topic/@oid

TMCore's unique object identifier for this topic. This identifier is unique across all topic map objects managed by the same TMCore instance. This attribute is OPTIONAL.

tm:topic/@version

Specifies the version number for a topic. When received from the web serivce, this attribute specifies the current version number of the topic. When passed in to a web service operation, this attribute specifies the version of the topic that the operation is to be applied to. This attribute is OPTIONAL.

tm:topic/@psi

Identifies the a topic by its subject identifier. This attribute is OPTIONAL and is used on the input into web service operations only. The subject identifiers of a topic received from the web service will only be specified by the tm:locator elements in the tm:subjectIdentifiers child element.

tm:topic/@stub

Indicates if this element contains all of the information about the topic. This attribute is OPTIONAL.

If this attribute is present with the value 'true', then the element contains only stub information about the topic. Stub information is limited to just the topic's identifiers (OID, subject identifiers, source locators and subject locators) and any unscoped names.

If this attribute is not present or it is present with the value 'false', then the topic element contains all of the information about the topic.

tm:topic/tm:subjectIdentifiers

Contains a list of the subject identifiers for this topic. This element is OPTIONAL.

tm:topic/tm:subjectIdentifiers/tm:locator/@href

Contains a single subject identifier URI that is assigned to this topic. This attribute is REQUIRED.

tm:topic/tm:subjectLocators

Contains a list of the subject locators for this topic. This element is OPTIONAL.

tm:topic/tm:subjectLocators/tm:locator/@href

Contains a single subject locator URI assigned to this topic. This attribute is REQUIRED.

tm:topic/tm:sourceLocators

Contains a list of the source locators for this topic. This element is OPTIONAL.

tm:topic/tm:sourceLocators/tm:locator/@href

Contains a single source locator URI assigned to this topic. This attribute is REQUIRED.

tm:topic/tm:topicTypes

Contains a list of tm:topicref elements that reference the topics that define the type(s) for this topic. This element is OPTIONAL.

tm:topic/tm:topicTypes/tm:topicref

References a single topic that is a type for this topic. This element is REQUIRED and REPEATABLE.

tm:topic/tm:names

Contains a list of tm:name elements that define the names assigned to this topic. This element is OPTIONAL.

tm:topic/tm:occurrences

Contains a list of tm:occurrence elements that define the occurrences assigned to this topic. This element is OPTIONAL.

tm:topic/tm:associations

Contains a list of tm:association elements that define the associations in which this topic plays a role. This element is OPTIONAL.