com.ibm.jarm.api.meta

Interface RMPropertyDescription

    • Property Summary

      Properties 
      Type Property and Description
      boolean isRMSystem
      Indicates whether or not the property is considered an "RMSystem" property.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      RMCardinality getCardinality()
      The RMCardinality of the property value of a property that is based on this property description.
      RMChoiceList getChoiceList()
      Returns the RMChoiceList, if any, that is assigned to this property description.
      DataType getDataType()
      Returns the DataType describing the data type allowed for the property value of a property that is based on this property description.
      java.lang.String getDescriptiveText()
      Returns any descriptive text for this property description.
      java.lang.String getDisplayName()
      Returns a display label for this property description.
      java.lang.String getId()
      Returns the repository unique identifier for this property description.
      java.lang.String getName()
      Returns a name string for this property description.
      RMPropertySettability getSettability()
      Specifies at what point in its life cycle a property's value can be set for a property that is based on this property description.
      java.lang.String getSymbolicName()
      Returns the locale-independent, symbolic name of the property description.
      boolean isForClassified()
      Indicates whether or not the property is a DoD Classified-specific property.
      boolean isForDeclare()
      Indicates whether or not the property should be involved during an initial record declaration process.
      boolean isHidden()
      Indicates whether or not this property description describes a hidden property.
      boolean isOrderable()
      Indicates whether or not a property that is based on this property description can appear within an ORDER BY clause of an SQL query statement.
      boolean isReadOnly()
      Indicates whether or not this property description describes a read only property.
      boolean isRMSystemProperty()
      Indicates whether or not the property is considered an "RMSystem" property.
      boolean isSearchable()
      Indicates whether or not a property that is based on this property description can be used as part of an SQL query statement's search criteria.
      boolean isSelectable()
      Indicates whether or not a property that is based on this property description can be used as part of an SQL query statement's selection criteria.
      boolean isSystemGenerated()
      Indicates whether or not the value of a property that is based on this property description is automatically generated by the repository.
      boolean isSystemOwned()
      Indicates whether or not the value of a property that is based on this property description is originally created by the repository as opposed to being user-created.
      boolean isValueRequired()
      Indicates whether or not a value is required for a property that is based on this property description.
      boolean requiresUniqueElements()
      Indicates whether or not the values of a multi-valued property that is based on this property description must be unique with respect to each other.
    • Property Detail

      • isRMSystem

        Indicates whether or not the property is considered an "RMSystem" property.
        Returns:
        true if property is an "RMSystem" property.
    • Method Detail

      • getChoiceList

        RMChoiceList getChoiceList()
        Returns the RMChoiceList, if any, that is assigned to this property description. Any assigned choice list must be used to provide candidate values for the property value of any property that is based on this property description.
        Returns:
        A RMChoiceList instance or null if no choice list is assigned to this property description.
      • getDataType

        DataType getDataType()
        Returns the DataType describing the data type allowed for the property value of a property that is based on this property description.
        Returns:
        A DataType instance.
      • getDescriptiveText

        java.lang.String getDescriptiveText()
        Returns any descriptive text for this property description.
        Returns:
        A String value. This entry can be null.
      • getDisplayName

        java.lang.String getDisplayName()
        Returns a display label for this property description.
        Returns:
        A string value.
      • getId

        java.lang.String getId()
        Returns the repository unique identifier for this property description.
        Returns:
        A String value.
      • getName

        java.lang.String getName()
        Returns a name string for this property description.
        Returns:
        A String value.
      • getSettability

        RMPropertySettability getSettability()
        Specifies at what point in its life cycle a property's value can be set for a property that is based on this property description.
        Returns:
        A RMPropertySettability value.
      • getSymbolicName

        java.lang.String getSymbolicName()
        Returns the locale-independent, symbolic name of the property description.
        Returns:
        A String value.
      • isHidden

        boolean isHidden()
        Indicates whether or not this property description describes a hidden property.
        Returns:
        true if hidden, false otherwise.
      • isOrderable

        boolean isOrderable()
        Indicates whether or not a property that is based on this property description can appear within an ORDER BY clause of an SQL query statement.
        Returns:
        true if it can appear, false otherwise.
      • isReadOnly

        boolean isReadOnly()
        Indicates whether or not this property description describes a read only property.
        Returns:
        true if it is read only, false otherwise.
      • isSearchable

        boolean isSearchable()
        Indicates whether or not a property that is based on this property description can be used as part of an SQL query statement's search criteria.
        Returns:
        true if it can be used, false otherwise.
      • isSelectable

        boolean isSelectable()
        Indicates whether or not a property that is based on this property description can be used as part of an SQL query statement's selection criteria.
        Returns:
        true if it can be used, false otherwise.
      • isSystemGenerated

        boolean isSystemGenerated()
        Indicates whether or not the value of a property that is based on this property description is automatically generated by the repository.
        Returns:
        true if is automatically generated, false otherwise.
      • isSystemOwned

        boolean isSystemOwned()
        Indicates whether or not the value of a property that is based on this property description is originally created by the repository as opposed to being user-created.
        Returns:
        true if is repository-created, false if user-created.
      • isValueRequired

        boolean isValueRequired()
        Indicates whether or not a value is required for a property that is based on this property description.
        Returns:
        true if is required, false otherwise.
      • requiresUniqueElements

        boolean requiresUniqueElements()
        Indicates whether or not the values of a multi-valued property that is based on this property description must be unique with respect to each other.
        Returns:
        true if uniqueness is required, false otherwise.
      • isForDeclare

        boolean isForDeclare()
        Indicates whether or not the property should be involved during an initial record declaration process.
        Returns:
        true if property is involved in declaration.
      • isForClassified

        boolean isForClassified()
        Indicates whether or not the property is a DoD Classified-specific property.
        Returns:
        true if property is DoD Classified-specific.
      • isRMSystemProperty

        boolean isRMSystemProperty()
        Indicates whether or not the property is considered an "RMSystem" property.
        Returns:
        true if property is an "RMSystem" property.

© Copyright IBM Corp. 2010, 2013. All Rights Reserved.