Public Instance Methods
 AddChildGroups | Overloaded. Adds the indicated groups to this group |
| AddUsers | Overloaded. Adds the indicated users to this group as static members. |
| GetAuthenticationGroup | Used when synchronizing with external usergroup repositories (e.g. LDAP.) Each external repository is associated with a unique group name, so that users and groups from different repositories don't have naming conflicts. |
| GetAuthenticationSourceID | Retrieves the authentication source ID for this group. |
| GetDynamicMembershipRule | |
| GetMappingAuthName | Retrieves the Mapping Auth Name for the group. The Mapping Auth Name is used with groups that are synchronized from an external authentication source, and is specific to the Authentication Source Provider. It maps the group name used in ACL sync agents. |
| GetUniqueAuthName | Returns the unique name for this group in the authentication source from which the group was synced (e.g., the unique name for the group in LDAP). |
| GrantActivityRights | Grant the indicated activity rights to members of this group |
| PreviewDynamicMembershipRule | Returns an IPTQueryResult that shows what users match the given IPTFilter. This function does not update the dynamic members of this group. Because the search for matching users is done in real-time, this function may take some time to return related users. NOTE: If this is a remote group, a PTException of type PT_RESULTCODES.PT_E_USERGROUP_IS_REMOTE will be thrown. Returned properties include PT_PROPID_OBJECTID, PT_PROPID_NAME, PT_PROPID_DESCRIPTION, PT_PROPID_ISLOCALIZED, PT_PROPID_USER_UNIQUENAME, PT_PROPID_USER_LOGINNAME. |
| QueryActivityRights | Returns a QueryResult containing the activity rights granted to members of this group. This does NOT include any activity rights inherited from groups to which this group belongs. |
| QueryAllActivityRights | Similar to QueryActivityRights, but returns a QueryResult containing all properties for all activity rights granted to members of this group. This does NOT include any activity rights inherited from groups to which this group belongs. |
| QueryAllInheritedActivityRights | Similar to QueryInheritedActivityRights, but returns a QueryResult containing all properties for all activity rights granted to members of this group, including those that were obtained through groups that this group is a member of. This includes ALL activity rights granted to users, whether they are through THIS group, through PARENT groups, through parents of parents, etc. |
| QueryDirectChildGroups | Overloaded. Returns an IPTQueryResult describing all groups in this group (excluding the groups that are in subgroups- this function returns ONLY the groups that are direct members of this group.) Returned properties include PT_PROPID_OBJECTID, PT_PROPID_NAME, PT_PROPID_ISLOCALIZED, PT_PROPID_USERGROUP_UNIQUENAME. |
| QueryDirectChildGroupsCount | Returns the number of groups that are direct members of this group. Does not include groups that are members of groups that are in turn members of this group, etc. |
| QueryDirectParentGroups | Returns a QueryResult describing the groups that directly contain this group. Does NOT include groups that contain this group indirectly, through a third group. Returned properties include PT_PROPID_OBJECTID, PT_PROPID_NAME, PT_PROPID_ISLOCALIZED. |
| QueryFlattenedParentGroups | Returns a QueryResult describing the groups that directly or indirectly contain this group. DOES include groups that contain this group indirectly, through a third group. Returned properties include PT_PROPID_OBJECTID, PT_PROPID_NAME, PT_PROPID_ISLOCALIZED. |
| QueryInheritedActivityRights | Returns a QueryResult containing the activity rights granted to members of this group, including those that were obtained through groups that this group is a member of. This includes ALL activity rights granted to users, whether they are through THIS group, through PARENT groups, through parents of parents, etc. |
| QueryUsers | Overloaded. Returns the direct user members of this group. Allows one to distinguish between dynamic and static memberships, or return both. Returned properties include PT_PROPID_OBJECTID, PT_PROPID_NAME, PT_PROPID_DESCRIPTION, PT_PROPID_ISLOCALIZED, PT_PROPID_USER_UNIQUENAME, PT_PROPID_USER_LOGINNAME.
NOTE: providing a value of true for both bIncludeDynamicMembers and bIncludeStaticMembers will return all memberships for this group. |
| QueryUsersCount | Overloaded. Returns the number of users that are direct static members of this group. Does not include users that are members of groups that are in turn members of this group, etc. This function only returns users that are static members. Use the QueryUsersCount(boolean, boolean) override to get dynamic memberships as well. |
| RemoveAllUsers | Removes all users from this group that have static memberships. |
| RemoveChildGroups | Overloaded. Removes the indicated groups from this group |
| RemoveUsers | Overloaded. Removes the indicated users from this group as static members. |
| RevokeActivityRights | Revoke the indicated activity rights from members of this group |
| SetAuthenticationGroup | Used when synchronizing with external usergroup repositories (e.g. LDAP.) Each external repository is associated with a unique group name, so that users and groups from different repositories don't have naming conflicts. |
| SetAuthenticationSourceID | Sets the authentication source ID for this group. Cannot modify built-in groups. |
| SetDynamicMembershipRule | Sets the dynamic membership rule to be used for this group. Once set, the dynamic memberships rule will be assessed by the Dynamic Membership Update Agent periodically. To force an update of this group's dynamic memeberships, see UpdateDynamicMembers().To clear all dynamic memberships for this group, set the rule to null and store the group. Finally, call UpdateDynamicMembers() to clear the dynamic memberships. NOTE: If this is a remote group, a PTException of type PT_RESULTCODES.PT_E_USERGROUP_IS_REMOTE will be thrown. |
| SetMappingAuthName | Sets the Mapping Auth Name for the group. The Mapping Auth Name is used with groups that are synchronized from an external authentication source, and is specific to the Authentication Source Provider. It maps the group name used in ACL sync agents. |
| SetUniqueAuthName | Sets the unique name on the IPTUserGroup object. Used during authentication source synchronization. |
| UpdateDynamicMembers | Reconciles the dynamic members of this group with those that match the current dynamic membership rule. If users no longer match this rule, they will be removed as dynamic members. If they are also listed as static members, this membership will be maintained. New users that match the rule will become dynamic members. All changes are persisted to the database in real-time, no store is necessary after calling this function. NOTE: A PTObjectLock should not be held against this object when calling this function. If a lock is a held, an Exception will be thrown. NOTE: If this is a remote group, a PTException of type PT_RESULTCODES.PT_E_USERGROUP_IS_REMOTE will be thrown. |
See Also
IPTUserGroup Interface | com.plumtree.server Namespace