com.ibm.jarm.api.property

Class RMFilterElement

  • java.lang.Object
    • com.ibm.jarm.api.property.RMFilterElement


  • public class RMFilterElement
    extends java.lang.Object
    RMFilterElement instances are used in conjunction with a parent RMPropertyFilter to define the type of property values to be returned for various fetch and query results, including recursion control for object-type property values.
    See Also:
    RMPropertyFilter
    • Constructor Summary

      Constructors 
      Constructor and Description
      RMFilterElement(java.lang.Integer maxRecursion, java.lang.Long maxContentSize, java.lang.Boolean levelDependents, RMFilteredPropertyType propertyType, java.lang.Integer pageSize)
      Constructs a new RMFilterElement instance.
      RMFilterElement(java.lang.Integer maxRecursion, java.lang.Long maxContentSize, java.lang.Boolean levelDependents, java.lang.String symbolicNames, java.lang.Integer pageSize)
      Constructs a new RMFilterElement instance.
    • Constructor Detail

      • RMFilterElement

        public RMFilterElement(java.lang.Integer maxRecursion,
                       java.lang.Long maxContentSize,
                       java.lang.Boolean levelDependents,
                       RMFilteredPropertyType propertyType,
                       java.lang.Integer pageSize)
        Constructs a new RMFilterElement instance.
        Parameters:
        maxRecursion - A zero-based Integer that specifies the maximum allowable recursion depth to use when retrieving object-type property relationships. This entry can be null.
        maxContentSize - A Long that specifies the maximum size of content data, in bytes, that can be returned when properties that hold content are retrieved. This entry can be null to use the repository default.
        levelDependents - Specifies whether the recursion level to use when retrieving a dependent object is the same as that of the independent object to which it belongs (true) or one level deeper (false). This entry can be null.
        propertyType - A RMFilteredPropertyType value specifying the type of properties to retrieve. This entry cannot be null.
        pageSize - An Integer that specifies the initial iterator page size used for those properties that return a PageableSet collection value. This entry can be null to use the repository default.
      • RMFilterElement

        public RMFilterElement(java.lang.Integer maxRecursion,
                       java.lang.Long maxContentSize,
                       java.lang.Boolean levelDependents,
                       java.lang.String symbolicNames,
                       java.lang.Integer pageSize)
        Constructs a new RMFilterElement instance.
        Parameters:
        maxRecursion - A zero-based Integer that specifies the maximum allowable recursion depth to use when retrieving object-type property relationships. This entry can be null.
        maxContentSize - A Long that specifies the maximum size of content data, in bytes, that can be returned when properties that hold content are retrieved. This entry can be null to use the repository default.
        levelDependents - Specifies whether the recursion level to use when retrieving a dependent object is the same as that of the independent object to which it belongs (true) or one level deeper (false). This entry can be null.
        symbolicNames - A space-separated list of property symbolic names defining the property values to return. This entry cannot be null nor blank.
        pageSize - An Integer that specifies the initial iterator page size used for those properties that return a PageableSet collection value. This entry can be null to use the repository default.
        See Also:
        RMPropertyName
    • Method Detail

      • getMaxRecursion

        public java.lang.Integer getMaxRecursion()
        Returns the maxRecursion value.
        Returns:
        An Integer value. This entry can be null.
      • getMaxContentSize

        public java.lang.Long getMaxContentSize()
        Returns the maxContentSize value.
        Returns:
        An Integer value. This entry can be null.
      • getLevelDependents

        public java.lang.Boolean getLevelDependents()
        Returns the levelDependents value.
        Returns:
        A Boolean value. This entry can be null.
      • getSymbolicNames

        public java.lang.String getSymbolicNames()
        Returns the symbolicNames string value.
        Returns:
        A String value containing space-separated symbolic names of the properties to return.
      • getPageSize

        public java.lang.Integer getPageSize()
        Returns the pageSize value.
        Returns:
        An Integer value. This entry can be null.

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