public class RMPropertyFilter
extends java.lang.Object
For more detailed information concerning how to use define and use the
RMPropertyFilter
class, see the "Property Filter Concepts" subsection
found under the
Property Concepts
section of the "Developing IBM FileNet P8 applications | Content Engine Java and .NET Developer's Guide" help topic.
Modifier and Type | Field and Description |
---|---|
static RMPropertyFilter |
AllNonObjectPropertySet
A constant
RMPropertyFilter instance that indicates that all non-Object type
properties should be retrieved for the entity in question. |
static RMPropertyFilter |
MinimumPropertySet
A constant
RMPropertyFilter instance that indicates that the default minimum
set of properties should be retrieved for the entity in question. |
Constructor and Description |
---|
RMPropertyFilter()
Constructs a new
RMPropertyFilter instance. |
Modifier and Type | Method and Description |
---|---|
void |
addExcludeProperty(java.lang.String symbolicNames)
Defines one or more properties to be excluded during an entity retrieval or entity refresh.
|
void |
addIncludeProperty(java.lang.Integer maxRecursion,
java.lang.Long maxContentSize,
java.lang.Boolean levelDependents,
java.lang.String symbolicNames,
java.lang.Integer pageSize)
Creates a
RMFilterElement instance defining one or more properties
to include during an entity retrieval or entity refresh and adds the new
RMFilterElement to this RMPropertyFilter instance. |
void |
addIncludeProperty(RMFilterElement filterElement)
Includes properties defined by a
FilterElement instance to be returned
during an entity retrieval or entity refresh. |
void |
addIncludeType(java.lang.Integer maxRecursion,
java.lang.Long maxContentSize,
java.lang.Boolean levelDependents,
RMFilteredPropertyType propertyType,
java.lang.Integer pageSize)
Creates a
RMFilterElement instance defining one or more properties
to include during an entity retrieval or entity refresh. |
java.util.List<java.lang.String> |
getExcludePropertyNames()
Returns a collection of excluded property names.
|
java.util.List<RMFilterElement> |
getIncludeProperties()
Returns a collection of
RMFilterElement that define included properties. |
java.lang.Boolean |
getLevelDependents()
Returns the global
levelDependents value for this RMPropertyFilter . |
java.lang.Long |
getMaxContentSize()
Returns the global
maxContentSize value for this RMPropertyFilter . |
java.lang.Integer |
getMaxRecursion()
Returns the global
maxRecursion value for this RMPropertyFilter . |
java.lang.Integer |
getPageSize()
Returns the global
pageSize value for this RMPropertyFilter . |
void |
setLevelDependents(boolean levelDependents)
Defines a global
levelDependents for the RMPropertyFilter . |
void |
setLevelDependents(java.lang.Boolean levelDependents)
Defines a global
levelDependents for the RMPropertyFilter . |
void |
setMaxContentSize(long maxContentSize)
Defines a global
maxContentSize for the RMPropertyFilter . |
void |
setMaxContentSize(java.lang.Long maxContentSize)
Defines a global
maxContentSize for the PropertyFilter . |
void |
setMaxRecursion(int maxRecursion)
Defines a global
maxRecursion for the RMPropertyFilter . |
void |
setMaxRecursion(java.lang.Integer maxRecursion)
Defines a global
maxRecursion for the RMPropertyFilter . |
void |
setPageSize(int pageSize)
Defines a global
pageSize for the PropertyFilter . |
void |
setPageSize(java.lang.Integer pageSize)
Defines a global
pageSize for the PropertyFilter . |
public static final RMPropertyFilter MinimumPropertySet
RMPropertyFilter
instance that indicates that the default minimum
set of properties should be retrieved for the entity in question.
The actual set of properties returned is entity-type dependent.public static final RMPropertyFilter AllNonObjectPropertySet
RMPropertyFilter
instance that indicates that all non-Object type
properties should be retrieved for the entity in question.
The actual set of properties returned is entity-type dependent.public RMPropertyFilter()
RMPropertyFilter
instance.public void addExcludeProperty(java.lang.String symbolicNames)
addInclude
or addIncludeType
method calls.symbolicNames
- a space-separated list of property symbolic names to exclude.
This entry cannot be null
or blank.public void addIncludeProperty(RMFilterElement filterElement)
FilterElement
instance to be returned
during an entity retrieval or entity refresh.filterElement
- an FilterElement
instance defining properties to include.
This entry cannot be null
.public void addIncludeProperty(java.lang.Integer maxRecursion, java.lang.Long maxContentSize, java.lang.Boolean levelDependents, java.lang.String symbolicNames, java.lang.Integer pageSize)
RMFilterElement
instance defining one or more properties
to include during an entity retrieval or entity refresh and adds the new
RMFilterElement
to this RMPropertyFilter
instance.maxRecursion
- A zero-based Integer
that specifies the maximum
allowable recursion depth to use when retrieving property relationships.
This entry can be null
to use the global default.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 global 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
to use the global default.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 global default.public void addIncludeType(java.lang.Integer maxRecursion, java.lang.Long maxContentSize, java.lang.Boolean levelDependents, RMFilteredPropertyType propertyType, java.lang.Integer pageSize)
RMFilterElement
instance defining one or more properties
to include during an entity retrieval or entity refresh.maxRecursion
- A zero-based Integer
that specifies the maximum
allowable recursion depth to use when retrieving property relationships.
This entry can be null
to use the global default.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 global 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
to use the global default.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 global default.public java.util.List<java.lang.String> getExcludePropertyNames()
List<String>
collection of excluded property symbolic names.
Returns an empty list if no excluded properties have been specified.public java.util.List<RMFilterElement> getIncludeProperties()
RMFilterElement
that define included properties.List
of RMFilterElement
instances representing
properties to include during an object retrieval or refresh.
Returns an empty list if no include properties have been specified.public void setLevelDependents(boolean levelDependents)
levelDependents
for the RMPropertyFilter
.
The levelDependents
value assigned to any individual RMFilterElement
overrides this global value.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
).public void setLevelDependents(java.lang.Boolean levelDependents)
levelDependents
for the RMPropertyFilter
.
The levelDependents
value assigned to any individual RMFilterElement
overrides this global value.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
.public java.lang.Boolean getLevelDependents()
levelDependents
value for this RMPropertyFilter
.Boolean
value. This entry can be null
.public void setMaxRecursion(int maxRecursion)
maxRecursion
for the RMPropertyFilter
.
The maxRecursion
value assigned to any individual RMFilterElement
overrides this global value.maxRecursion
- a zero-based int
that specifies the maximum
allowable recursion depth to use when retrieving property relationships.public void setMaxRecursion(java.lang.Integer maxRecursion)
maxRecursion
for the RMPropertyFilter
.
The maxRecursion
value assigned to any individual RMFilterElement
overrides this global value.maxRecursion
- a zero-based Integer
that specifies the maximum
allowable recursion depth to use when retrieving property relationships.
This entry can be null
.public java.lang.Integer getMaxRecursion()
maxRecursion
value for this RMPropertyFilter
.Integer
value. This entry can be null
.public void setMaxContentSize(long maxContentSize)
maxContentSize
for the RMPropertyFilter
.
The maxContentSize
value assigned to any individual RMFilterElement
overrides this global value.maxContentSize
- a long
that specifies the maximum size of content data,
in bytes, that can be returned when properties that hold content
are retrieved.public void setMaxContentSize(java.lang.Long maxContentSize)
maxContentSize
for the PropertyFilter
.
The maxContentSize
value assigned to any individual RMFilterElement
overrides this global value.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
.public java.lang.Long getMaxContentSize()
maxContentSize
value for this RMPropertyFilter
.Long
value. This entry can be null
.public void setPageSize(int pageSize)
pageSize
for the PropertyFilter
.
The pageSize
value assigned to any individual RMFilterElement
overrides this global value.pageSize
- An int
that specifies the global initial iterator page size
used for those properties that return a PageableSet
collection value.public void setPageSize(java.lang.Integer pageSize)
pageSize
for the PropertyFilter
.
The pageSize
value assigned to any individual RMFilterElement
overrides this global value.pageSize
- An Integer
that specifies the global initial iterator page size
used for those properties that return a PageableSet
collection value. This entry can be null
.public java.lang.Integer getPageSize()
pageSize
value for this RMPropertyFilter
.Integer
value. This entry can be null
.© Copyright IBM Corp. 2010, 2013. All Rights Reserved.