|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
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 |
public int GetAuthenticationSourceID()
public void SetAuthenticationSourceID(int iAuthSourceID)
iAuthSourceID - - The authentication source ID.public java.lang.String GetAuthenticationGroup()
public void SetAuthenticationGroup(java.lang.String Value)
Value - the authentication group which should be associated with
this objectpublic void AddUsers(int[] iaUserIDs)
iaUserIDs - a 1D array of ints containing User IDspublic void AddUsers(int iUserIDs)
iUserID - the ID of the User to be addedpublic void RemoveUsers(int[] iaUserIDs)
iaUserIDs - a 1D array of ints containing User IDspublic void RemoveUsers(int iUserID)
iUserID - the ID of the User to be removedpublic void RemoveAllUsers()
public IPTQueryResult QueryUsers()
IPTQueryResult,
PT_PROPIDSpublic java.lang.String GetMappingAuthName()
public void SetMappingAuthName(java.lang.String strValue)
public java.lang.String GetUniqueAuthName()
public void SetUniqueAuthName(java.lang.String strValue)
strValue - - The unique name in the authentication source.public void AddChildGroups(int[] iaGroupIDs)
iaGroupIDs - a 1D array of ints containing Group IDspublic void AddChildGroups(int iGroupID)
iGroupID - the ID of the group to be addedpublic void RemoveChildGroups(int[] iaGroupIDs)
iaGroupIDs - a 1D array of ints containing Group IDspublic void RemoveChildGroups(int iGroupID)
iGroupID - the ID of the Group to be removedpublic IPTQueryResult QueryDirectChildGroups()
IPTQueryResult,
PT_PROPIDSpublic void GrantActivityRights(java.lang.Object[] oaActivityIDs)
iaActivityIDs - a 1D array of Objects containing the IDs
of the Activity rights to be granted to group memberspublic void RevokeActivityRights(java.lang.Object[] oaActivityIDs)
iaActivityIDs - a 1D array of Integers containing the IDs of the
Activity rights to be revoked from group members
public IPTQueryResult QueryActivityRights(int nPropIDMask,
int nSkipRows,
int nMaxRows)
nPropIDMask - a bitmask of the properties to be included in the
QueryResult, from PT_PROPIDSnSkipRows - number of rows to skip at the beginning, or 0 for nonenMaxRows - maximum number of rows to return, or -1 for allIPTQueryResult,
PT_PROPIDSpublic IPTQueryResult QueryAllActivityRights()
IPTQueryResult
public IPTQueryResult QueryInheritedActivityRights(int nPropIDMask,
int nSkipRows,
int nMaxRows)
nPropIDMask - a bitmask of the properties to be included in the
QueryResult, from PT_PROPIDSnSkipRows - number of rows to skip at the beginning, or 0 for nonenMaxRows - maximum number of rows to return, or -1 for allIPTQueryResult,
PT_PROPIDSpublic IPTQueryResult QueryAllInheritedActivityRights()
IPTQueryResultpublic int QueryDirectChildGroupsCount()
public int QueryUsersCount()
public IPTQueryResult QueryDirectParentGroups()
public IPTQueryResult QueryFlattenedParentGroups()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||