Interface EbXMLSlotList

All Known Subinterfaces:
EbXMLAdhocQueryRequest<E>, EbXMLAssociation, EbXMLClassification, EbXMLExtrinsicObject, EbXMLProvideAndRegisterDocumentSetRequest<E>, EbXMLRegistryObject, EbXMLRegistryPackage, EbXMLRemoveMetadataRequest<E>, EbXMLSubmitObjectsRequest<E>
All Known Implementing Classes:
EbXMLAdhocQueryRequest30, EbXMLAssociation30, EbXMLClassification30, EbXMLExtrinsicObject30, EbXMLProvideAndRegisterDocumentSetRequest30, EbXMLRegistryObject30, EbXMLRegistryPackage30, EbXMLRemoveMetadataRequest30, EbXMLSlotList30, EbXMLSubmitObjectsRequest30

public interface EbXMLSlotList
Provides access to slots and their values.
Author:
Jens Riemschneider
  • Method Details

    • getSlots

      List<EbXMLSlot> getSlots()
      Returns:
      the complete list of all slots.
    • getSlots

      List<EbXMLSlot> getSlots(String slotName)
      Returns a filtered list of the slots.
      Parameters:
      slotName - name of the slots.
      Returns:
      the list of slots named with the given slot name.
    • addSlot

      void addSlot(String slotName, String... slotValues)
      Adds a slot with a list of values.
      Parameters:
      slotName - the slot name.
      slotValues - the slot values. The slot will not be created if this parameter is empty or null.
    • getSlotValues

      List<String> getSlotValues(String slotName)
      Gets the values of a slot.
      Parameters:
      slotName - the name of the slot. It is expected that the name is only used for a single slot. Use getSlots(String) if it is possible that the name is used multiple times.
      Returns:
      the list of slot values.
    • getSingleSlotValue

      String getSingleSlotValue(String slotName)
      Gets a single slot value.
      Parameters:
      slotName - the name of the slot. It is expected that the name is only used for a single slot. Use getSlots(String) if it is possible that the name is used multiple times.
      Returns:
      the first slot value. Other slot values are ignored. Can be null if the slot does not exist, has no slot values or the value is null.