Package wt.facade.persistedcollection

Class PersistedCollectionMemberSelector

java.lang.Object
wt.facade.persistedcollection.PersistedCollectionMemberSelector
All Implemented Interfaces:
Serializable
public final class PersistedCollectionMemberSelector extends Object implements Serializable
Class used for selection options by PersistedCollectionService get member APIs.

Supported API: true

Extendable: false
See Also:

  • Constructor Details

    • PersistedCollectionMemberSelector

      public PersistedCollectionMemberSelector()
      Construct default instance.

      Supported API: true

    • PersistedCollectionMemberSelector

      public PersistedCollectionMemberSelector(PersistedCollectionHolder holder)
      Construct PersistedCollectionMemberSelector.

      Supported API: true
      Parameters:
      holder - PersistedCollectionHolder object.

    • PersistedCollectionMemberSelector

      public PersistedCollectionMemberSelector(PersistedCollectionHolder holder, Boolean haveReadAccess)
      Construct PersistedCollectionMemberSelector.

      Supported API: true
      Parameters:
      holder - PersistedCollectionHolder object.
      haveReadAccess - Set true to return only members having READ access, false to return only members not included when set to true, or null (default) to skip access check and return all members.

    • PersistedCollectionMemberSelector

      public PersistedCollectionMemberSelector(PersistedCollectionHolder holder, Boolean haveReadAccess, PersistedCollectionHolder nestingHolder)
      Construct PersistedCollectionMemberSelector.

      Supported API: true
      Parameters:
      holder - PersistedCollectionHolder object.
      haveReadAccess - Set true to return only members having READ access, false to return only members not included when set to true, or null (default) to skip access check and return all members.
      nestingHolder - PersistedCollectionHolder object that contains the holder as a nested member (may be null). This allows a frozen nesting holder to obtain members from the frozen snapshot of the holder.

    • PersistedCollectionMemberSelector

      public PersistedCollectionMemberSelector(PersistedCollectionHolder holder, Boolean haveReadAccess, PersistedCollectionHolder nestingHolder, Boolean isFilteredOut)
      Construct PersistedCollectionMemberSelector.

      Supported API: true
      Parameters:
      holder - PersistedCollectionHolder object.
      haveReadAccess - Set true to return only members having READ access, false to return only members not included when set to true, or null (default) to skip access check and return all members.
      nestingHolder - PersistedCollectionHolder object that contains the holder as a nested member (may be null). This allows a frozen nesting holder to obtain members from the frozen snapshot of the holder.
      isFilteredOut - Set true to return only members that are filtered out of the collection, false to return only members that are not filtered out of the collection, or null (default) to return all members and their filter states (i.e., members are returned using PersistedCollectionReference objects that carry the filter state).

    • PersistedCollectionMemberSelector

      public PersistedCollectionMemberSelector(PersistedCollectionHolder holder, Boolean haveReadAccess, PersistedCollectionHolder nestingHolder, Boolean isFilteredOut, boolean getFilterStates)
      Construct PersistedCollectionMemberSelector.

      Supported API: true
      Parameters:
      holder - PersistedCollectionHolder object.
      haveReadAccess - Set true to return only members having READ access, false to return only members not included when set to true, or null (default) to skip access check and return all members.
      nestingHolder - PersistedCollectionHolder object that contains the holder as a nested member (may be null). This allows a frozen nesting holder to obtain members from the frozen snapshot of the holder.
      isFilteredOut - Set true to return only members that are filtered out of the collection, false to return only members that are not filtered out of the collection, or null (default) to return all members and their filter states (i.e., members are returned using PersistedCollectionReference objects that carry the filter state).
      getFilterStates - Set true to return filter state information with members, or false (default) to return only the members. When true, members will be returned using PersistedCollectionReference objects that hold filter states. When false, standard ObjectReferences are used. This option may only be used by server-side callers. Client-side callers will always receive ObjectReferences.

  • Method Details

    • getHolder

      public PersistedCollectionHolder getHolder()
      Return holder this PersistedCollectionMemberSelector instance was created for.

      Supported API: true

    • setHolder

      public void setHolder(PersistedCollectionHolder holder)
      Set PersistedCollectionMemberSelector holder object.

      Supported API: true
      Parameters:
      holder - PersistedCollectionHolder object.

    • getHaveReadAccess

      public Boolean getHaveReadAccess()
      Return value of control for READ access checks for the current principal.

      Supported API: true

    • setHaveReadAccess

      public void setHaveReadAccess(Boolean haveReadAccess)
      Set value of control for READ access checks for the current principal.

      Supported API: true
      Parameters:
      haveReadAccess - Set true to return only members having READ access, false to return only members not included when set to true, or null (default) to skip access check and return all members.

    • getNestingHolder

      public PersistedCollectionHolder getNestingHolder()
      Return context nesting holder containing the holder as either a direct or indirect nested member.

      Supported API: true

    • setNestingHolder

      public void setNestingHolder(PersistedCollectionHolder nestingHolder)
      Set context nesting holder containing the holder as either a direct or indirect nested member.

      Supported API: true
      Parameters:
      nestingHolder - PersistedCollectionHolder object that contains the holder as a nested member (may be null). This allows a frozen nesting holder to obtain members from the frozen snapshot of the holder.

    • getFilteredOut

      public Boolean getFilteredOut()
      Return value of control for soft filtered members.

      Supported API: true

    • setFilteredOut

      public void setFilteredOut(Boolean isFilteredOut)
      Set value of control for soft filtered members (ignored when soft filtering information is not stored for the holder).

      Supported API: true
      Parameters:
      isFilteredOut - Set true to return only members that are filtered out of the collection, false to return only members that are not filtered out of the collection, or null (default) to return all members and their filter states (i.e., members are returned using PersistedCollectionReference objects that carry the filter state).

    • getFilterStates

      public boolean getFilterStates()
      Return value of control for returning filter state information with members.

      Supported API: true

    • setFilterStates

      public void setFilterStates(boolean getFilterStates)
      Set value of control for returning filter state information with members.

      Supported API: true
      Parameters:
      getFilterStates - Set true to return filter state information with members, or false (default) to return only the members. When true, members will be returned using PersistedCollectionReference objects that hold filter states. When false, standard ObjectReferences are used. This option may only be used by server-side callers. Client-side callers will always receive ObjectReferences.