com.plumtree.server
Interface IPTUserGroup

All Superinterfaces:
IPTLocalizable, IPTObject, IPTUnknown

public interface IPTUserGroup
extends IPTObject

IPTUserGroup is the interface representing a portal UserGroup object.


Method Summary
 void AddChildGroups(int iGroupID)
          Adds the indicated group to this group
 void AddChildGroups(int[] iaGroupIDs)
          Adds the indicated groups to this group
 void AddUsers(int iUserIDs)
          Adds the indicated user to this group
 void AddUsers(int[] iaUserIDs)
          Adds the indicated users to this group
 java.lang.String GetAuthenticationGroup()
          Used when synchronizing with external usergroup repositories (e.g.
 int GetAuthenticationSourceID()
          Retrieves the authentication source ID for this group.
 java.lang.String GetMappingAuthName()
          Retrieves the Mapping Auth Name for the group.
 java.lang.String 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).
 void GrantActivityRights(java.lang.Object[] oaActivityIDs)
          Grant the indicated activity rights to members of this group
 IPTQueryResult QueryActivityRights(int nPropIDMask, int nSkipRows, int nMaxRows)
          Returns a QueryResult containing the activity rights granted to members of this group.
 IPTQueryResult QueryAllActivityRights()
          Similar to QueryActivityRights, but returns a QueryResult containing all properties for all activity rights granted to members of this group.
 IPTQueryResult 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.
 IPTQueryResult QueryDirectChildGroups()
          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.
 int QueryDirectChildGroupsCount()
          Returns the number of groups that are direct members of this group.
 IPTQueryResult QueryDirectParentGroups()
          Returns a QueryResult describing the groups that directly contain this group.
 IPTQueryResult QueryFlattenedParentGroups()
          Returns a QueryResult describing the groups that directly or indirectly contain this group.
 IPTQueryResult QueryInheritedActivityRights(int nPropIDMask, int nSkipRows, int nMaxRows)
          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.
 IPTQueryResult QueryUsers()
          Returns an IPTQueryResult describing all users in this group.
 int QueryUsersCount()
          Returns the number of users that are direct members of this group.
 void RemoveAllUsers()
          Removes all users from this group
 void RemoveChildGroups(int iGroupID)
          Removes the indicated group from this group
 void RemoveChildGroups(int[] iaGroupIDs)
          Removes the indicated groups from this group
 void RemoveUsers(int iUserID)
          Removes the indicated user from this group
 void RemoveUsers(int[] iaUserIDs)
          Removes the indicated users from this group
 void RevokeActivityRights(java.lang.Object[] oaActivityIDs)
          Revoke the indicated activity rights from members of this group
 void SetAuthenticationGroup(java.lang.String Value)
          Used when synchronizing with external usergroup repositories (e.g.
 void SetAuthenticationSourceID(int iAuthSourceID)
          Sets the authentication source ID for this group.
 void SetMappingAuthName(java.lang.String strValue)
          Sets the Mapping Auth Name for the group.
 void SetUniqueAuthName(java.lang.String strValue)
          Sets the unique name on the IPTUserGroup object.
 
Methods inherited from interface com.plumtree.server.IPTObject
GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified
 
Methods inherited from interface com.plumtree.server.IPTLocalizable
GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

GetAuthenticationSourceID

public int GetAuthenticationSourceID()
Retrieves the authentication source ID for this group.
Returns:
The authentication source ID.

SetAuthenticationSourceID

public void SetAuthenticationSourceID(int iAuthSourceID)
Sets the authentication source ID for this group. Cannot modify built-in groups.
Parameters:
iAuthSourceID - - The authentication source ID.

GetAuthenticationGroup

public java.lang.String 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.
Returns:
the authentication group associated with this object

SetAuthenticationGroup

public void SetAuthenticationGroup(java.lang.String Value)
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.
Parameters:
Value - the authentication group which should be associated with this object

AddUsers

public void AddUsers(int[] iaUserIDs)
Adds the indicated users to this group
Parameters:
iaUserIDs - a 1D array of ints containing User IDs

AddUsers

public void AddUsers(int iUserIDs)
Adds the indicated user to this group
Parameters:
iUserID - the ID of the User to be added

RemoveUsers

public void RemoveUsers(int[] iaUserIDs)
Removes the indicated users from this group
Parameters:
iaUserIDs - a 1D array of ints containing User IDs

RemoveUsers

public void RemoveUsers(int iUserID)
Removes the indicated user from this group
Parameters:
iUserID - the ID of the User to be removed

RemoveAllUsers

public void RemoveAllUsers()
Removes all users from this group

QueryUsers

public IPTQueryResult QueryUsers()
Returns an IPTQueryResult describing all users in this group. Returned properties include PT_PROPID_OBJECTID, PT_PROPID_NAME, PT_PROPID_DESCRIPTION, PT_PROPID_ISLOCALIZED, PT_PROPID_USER_UNIQUENAME, PT_PROPID_USER_LOGINNAME.
Returns:
the user information, in an IPTQueryResult
See Also:
IPTQueryResult, PT_PROPIDS

GetMappingAuthName

public java.lang.String 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.
Returns:
The mapping auth name.

SetMappingAuthName

public void SetMappingAuthName(java.lang.String strValue)
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.

GetUniqueAuthName

public java.lang.String 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).
Returns:
The unique name in the authentication source.

