Package com.ptc.core.meta.container.common

Interface ConstraintSummary

All Known Subinterfaces:
AttributeTypeSummary
All Known Implementing Classes:
DefaultAttributeTypeSummary
public interface ConstraintSummary
Summarizes the constraint information for an attribute. The constraint summary information can vary depending on the OperationIdentifier used when retrieving the constraints. That each constraint summary is specific to the operation it was retrieved for. Many constraints are only enforced for create/update operations. As a result many of these methods will return different results for the same attribute when the constraint summary is retrieved for a create operation vs. a display operation.
See Also:

  • Method Details

    • getCardinalitySet

      DataSet getCardinalitySet()
      Gets the set containing the cardinality constraint info (e.g. maximum, minimum, etc. number of values) for this attribute.

      Supported API: true
      Returns:
      The cardinality constraint info for this attribute.

    • getMinCardinality

      int getMinCardinality()
      Gets the minimum cardinality (i.e. the minimum number of values allowed) for this attribute.

      Supported API: true
      Returns:
      The minimum number of values allowed for this attribute.

    • getMaxCardinality

      int getMaxCardinality()
      Gets the maximum cardinality (i.e. the maximum number of values allowed) for this attribute.

      Supported API: true
      Returns:
      The maximum number of values allowed for this attribute.

    • getLegalValueSet

      DataSet getLegalValueSet()
      Key for the set of legal values for the attribute. A null value for this key signifies that (virtually) any value is legal. An empty set signifies that no values are legal. A populated set signifies the legal values.

      Supported API: true
      Returns:
      The set of legal values for the attribute.

    • isRequired

      boolean isRequired()
      Whether or not a value is required for this attribute.

      Supported API: true
      Returns:
      Whether or not a value is required for this attribute.

    • isEditable

      boolean isEditable()
      Whether or not the attributes value(s) can be edited.

      Supported API: true
      Returns:
      Whether or not the attributes value(s) can be edited.

    • isHidden

      boolean isHidden()
      Whether or not this attribute should be hidden.

      Supported API: true
      Returns:
      Whether or not this attribute should be hidden.

    • isServerAssigned

      boolean isServerAssigned()
      Whether or not the attributes value(s) are assigned by the server.

      Supported API: true
      Returns:
      Whether or not the attributes value(s) are assigned by the server.

    • isValueHidden

      boolean isValueHidden()
      Whether or not this attributes value(s) should be hidden.

      Supported API: true
      Returns:
      Whether or not this attributes value(s) should be hidden.

    • requiresNoDuplicateValues

      boolean requiresNoDuplicateValues()
      Returns "true" if duplicates are prohibited in this attributes's set of values on any individual business object.

      Supported API: true
      Returns:
      "true" if duplicates are prohibited in this attributes's set of values on any individual business object.

    • getStringLengthSet

      DataSet getStringLengthSet()


      Supported API: true
      Returns:

    • getMinStringLength

      int getMinStringLength()
      The minimum number of characters the attributes value(s) can be.

      Supported API: true
      Returns:
      The minimum number of characters the attributes value(s) can be.

    • getMaxStringLength

      int getMaxStringLength()
      The maximum number of characters the attributes value(s) can be.

      Supported API: true
      Returns:
      The maximum number of characters the attributes value(s) can be.

    • getStringByteLengthSet

      DataSet getStringByteLengthSet()


      Supported API: true
      Returns:

    • getMinStringByteLength

      int getMinStringByteLength()
      The minimum number of bytes the attributes value(s) can be.

      Supported API: true
      Returns:
      The minimum number of bytes the attributes value(s) can be.

    • getMaxStringByteLength

      int getMaxStringByteLength()
      The maximum number of bytes the attributes value(s) can be.

      Supported API: true
      Returns:
      The maximum number of bytes the attributes value(s) can be.