Skip navigation links

oracle.iam.rm.server_api
Class HierarchyParentFilterCriterion

java.lang.Object
oracle.iam.rm.server_api.FilterCriterion
oracle.iam.rm.server_api.HierarchyParentFilterCriterion

All Implemented Interfaces:

java.io.Serializable

public class HierarchyParentFilterCriterion

extends FilterCriterion

A filter that walks up a hierarchy, effectively allowing joins to parent hierarchy members in result filtering.

See Also:

Serialized Form

Constructor Summary

HierarchyParentFilterCriterion(java.lang.String objectTypeId, java.lang.String hierarchyId, boolean recursive)
Creates a new HierarchyParentFilterCriterion instance that includes all objects in the "active" part of the hierarchy.

HierarchyParentFilterCriterion(java.lang.String objectTypeId, java.lang.String hierarchyId, java.lang.String foreignObjectTypeId, boolean recursive, FilterCriterion foreignObjectFilter)
Creates a new HierarchyParentFilterCriterion instance with the provided filter criteria.

Method Summary

FilterCriterion	getForeignObjectFilter() Gets the filter criterion applied to the parent object in the hierarchy.
java.lang.String	getForeignObjectTypeId() Gets the object type of the parent object in the hierarchy.
java.lang.String	getHierarchyId() Gets the ID of the hierarchy.
java.lang.String	getObjectTypeId() Gets the type of the filtered object.
boolean	isRecursive() Indicates whether the filter is recursive.
boolean	isRootMode() Indicates whether the filter is starting from the hierarchy root.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HierarchyParentFilterCriterion

public HierarchyParentFilterCriterion(java.lang.String objectTypeId,
                                      java.lang.String hierarchyId,
                                      java.lang.String foreignObjectTypeId,
                                      boolean recursive,
                                      FilterCriterion foreignObjectFilter)

Creates a new HierarchyParentFilterCriterion instance with the provided filter criteria.

Parameters:

objectTypeId - object type of the filtered object. Must not be null.

hierarchyId - ID of the hierarchy. Must not be null.

foreignObjectTypeId - object type of the parent object in the hierarchy. Must not be null.

recursive - either true if the filter is recursive or false if not.

foreignObjectFilter - filter criterion to apply to any parent object in the hierarchy. Must not be null.

HierarchyParentFilterCriterion

public HierarchyParentFilterCriterion(java.lang.String objectTypeId,
                                      java.lang.String hierarchyId,
                                      boolean recursive)

Creates a new HierarchyParentFilterCriterion instance that includes all objects in the "active" part of the hierarchy.

Parameters:

objectTypeId - object type of the filtered object. Must not be null.

hierarchyId - ID of the hierarchy. Must not be null.

recursive - either true if the filter is recursive or false if not.

Method Detail

getForeignObjectFilter

public FilterCriterion getForeignObjectFilter()

Gets the filter criterion applied to the parent object in the hierarchy.

Returns:

FilterCriterion applied to the parent object.

getForeignObjectTypeId

public java.lang.String getForeignObjectTypeId()

Gets the object type of the parent object in the hierarchy.

Returns:

String representing the object type of the parent object.

getHierarchyId

public java.lang.String getHierarchyId()

Gets the ID of the hierarchy.

Returns:

String representing this hierarchy's ID.

getObjectTypeId

public java.lang.String getObjectTypeId()

Gets the type of the filtered object.

Returns:

String representing the object type of the filtered object.

isRecursive

public boolean isRecursive()

Indicates whether the filter is recursive.

Returns:

Boolean true if the filter is recursive, otherwise false.

isRootMode

public boolean isRootMode()

Indicates whether the filter is starting from the hierarchy root.

Returns:

Boolean true if the filter is starting from the hierarchy root, otherwise false.

Skip navigation links