SetUniqueAuthName

public void SetUniqueAuthName(java.lang.String strValue)
Sets the unique name on the IPTUserGroup object. Used during authentication source synchronization.
Parameters:
strValue - - The unique name in the authentication source.

AddChildGroups

public void AddChildGroups(int[] iaGroupIDs)
Adds the indicated groups to this group
Parameters:
iaGroupIDs - a 1D array of ints containing Group IDs

AddChildGroups

public void AddChildGroups(int iGroupID)
Adds the indicated group to this group
Parameters:
iGroupID - the ID of the group to be added

RemoveChildGroups

public void RemoveChildGroups(int[] iaGroupIDs)
Removes the indicated groups from this group
Parameters:
iaGroupIDs - a 1D array of ints containing Group IDs

RemoveChildGroups

public void RemoveChildGroups(int iGroupID)
Removes the indicated group from this group
Parameters:
iGroupID - the ID of the Group to be removed

QueryDirectChildGroups

public IPTQueryResult QueryDirectChildGroups()
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.
Returns:
the group information, in an IPTQueryResult
See Also:
IPTQueryResult, PT_PROPIDS

GrantActivityRights

public void GrantActivityRights(java.lang.Object[] oaActivityIDs)
Grant the indicated activity rights to members of this group
Parameters:
iaActivityIDs - a 1D array of Objects containing the IDs of the Activity rights to be granted to group members

RevokeActivityRights

public void RevokeActivityRights(java.lang.Object[] oaActivityIDs)
Revoke the indicated activity rights from members of this group
Parameters:
iaActivityIDs - a 1D array of Integers containing the IDs of the Activity rights to be revoked from group members

QueryActivityRights

public IPTQueryResult QueryActivityRights(int nPropIDMask,
                                          int nSkipRows,
                                          int nMaxRows)
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.
Parameters:
nPropIDMask - a bitmask of the properties to be included in the QueryResult, from PT_PROPIDS
nSkipRows - number of rows to skip at the beginning, or 0 for none
nMaxRows - maximum number of rows to return, or -1 for all
Returns:
the QueryResult describing the granted activity rights
See Also:
IPTQueryResult, PT_PROPIDS

QueryAllActivityRights

public IPTQueryResult 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.
Returns:
the QueryResult describing the granted activity rights
See Also:
IPTQueryResult

QueryInheritedActivityRights

public IPTQueryResult QueryInheritedActivityRights(int nPropIDMask,
                                                   int nSkipRows,
                                                   int nMaxRows)
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.
Parameters:
nPropIDMask - a bitmask of the properties to be included in the QueryResult, from PT_PROPIDS
nSkipRows - number of rows to skip at the beginning, or 0 for none
nMaxRows - maximum number of rows to return, or -1 for all
Returns:
the QueryResult describing the granted activity rights
See Also:
IPTQueryResult, PT_PROPIDS

QueryAllInheritedActivityRights

public IPTQueryResult 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.
Returns:
the QueryResult describing the granted activity rights
See Also:
IPTQueryResult

QueryDirectChildGroupsCount

public int 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.
Returns:
the number of child groups

QueryUsersCount

public int QueryUsersCount()
Returns the number of users that are direct members of this group. Does not include users that are members of groups that are in turn members of this group, etc.
Returns:
the number of users

QueryDirectParentGroups

public IPTQueryResult 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.
Returns:
the QueryResult describing the groups

QueryFlattenedParentGroups

public IPTQueryResult 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.
Returns:
the QueryResult describing the groups


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.