|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTUserGroup
IPTUserGroup is the interface representing a portal UserGroup object. UseGroups can contain both users and groups. User memberships are either static or dynamic. The former are manipulated directly via the IPTUserGroup API. The later are based on rules, e.g. 'Country' contains 'USA', and are assessed by the Dynamic Membership Agent. The rule is specified using an IPTFilter and the IPTUserGroup API.
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 as a static member. |
void |
AddUsers(int[] iaUserIDs)
Adds the indicated users to this group as static members. |
java.lang.String |
GetAuthenticationGroup()
Used when synchronizing with external usergroup repositories (e.g. |
int |
GetAuthenticationSourceID()
Retrieves the authentication source ID for this group. |
IPTFilter |
GetDynamicMembershipRule()
Returns the IPTFilter describing this group's dynamic membership rule. |
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 |
PreviewDynamicMembershipRule(IPTFilter pRules)
Returns an IPTQueryResult that shows what users match the given IPTFilter. |
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. |
IPTQueryResult |
QueryDirectChildGroups(int nMaxRows,
int nRowsToSkip)
Returns an IPTQueryResult describing a portion of groups in this group, indicated by nMaxRows and nRowsToSkip (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 static users in this group. |
IPTQueryResult |
QueryUsers(boolean bIncludeDynamicMembers,
boolean bIncludeStaticMembers)
Returns the direct user members of this group. |
IPTQueryResult |
QueryUsers(boolean bIncludeDynamicMembers,
boolean bIncludeStaticMembers,
int nMaxRows,
int nRowsToSkip)
Returns a portion of the direct user members of this group, indicated by nMaxRows and nRowsToSkip. |
int |
QueryUsersCount()
Returns the number of users that are direct static members of this group. |
int |
QueryUsersCount(boolean bIncludeDynamicMembers,
boolean bIncludeStaticMembers)
Returns the number of users that are direct members of this group. |
void |
RemoveAllUsers()
Removes all users from this group that have static memberships. |
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 as a static member. |
void |
RemoveUsers(int[] iaUserIDs)
Removes the indicated users from this group as static members. |
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 |
SetDynamicMembershipRule(IPTFilter pRules)
Sets the dynamic membership rule to be used 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. |
void |
UpdateDynamicMembers()
Reconciles the dynamic members of this group with those that match the current dynamic membership rule. |
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 |
Methods inherited from interface com.plumtree.server.IPTServerContext |
---|
GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, GetSettings, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject |
Methods inherited from interface com.plumtree.server.IPTStorable |
---|
Store |
Method Detail |
---|
int GetAuthenticationSourceID()
void SetAuthenticationSourceID(int iAuthSourceID)
iAuthSourceID
- - The authentication source ID.java.lang.String GetAuthenticationGroup()
void SetAuthenticationGroup(java.lang.String Value)
Value
- the authentication group which should be associated with
this objectvoid AddUsers(int[] iaUserIDs)
iaUserIDs
- a 1D array of ints containing User IDsvoid AddUsers(int iUserIDs)
iUserID
- the ID of the User to be addedvoid RemoveUsers(int[] iaUserIDs)
iaUserIDs
- a 1D array of ints containing User IDsvoid RemoveUsers(int iUserID)
iUserID
- the ID of the User to be removedvoid RemoveAllUsers()
IPTQueryResult QueryUsers()
QueryUsers(boolean, boolean)
override to get dynamic memberships
as well.
IPTQueryResult
,
PT_PROPIDS
java.lang.String GetMappingAuthName()
void SetMappingAuthName(java.lang.String strValue)
java.lang.String GetUniqueAuthName()
void SetUniqueAuthName(java.lang.String strValue)
strValue
- - The unique name in the authentication source.void AddChildGroups(int[] iaGroupIDs)
iaGroupIDs
- a 1D array of ints containing Group IDsvoid AddChildGroups(int iGroupID)
iGroupID
- the ID of the group to be addedvoid RemoveChildGroups(int[] iaGroupIDs)
iaGroupIDs
- a 1D array of ints containing Group IDsvoid RemoveChildGroups(int iGroupID)
iGroupID
- the ID of the Group to be removedIPTQueryResult QueryDirectChildGroups()
IPTQueryResult
,
PT_PROPIDS
IPTQueryResult QueryDirectChildGroups(int nMaxRows, int nRowsToSkip)
nMaxRows
- - maximum number of child groups returned by the querynRowsToSkip
- - number of child groups at the start of the result set to skip
IPTQueryResult
,
PT_PROPIDS
void GrantActivityRights(java.lang.Object[] oaActivityIDs)
iaActivityIDs
- a 1D array of Objects containing the IDs
of the Activity rights to be granted to group membersvoid RevokeActivityRights(java.lang.Object[] oaActivityIDs)
iaActivityIDs
- a 1D array of Integers containing the IDs of the
Activity rights to be revoked from group membersIPTQueryResult 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 all
IPTQueryResult
,
PT_PROPIDS
IPTQueryResult QueryAllActivityRights()
IPTQueryResult
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 all
IPTQueryResult
,
PT_PROPIDS
IPTQueryResult QueryAllInheritedActivityRights()
IPTQueryResult
int QueryDirectChildGroupsCount()
int QueryUsersCount()
QueryUsersCount(boolean, boolean)
override to get dynamic
memberships as well.
int QueryUsersCount(boolean bIncludeDynamicMembers, boolean bIncludeStaticMembers)
true
for both bIncludeDynamicMembers
and
bIncludeStaticMembers
will return all memberships for this group.
bIncludeDynamicMembers
- - true
to include dynamic memberships, false
to exclude thembIncludeStaticMembers
- - true
to include static memberships, false
to exclude them
IPTQueryResult QueryDirectParentGroups()
IPTQueryResult QueryFlattenedParentGroups()
void SetDynamicMembershipRule(IPTFilter pRules)
UpdateDynamicMembers()
.null
and store the group. Finally, call
UpdateDynamicMembers()
to clear the dynamic memberships.
pRules
- a valid IPTFilter that describes the dynamic membership
criteria to evaluate. Pass null
to clear the rule.IPTFilter GetDynamicMembershipRule()
SetDynamicMembershipRule(IPTFilter)
. Finally the object
should be stored and unlocked.
null
IPTQueryResult QueryUsers(boolean bIncludeDynamicMembers, boolean bIncludeStaticMembers)
PT_PROPID_OBJECTID, PT_PROPID_NAME,
PT_PROPID_DESCRIPTION, PT_PROPID_ISLOCALIZED, PT_PROPID_USER_UNIQUENAME,
PT_PROPID_USER_LOGINNAME.
true
for both bIncludeDynamicMembers
and
bIncludeStaticMembers
will return all memberships for this group.
bIncludeDynamicMembers
- - true
to include dynamic memberships, false
to exclude thembIncludeStaticMembers
- - true
to include static memberships, false
to exclude them
IPTQueryResult
,
PT_PROPIDS
IPTQueryResult QueryUsers(boolean bIncludeDynamicMembers, boolean bIncludeStaticMembers, int nMaxRows, int nRowsToSkip)
PT_PROPID_OBJECTID, PT_PROPID_NAME,
PT_PROPID_DESCRIPTION, PT_PROPID_ISLOCALIZED, PT_PROPID_USER_UNIQUENAME,
PT_PROPID_USER_LOGINNAME.
true
for both bIncludeDynamicMembers
and
bIncludeStaticMembers
will return all memberships for this group.
bIncludeDynamicMembers
- - true
to include dynamic memberships, false
to exclude thembIncludeStaticMembers
- - true
to include static memberships, false
to exclude themnMaxRows
- - maximum number of users returned by the querynRowsToSkip
- - number of users at the start of the result set to skip
IPTQueryResult
,
PT_PROPIDS
IPTQueryResult PreviewDynamicMembershipRule(IPTFilter pRules)
PT_PROPID_OBJECTID, PT_PROPID_NAME,
PT_PROPID_DESCRIPTION, PT_PROPID_ISLOCALIZED, PT_PROPID_USER_UNIQUENAME,
PT_PROPID_USER_LOGINNAME
.
pRules
- - a valid IPTFilter
IPTQueryResult
,
PT_PROPIDS
void UpdateDynamicMembers()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |