Package Thor.API.Operations
Interface tcGroupOperationsIntf
- All Superinterfaces:
tcUtilityOperationsIntf
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAdministrator
(long plGroupKey, long plAdminGroupKey, boolean pbWrite, boolean pbDelete) Deprecated.void
addAdministrators
(long plGroupKey, long[] palAdminGroupKeys, boolean[] pbWrite, boolean[] pbDelete) Deprecated.void
addForm
(long plGroupKey, long plWinKey, long plParentKey, int sequence, int nestlevel) Deprecated.void
addForms
(long plGroupKey, long[] palWinKeys, long[] palParentKeys, int[] sequence, int[] nestlevel) Deprecated.void
addMemberGroup
(long plGroupKey, long plMemberGroupKey) Adds a group as a member to the specified group.void
addMemberGroups
(long plGroupKey, long[] palMemberGroupKeys) Adds a list of user groups as members to the specified group.void
addMembershipRule
(long plGroupKey, long plRuleKey) Adds the Membership Rule to a given groupvoid
addMembershipRules
(long groupKey, long[] ruleKeys) Adds a list of Membership Rules to a given groupvoid
addMemberUser
(long plGroupKey, long plUserKey) Adds the specified user to the specified group.void
addMemberUser
(long plGroupKey, long plUserKey, boolean evaluatePolicies) Deprecated.void
addMemberUsers
(long plGroupKey, long[] paUserKeys) Adds the specified users to the specified group.void
addMemberUsers
(long plGroupKey, long[] paUserKeys, boolean evaluatePolicies) Deprecated.addMemberUsersNoTxn
(long plGroupKey, long[] paUserKeys, boolean evaluatePolicies) Deprecated.void
addMenuItem
(long plGroupKey, long plWinKey) Deprecated.void
addMenuItems
(long groupKey, long[] winKeys) Deprecated.void
addObjectPermission
(long plGroupKey, long plDobKey, boolean insertAllow, boolean updateAllow, boolean deleteAllow) Deprecated.void
addObjectPermissions
(long groupKey, long[] dobKeys, boolean[] insertAllow, boolean[] updateAllow, boolean[] deleteAllow) Deprecated.void
addProvisionPolicies
(long groupKey, long[] policykeys) Adds a list of Provision Policies to the specified groupvoid
addProvisionPolicy
(long plGroupKey, long plPolicyKey) Adds a Provision Policy to a given grouplong
createGroup
(Map phAttributes) Create a group with the list of specified attributes.void
decreaseMemberGroupPriority
(long plGroupKey, long plMemberGroupKey) Decrease the priority of a group member in the specified groupvoid
decreaseMemberUserPriority
(long plGroupKey, long plUserKey) Decrease the priority of a user member in the specified groupvoid
deleteGroup
(long groupKey) Deletes a group from the OIMvoid
deleteGroups
(long[] groupKeys) Deletes a set of groups from the array of group keysThor.API.tcResultSet
findAssignedMembershipRules
(Map searchCriteria) Gets a list of the assigned Membership Rules for a given group, which matches the string pattern entered by the userThor.API.tcResultSet
findGroups
(Map phAttributeList) Returns a list of groups (in the form of tcResultSet) that match the provided attribute list.Thor.API.tcResultSet
findGroups
(Map phAttributeList, String permission) Returns a list of groups (in the form of tcResultSet) that match the provided attribute list based on permission.Thor.API.tcResultSet
findGroupsFiltered
(Map attributeMap, String[] fieldsList, int startRow, int pageSize, String[] order, boolean ascendingOrder) Returns a list of users that match the provided attribute list.Thor.API.tcResultSet
findUnAssignedGroups
(Map phAttributeList, long plUserKey) Returns a list of groups (in the form of tcResultSet) that match the provided attribute list.Thor.API.tcResultSet
findUnassignedMembershipRules
(Map searchCriteria) Gets a list of the unassigned Membership Rules for a given group, which matches the string pattern entered by the userThor.API.tcResultSet
getAdministrators
(long plGroupKey) Gets a list of the groups that have administrative control over the specified groupThor.API.tcResultSet
getAdministrators
(Map searchCriteria) Gets a list of the groups that have administrative control over the specified groupThor.API.tcResultSet
Deprecated.Thor.API.tcResultSet
getAllMemberGroups
(long plGroupKey) Gets a list of the groups that are a member of this group by direct and indirect inclusion.com.thortech.xl.orb.dataaccess.tcDataSetData
getAllMemberGroupsData
(long plGroupKey) Gets a list of the groups that are a member of this group by direct and indirect inclusion.Thor.API.tcResultSet
getAllMembers
(long plGroupKey) Gets a list of all users and groups that are member of the specified group by direct inclusion.Thor.API.tcResultSet
getAllMembers
(long plGroupKey, int startRow, int pageSize, String order, boolean ascendingOrder) Gets a list of all users and groups that are member of the specified group by direct inclusion.Thor.API.tcResultSet
Returns all the available Membership Rules in OIMThor.API.tcResultSet
getAllMemberUsers
(long plGroupKey) Gets a list of all the users that are a member of this group, by direct or indirect inclusion.Thor.API.tcResultSet
getAllMemberUsers
(long plGroupKey, int startRow, int pageSize, String order, boolean ascendingOrder) Gets a list of all the users that are a member of this group, by direct or indirect inclusion.Thor.API.tcResultSet
getAllMemberUsersAndGroups
(long groupKey) Gets a list of all users and groups that are members of the specified group by direct and indirect inclusion.Thor.API.tcResultSet
getAllMemberUsersAndGroups
(long plGroupKey, int startRow, int pageSize, String order, boolean ascendingOrder) Gets a list of all users and groups that are members of the specified group by direct and indirect inclusion.Thor.API.tcResultSet
Deprecated.Thor.API.tcResultSet
Deprecated.Thor.API.tcResultSet
getAllParentGroups
(long groupKey) Gets a list of the groups that are a parent of this group by direct and indirect inclusion.Thor.API.tcResultSet
Returns all the available Provision Policies that can be assigned to groupsThor.API.tcResultSet
getAssignedForms
(long groupKey) Deprecated.Thor.API.tcResultSet
getAssignedMembershipRules
(long groupKey) Returns all the assigned Membership Rules for a given groupThor.API.tcResultSet
getAssignedMenuItems
(long groupKey) Deprecated.Thor.API.tcResultSet
getAssignedObjectPermissions
(long groupKey) Deprecated.Thor.API.tcResultSet
getAssignedObjectPermissions
(Map searchCriteria) Deprecated.Thor.API.tcResultSet
getAssignedProvisionPolicies
(long groupKey) Returns all the assign Provision Policies from a given groupThor.API.tcResultSet
getMemberGroups
(long plGroupKey) Gets a list of the groups that are a member of this group by direct inclusion.Thor.API.tcResultSet
getMemberUsers
(long plGroupKey) Gets a list of the users that are a member of this group by direct inclusion.Thor.API.tcResultSet
getUnassignedAdministrators
(long plGroupKey) Gets a list of the groups that are not assigned as the administrator groups of a specified groupThor.API.tcResultSet
getUnassignedAdministrators
(Map searchCriteria) Returns a list groups of that are not assigned as Administartive Groups for an specified group.Thor.API.tcResultSet
getUnassignedForms
(long groupKey) Deprecated.Thor.API.tcResultSet
getUnassignedMemberGroups
(long groupKey, Map attributeMap) Gets a list of the groups that are not assigned as member groups of the given groupThor.API.tcResultSet
getUnassignedMembershipRules
(long groupKey) Returns all the unassigned Membership Rules for a given groupThor.API.tcResultSet
getUnassignedMemberUsers
(long groupKey, Map attributeMap) Gets a list of the users that are not assigned as members of the given groupThor.API.tcResultSet
getUnassignedMenuItems
(long groupKey) Deprecated.Thor.API.tcResultSet
getUnassignedObjectPermissions
(long groupKey) Deprecated.Thor.API.tcResultSet
getUnassignedObjectPermissions
(Map searchCriteria) Deprecated.Thor.API.tcResultSet
getUnassignedProvisionPolicies
(long groupKey) Returns all the unassigned Provision Policies from a given groupvoid
increaseMemberGroupPriority
(long plGroupKey, long plMemberGroupKey) Increase the priority of a group member in the specified groupvoid
increaseMemberUserPriority
(long plGroupKey, long plUserKey) Increase the priority of a user member in the specified groupisUserGroupMember
(long plGroupKey, long plUserKey) Gets a list of the users that are a member of this group by direct inclusion.void
removeAdministrator
(long plGroupKey, long plAdminGroupKey) Removes a group from having administrative control over the specified groupvoid
removeAdministrators
(long plGroupKey, long[] palAdminGroupKeys) Removes a list of groups from having administrative control over a specified groupvoid
removeAllMembers
(long plGroupKey) Removes all member users and sub groups of the specified groupvoid
removeForm
(long plGroupKey, long plWinKey) Deprecated.void
removeForms
(long groupKey, long[] winKeys) Deprecated.void
removeMemberGroup
(long plGroupKey, long plMemberGroupKey) Removes the specified member group from the specified group.void
removeMemberGroups
(long plGroupKey, long[] palMemberGroupKeys) Removes a list of user group members from the specified group.void
removeMembershipRule
(long plGroupKey, long plRuleKey) Removes a Membership Rule from a groupvoid
removeMembershipRules
(long groupKey, long[] ruleKeys) Removes a list of Membership Rules from a groupvoid
removeMemberUser
(long plGroupKey, long plUserKey) Removes the specified user from the specified group.void
removeMemberUser
(long plGroupKey, long plUserKey, boolean evaluatePolicies) Deprecated.void
removeMemberUsers
(long plGroupKey, long[] paUserKeys) Removes the specified users from the specified group.void
removeMemberUsers
(long plGroupKey, long[] paUserKeys, boolean evaluatePolicies) Deprecated.removeMemberUsersNoTxn
(long plGroupKey, long[] paUserKeys, boolean evaluatePolicies) Deprecated.void
removeMenuItem
(long plGroupKey, long plWinKey) Deprecated.void
removeMenuItems
(long groupKey, long[] winKeys) Deprecated.void
removeObjectPermission
(long plGroupKey, long plObjectPermissionKey) Deprecated.void
removeObjectPermissions
(long groupKey, long[] dobKeys) Deprecated.void
removeProvisionPolicies
(long groupKey, long[] policyKeys) Removes a list of assigned Provision Policies from the specified groupvoid
removeProvisionPolicy
(long plGroupKey, long plPolicyKey) Removes an assigned Provision Policy from the groupvoid
setMemberGroupPriority
(long plGroupKey, long plMemberGroupKey, int pnPriority) Deprecated.void
setMemberUserPriority
(long plGroupKey, long plUserKey, int pnPriority) Deprecated.void
updateAdministrator
(long plGroupKey, long plAdminGroupKey, boolean pbWrite, boolean pbDelete) Deprecated.void
updateAdministrators
(long plGroupKey, long[] palAdminGroupKeys, boolean[] pbWrite, boolean[] pbDelete) Deprecated.void
updateGroup
(Thor.API.tcResultSet poGroupResultSet, Map phAttributeList) Updates a group in OIM.void
updateObjectPermission
(long groupKey, long dobKey, Map attribute) Deprecated.void
updateObjectPermissions
(long groupKey, DataObjectPermissions[] dataObjectPermissions) Deprecated.Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf
close, getName, setCountry, setLanguage, setVariant
-
Method Details
-
addAdministrator
@Deprecated void addAdministrator(long plGroupKey, long plAdminGroupKey, boolean pbWrite, boolean pbDelete) throws tcAPIException, tcGroupNotFoundException, tcAdminNotFoundException, tcAdminGroupInvalidException, tcAPIException Deprecated.Adds a group to have administrative control over the specified group- Parameters:
plGroupKey
- - The key of the groupplAdminGroupKey
- - The key of the admin grouppbWrite
- - Whether the group has write access to the grouppbDelete
- - Whether the group has delete access to the group- Throws:
tcAPIException
- thrown if errors occur in the data set OR while savingtcGroupNotFoundException
- thrown if plGroupKey does not existtcAdminNotFoundException
- thrown if plAdminGroupKey does not existtcAdminGroupInvalidException
- thrown if administrator is not allowed to be added
-
addAdministrators
@Deprecated void addAdministrators(long plGroupKey, long[] palAdminGroupKeys, boolean[] pbWrite, boolean[] pbDelete) throws tcAdminNotFoundException, tcAdminGroupInvalidException, tcGroupNotFoundException, tcAPIException, tcBulkException, tcAPIException Deprecated.Adds a list of groups to have administrative control over the specified group- Parameters:
plGroupKey
- - The key of the grouppalAdminGroupKeys
- - The keys of the admin groupspbWrite
- - Whether the admin groups to have write access over the specified grouppbDelete
- - Whether the admin groups to have delete access over the specified group- Throws:
tcAdminNotFoundException
- thrown if one or many palAdminGroupKeys do not existtcAdminGroupInvalidException
- thrown if administrator is not allowed to be updatedtcGroupNotFoundException
- thrown if plGroupKey does not existtcAPIException
- thrown if errors occur in the data set OR while savingtcBulkException
-
addMemberGroup
void addMemberGroup(long plGroupKey, long plMemberGroupKey) throws tcAPIException, tcGroupNotFoundException, tcInvalidMemberGroupException, tcMemberGroupNotFoundException, tcAPIException Adds a group as a member to the specified group.- Parameters:
plGroupKey
- - The key of the group to add the member toplMemberGroupKey
- - The key of the group to add as a member- Throws:
tcAPIException
- thrown if data set errors occur OR while savingtcGroupNotFoundException
- thrown if plGroupKey does not existtcInvalidMemberGroupException
- thrown if member is not allowed to be added to the grouptcMemberGroupNotFoundException
- thrown if plMemberGroupKey does not exist
-
addMemberGroups
void addMemberGroups(long plGroupKey, long[] palMemberGroupKeys) throws tcGroupNotFoundException, tcInvalidMemberGroupException, tcMemberGroupNotFoundException, tcAPIException, tcBulkException, tcAPIException Adds a list of user groups as members to the specified group.- Parameters:
plGroupKey
- - The key of the group to add members topalMemberGroupKeys
- - The keys of the member groups to be added- Throws:
tcGroupNotFoundException
- thrown if plGroupKey does not existtcInvalidMemberGroupException
- thrown if member is not allowed to be added to the grouptcMemberGroupNotFoundException
- thrown if one or many palMemberGroupKeys do not existtcAPIException
- thrown if data set errors occur OR while savingtcBulkException
-
addMemberUser
void addMemberUser(long plGroupKey, long plUserKey) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException Adds the specified user to the specified group.- Parameters:
plGroupKey
- - The key of the group to add the user toplUserKey
- - The key of the user to add- Throws:
tcAPIException
- thrown if data set errors occur OR while savingtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not exist
-
addMemberUser
@Deprecated void addMemberUser(long plGroupKey, long plUserKey, boolean evaluatePolicies) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException Deprecated.Adds the specified user to the specified group.- Parameters:
plGroupKey
- - The key of the group to add the user toplUserKey
- - The key of the user to addevaluatePolicies
- - Boolean to indicate whether to evaluate policies or not when user is added to the group- Throws:
tcAPIException
- thrown if data set errors occur OR while savingtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not exist
-
addMemberUsers
void addMemberUsers(long plGroupKey, long[] paUserKeys) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException Adds the specified users to the specified group.- Parameters:
plGroupKey
- - The key of the group to add the user topaUserKeys
- - The key of the user to add- Throws:
tcAPIException
- thrown if data set errors occur OR while savingtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not exist
-
addMemberUsersNoTxn
@Deprecated Map addMemberUsersNoTxn(long plGroupKey, long[] paUserKeys, boolean evaluatePolicies) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException Deprecated.Adds the specified users to the specified group.- Parameters:
plGroupKey
- - The key of the group to add the user topaUserKeys
- - The key of the user to addevaluatePolicies
- - Boolean to indicate whether to evaluate policies or not when users are added to the group- Returns:
- Map - pairs of user key failed and the reason of failure.
- Throws:
tcAPIException
- thrown if data set errors occur OR while savingtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not exist
-
addMemberUsers
@Deprecated void addMemberUsers(long plGroupKey, long[] paUserKeys, boolean evaluatePolicies) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException Deprecated.Adds the specified users to the specified group.- Parameters:
plGroupKey
- - The key of the group to add the user topaUserKeys
- - The key of the user to addevaluatePolicies
- - Boolean to indicate whether to evaluate policies or not when users are added to the group- Throws:
tcAPIException
- thrown if data set errors occur OR while savingtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not exist
-
createGroup
long createGroup(Map phAttributes) throws tcAPIException, tcDuplicateGroupException, tcInvalidAttributeException, tcAPIException Create a group with the list of specified attributes.- Parameters:
phAttributes
- - The attributes to set for the new group being created- Returns:
- A long containing the key of the group created
- Throws:
tcAPIException
- thrown if errors occur while savingtcDuplicateGroupException
- thrown if Group Name already existstcInvalidAttributeException
- thrown if a group key is provided as an attribute
-
decreaseMemberGroupPriority
void decreaseMemberGroupPriority(long plGroupKey, long plMemberGroupKey) throws tcAPIException, tcGroupNotFoundException, tcMemberGroupNotFoundException, tcAPIException Decrease the priority of a group member in the specified group- Parameters:
plGroupKey
- - The key of the parent groupplMemberGroupKey
- - The key of the member group- Throws:
tcAPIException
- thrown if data set errors occur OR while saving OR member group doesn't correspong to grouptcGroupNotFoundException
- thrown if plGroupKey does not existtcMemberGroupNotFoundException
- thrown if plMemberGroupKey does not exist
-
decreaseMemberUserPriority
void decreaseMemberUserPriority(long plGroupKey, long plUserKey) throws tcAPIException, tcUserNotFoundException, tcGroupNotFoundException, tcAPIException Decrease the priority of a user member in the specified group- Parameters:
plGroupKey
- - The key of the groupplUserKey
- - The key of the user- Throws:
tcAPIException
- thrown if data set errors occur OR while saving OR user doesn't correspong to grouptcUserNotFoundException
- thrown if plUserKey does not existtcGroupNotFoundException
- thrown if plGroupKey does not exist
-
findGroups
Returns a list of groups (in the form of tcResultSet) that match the provided attribute list. The list included only the the groups the logged in user has read permissions over- Parameters:
phAttributeList
- - An array of tcMapping objects, each object holding the attribute-value pairs to match the group against. The Attribute names are the String column codes (from the OIM metadata). The Attribute Values are the String attributes to base the search on. The values could include wild cards (%).- Returns:
- A tcResultSet containing multiple rows, each holding information about the group
- Throws:
tcAPIException
- thrown if data set errors occur
-
findGroups
Thor.API.tcResultSet findGroups(Map phAttributeList, String permission) throws tcAPIException, tcAPIException Returns a list of groups (in the form of tcResultSet) that match the provided attribute list based on permission.- Parameters:
phAttributeList
- - An array of tcMapping objects, each object holding the attribute-value pairs to match the group against. The Attribute names are the String column codes (from the OIM metadata). The Attribute Values are the String attributes to base the search on. The values could include wild cards (*).permission
- - the value of permission could be Read, Write or Delete.- Returns:
- A tcResultSet containing multiple rows, each holding information about the group
- Throws:
tcAPIException
- thrown if data set errors occur
-
getAdministrators
Thor.API.tcResultSet getAdministrators(long plGroupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException Gets a list of the groups that have administrative control over the specified group- Parameters:
plGroupKey
- - The key of the group- Returns:
- A result set containing all the information about the groups that have administrative control over this group
- Throws:
tcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not exist
-
getUnassignedMemberUsers
Thor.API.tcResultSet getUnassignedMemberUsers(long groupKey, Map attributeMap) throws tcGroupNotFoundException, tcAPIException, tcAPIException Gets a list of the users that are not assigned as members of the given group- Parameters:
groupKey
- - The key of the group- Returns:
- Result set containing the unassigned users
- Throws:
tcGroupNotFoundException
- thrown if plGroupKey does not existtcAPIException
- thrown if data set errors occur
-
getUnassignedMemberGroups
Thor.API.tcResultSet getUnassignedMemberGroups(long groupKey, Map attributeMap) throws tcGroupNotFoundException, tcAPIException, tcAPIException Gets a list of the groups that are not assigned as member groups of the given group- Parameters:
groupKey
- - The key of the group- Returns:
- Result set containing the unassigned groups
- Throws:
tcGroupNotFoundException
- thrown if plGroupKey does not existtcAPIException
- thrown if data set errors occur
-
getUnassignedAdministrators
Thor.API.tcResultSet getUnassignedAdministrators(long plGroupKey) throws tcGroupNotFoundException, tcAPIException, tcAPIException Gets a list of the groups that are not assigned as the administrator groups of a specified group- Parameters:
plGroupKey
- - The key of the group- Returns:
- Result set containing the unassigned Group key and names
- Throws:
tcGroupNotFoundException
- thrown if plGroupKey does not existtcAPIException
- thrown if data set errors occur
-
getAllMemberUsers
Thor.API.tcResultSet getAllMemberUsers(long plGroupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException Gets a list of all the users that are a member of this group, by direct or indirect inclusion. The list is always ordered by priority.- Parameters:
plGroupKey
- - The key of the group- Returns:
- A result set containing all the information about the users that are members of this group The result set contains user key, login, first name, last name, and priority.
- Throws:
tcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not exist
-
getAllMemberUsers
Thor.API.tcResultSet getAllMemberUsers(long plGroupKey, int startRow, int pageSize, String order, boolean ascendingOrder) throws tcAPIException, tcGroupNotFoundException, tcAPIException Gets a list of all the users that are a member of this group, by direct or indirect inclusion. The list is always ordered by priority.- Parameters:
plGroupKey
- - The key of the groupstartRow
- - The starting row of the resultpageSize
- - The end row of the resultorder
- - The order in which the result set is based since only a subset of the whole matching set is return, the caller will not be able to sort accurately with only that subset.ascendingOrder
- - a boolean value if the sorting is to be ascending or descending- Returns:
- A result set containing all the information about the users that are members of this group The result set contains user key, login, first name, last name, and priority. The result set only contains rows from start and end row (both inclusive).
- Throws:
tcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not exist
-
getMemberGroups
Thor.API.tcResultSet getMemberGroups(long plGroupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException Gets a list of the groups that are a member of this group by direct inclusion. The list is always ordered by priority.- Parameters:
plGroupKey
- - The key of the group- Returns:
- A result set containing all the information about the groups that are direct members of this group
- Throws:
tcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not exist
-
getAllMemberGroups
Thor.API.tcResultSet getAllMemberGroups(long plGroupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException Gets a list of the groups that are a member of this group by direct and indirect inclusion.- Parameters:
plGroupKey
- - The key of the group- Returns:
- A result set containing all the information about the groups that are direct and indirect members of this group
- Throws:
tcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not exist
-
getAllMemberGroupsData
com.thortech.xl.orb.dataaccess.tcDataSetData getAllMemberGroupsData(long plGroupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException Gets a list of the groups that are a member of this group by direct and indirect inclusion.- Parameters:
plGroupKey
- - The key of the group- Returns:
- A result set containing all the information about the groups that are direct and indirect members of this group
- Throws:
tcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not exist
-
getAllParentGroups
Thor.API.tcResultSet getAllParentGroups(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException Gets a list of the groups that are a parent of this group by direct and indirect inclusion.- Parameters:
groupKey
- - The key of the group- Returns:
- A result set containing all the information about the groups that are parents of this group by direct and indirect inclusion
- Throws:
tcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not exist
-
isUserGroupMember
Boolean isUserGroupMember(long plGroupKey, long plUserKey) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException Gets a list of the users that are a member of this group by direct inclusion. The list is always ordered by priority.- Parameters:
plGroupKey
- - The key of the groupplUserKey
- - The key of the user- Returns:
- A Boolean value
- Throws:
tcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not exist- Since:
- 9.1.0.0
-
getMemberUsers
Thor.API.tcResultSet getMemberUsers(long plGroupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException Gets a list of the users that are a member of this group by direct inclusion. The list is always ordered by priority.- Parameters:
plGroupKey
- - The key of the group- Returns:
- A result set containing all the information about the users that are direct members of this group The result set contains user key, login, first name, last name, and priority.
- Throws:
tcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not exist
-
increaseMemberGroupPriority
void increaseMemberGroupPriority(long plGroupKey, long plMemberGroupKey) throws tcAPIException, tcGroupNotFoundException, tcMemberGroupNotFoundException, tcAPIException Increase the priority of a group member in the specified group- Parameters:
plGroupKey
- - The key of the parent groupplMemberGroupKey
- - The key of the member group- Throws:
tcAPIException
- thrown if data set errors occur OR while saving OR member group doesn't correspong to grouptcGroupNotFoundException
- thrown if plGroupKey does not existtcMemberGroupNotFoundException
- thrown if plMemberGroupKey does not exist
-
increaseMemberUserPriority
void increaseMemberUserPriority(long plGroupKey, long plUserKey) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException Increase the priority of a user member in the specified group- Parameters:
plGroupKey
- - The key of the groupplUserKey
- - The key of the user- Throws:
tcAPIException
- thrown if data set errors occur OR while saving OR User does not correspond to grouptcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not exist
-
removeAdministrator
void removeAdministrator(long plGroupKey, long plAdminGroupKey) throws tcAPIException, tcGroupNotFoundException, tcAdminNotFoundException, tcAPIException Removes a group from having administrative control over the specified group- Parameters:
plGroupKey
- - The key of the groupplAdminGroupKey
- - The key of the admin group- Throws:
tcAPIException
- thrown if data set errors occur OR while saving OR Group key doesn't correspond to Administrator Group keytcGroupNotFoundException
- thrown if plGroupKey does not existtcAdminNotFoundException
- thrown if plAdminGroupKey does not exist
-
removeAdministrators
void removeAdministrators(long plGroupKey, long[] palAdminGroupKeys) throws tcAdminNotFoundException, tcGroupNotFoundException, tcAPIException, tcBulkException, tcAPIException Removes a list of groups from having administrative control over a specified group- Parameters:
plGroupKey
- - The key of the grouppalAdminGroupKeys
- - The keys of the admin groups- Throws:
tcAdminNotFoundException
- thrown if one or many palAdminGroupKeys do not existtcGroupNotFoundException
- thrown if plGroupKey does not existtcAPIException
- thrown if data set errors occur OR while saving OR Group key doesn't correspond to Administrator Group keystcBulkException
-
removeMemberGroup
void removeMemberGroup(long plGroupKey, long plMemberGroupKey) throws tcAPIException, tcGroupNotFoundException, tcMemberGroupNotFoundException, tcAPIException Removes the specified member group from the specified group.- Parameters:
plGroupKey
- - The key of the group to remove the member group fromplMemberGroupKey
- - The key of the member group to remove- Throws:
tcAPIException
- thrown if data set errors occur OR while saving OR Group key doesn't correspond to Member Group keytcGroupNotFoundException
- thrown if plGroupKey does not existtcMemberGroupNotFoundException
- thrown if plMemberGroupKey does not exist
-
removeMemberGroups
void removeMemberGroups(long plGroupKey, long[] palMemberGroupKeys) throws tcGroupNotFoundException, tcInvalidMemberGroupException, tcMemberGroupNotFoundException, tcAPIException, tcBulkException, tcAPIException Removes a list of user group members from the specified group.- Parameters:
plGroupKey
- - The key of the group to remove the members frompalMemberGroupKeys
- - The keys of the member groups to remove- Throws:
tcGroupNotFoundException
- thrown if plGroupKey does not existtcInvalidMemberGroupException
- thrown if member is not allowed to remove from the grouptcMemberGroupNotFoundException
- thrown if one or many palMemberGroupKeys do not existtcAPIException
- thrown if data set errors occur OR while savingtcBulkException
-
removeMemberUser
void removeMemberUser(long plGroupKey, long plUserKey) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException Removes the specified user from the specified group.- Parameters:
plGroupKey
- - The key of the group to remove the user fromplUserKey
- - The key of the user to remove- Throws:
tcAPIException
- thrown if data set errors occur OR while saving OR Group and User keys do not correspondtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not exist
-
removeMemberUser
@Deprecated void removeMemberUser(long plGroupKey, long plUserKey, boolean evaluatePolicies) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException Deprecated.Removes the specified user from the specified group.- Parameters:
plGroupKey
- - The key of the group to remove the user fromplUserKey
- - The key of the user to removeevaluatePolicies
- - Boolean to indicate whether to evaluate policies or not when user is removed from the group- Throws:
tcAPIException
- thrown if data set errors occur OR while saving OR Group and User keys do not correspondtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not exist
-
removeMemberUsers
void removeMemberUsers(long plGroupKey, long[] paUserKeys) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException Removes the specified users from the specified group.- Parameters:
plGroupKey
- - The key of the group to remove the user frompaUserKeys
- - The keys of the users to remove- Throws:
tcAPIException
- thrown if data set errors occur OR while saving OR Group and User keys do not correspondtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not exist
-
removeMemberUsersNoTxn
@Deprecated Map removeMemberUsersNoTxn(long plGroupKey, long[] paUserKeys, boolean evaluatePolicies) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException Deprecated.Removes the specified users from the specified group.- Parameters:
plGroupKey
- - The key of the group to remove the user frompaUserKeys
- - The keys of the users to removeevaluatePolicies
- - Boolean to indicate whether to evaluate policies or not when users are removed from the group- Returns:
- Map - pairs of user key failed and the reason of failure.
- Throws:
tcAPIException
- thrown if data set errors occur OR while saving OR Group and User keys do not correspondtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not exist
-
removeMemberUsers
@Deprecated void removeMemberUsers(long plGroupKey, long[] paUserKeys, boolean evaluatePolicies) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException Deprecated.Removes the specified users from the specified group.- Parameters:
plGroupKey
- - The key of the group to remove the user frompaUserKeys
- - The keys of the users to removeevaluatePolicies
- - Boolean to indicate whether to evaluate policies or not when users are removed from the group- Throws:
tcAPIException
- thrown if data set errors occur OR while saving OR Group and User keys do not correspondtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not exist
-
setMemberGroupPriority
@Deprecated void setMemberGroupPriority(long plGroupKey, long plMemberGroupKey, int pnPriority) throws tcAPIException, tcGroupNotFoundException, tcMemberGroupNotFoundException, tcAPIException Deprecated.Set the priority of a group member in the specified group- Parameters:
plGroupKey
- - The key of the parent groupplMemberGroupKey
- - The key of the member grouppnPriority
- - The priority number to set- Throws:
tcAPIException
- thrown if data set errors occur OR while saving OR Group key doesn't correspond to Member Group keytcGroupNotFoundException
- thrown if plGroupKey does not existtcMemberGroupNotFoundException
- thrown if plMemberGroupKey does not exist
-
setMemberUserPriority
@Deprecated void setMemberUserPriority(long plGroupKey, long plUserKey, int pnPriority) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException Deprecated.Set the priority of a user member in the specified group- Parameters:
plGroupKey
- - The key of the groupplUserKey
- - The key of the userpnPriority
- - The new priority number to set- Throws:
tcAPIException
- thrown if data set errors occur OR while saving OR Group and User keys do not correspondtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not exist
-
updateAdministrator
@Deprecated void updateAdministrator(long plGroupKey, long plAdminGroupKey, boolean pbWrite, boolean pbDelete) throws tcAPIException, tcGroupNotFoundException, tcAdminNotFoundException, tcAPIException Deprecated.Updates the administrative access a group has over the specified group- Parameters:
plGroupKey
- - The key of the groupplAdminGroupKey
- - The key of the admin grouppbWrite
- - Whether the group has write access to the grouppbDelete
- - Whether the group has delete access to the group- Throws:
tcAPIException
- thrown if data set errors occur OR while saving OR plGroupKey does not correspond with plAdminGroupKeytcGroupNotFoundException
- thrown if plGroupKey does not existtcAdminNotFoundException
- thrown if plAdminGroupKey does not exist
-
updateAdministrators
@Deprecated void updateAdministrators(long plGroupKey, long[] palAdminGroupKeys, boolean[] pbWrite, boolean[] pbDelete) throws tcAdminNotFoundException, tcGroupNotFoundException, tcAPIException, tcBulkException, tcAPIException Deprecated.Updates the administrative access for a list of groups over the specified group- Parameters:
plGroupKey
- - The key of the grouppalAdminGroupKeys
- - List of keys of the admin groupspbWrite
- - Whether the admin groups to have write access over the specified grouppbDelete
- - Whether the admin groups to have delete access over the specified group- Throws:
tcAdminNotFoundException
- thrown if one or many palAdminGroupKeys do not existtcGroupNotFoundException
- thrown if plGroupKey does not existtcAPIException
- thrown if data set errors occur OR while saving OR plGroupKey does not correspond with palAdminGroupKeystcBulkException
-
updateGroup
void updateGroup(Thor.API.tcResultSet poGroupResultSet, Map phAttributeList) throws tcAPIException, tcGroupNotFoundException, tcStaleDataUpdateException, tcAPIException Updates a group in OIM. Requires a result set to maintain our pessimistic locking mechanism. This result set should be retrieved from the findGroups method.- Parameters:
poGroupResultSet
- A result set containing at the minimum the group key and the row version of the group record to update. Note that if the result set contains multiple groups, only the first group within the result set will be updated.phAttributeList
- A map of name-value pairs, each entry holding an attribute-value pair to set/modify for this group. The Attribute names are the String column codes (from the OIM metadata). The Attribute Values are the String attributes of the columns to set. User defined fields may be included in this attribute list as well.- Throws:
tcAPIException
tcGroupNotFoundException
tcStaleDataUpdateException
-
addForm
@Deprecated void addForm(long plGroupKey, long plWinKey, long plParentKey, int sequence, int nestlevel) throws tcAPIException, tcGroupNotFoundException, tcFormNotFoundException, tcAPIException Deprecated.Adds a form to a given group- Parameters:
plGroupKey
- is the group key to add the form toplWinKey
- is the form key that we want to addplParentKey
- is the parent form keysequence
- is the sequence for this formnestlevel
- is the level nested for this form- Throws:
tcAPIException
tcGroupNotFoundException
tcFormNotFoundException
-
addForms
@Deprecated void addForms(long plGroupKey, long[] palWinKeys, long[] palParentKeys, int[] sequence, int[] nestlevel) throws tcAPIException, tcGroupNotFoundException, tcFormNotFoundException, tcBulkException, tcAPIException Deprecated.Adds a set of form to a given group- Parameters:
plGroupKey
- is the group key to add the form topalWinKeys
- is the form key that we want to addpalParentKeys
- is the parent form keysequence
- is the sequence for this formnestlevel
- is the level nested for this form- Throws:
tcAPIException
tcGroupNotFoundException
tcFormNotFoundException
tcBulkException
-
removeForm
@Deprecated void removeForm(long plGroupKey, long plWinKey) throws tcAPIException, tcGroupNotFoundException, tcFormNotFoundException, tcAPIException Deprecated.Removes a specific form from a group- Parameters:
plGroupKey
- the group key to remove the formplWinKey
- the form key- Throws:
tcAPIException
tcGroupNotFoundException
tcFormNotFoundException
-
removeForms
@Deprecated void removeForms(long groupKey, long[] winKeys) throws tcAPIException, tcGroupNotFoundException, tcFormNotFoundException, tcBulkException, tcAPIException Deprecated.Removes a list of specified forms from a group These are the forms a user in the specified group can see when logged into the java client- Parameters:
groupKey
- the group key to remove the forms fromwinKeys
- the form keys to be removed- Throws:
tcAPIException
tcGroupNotFoundException
tcFormNotFoundException
tcBulkException
-
getAssignedForms
@Deprecated Thor.API.tcResultSet getAssignedForms(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException Deprecated.Returns the assigned forms for a given group- Parameters:
groupKey
- the group key to get the forms- Returns:
- a tcResultSet of the assigned forms. The following are the column names:
- Form Information.key
- Form Information.Class Name
- Groups-Form Information.Sequence
- Groups-Form Information.Nesting Level
- Groups-Form Information.Parent Key
- Groups.Key
- Form Information.Type
- Throws:
tcAPIException
tcGroupNotFoundException
-
getUnassignedForms
@Deprecated Thor.API.tcResultSet getUnassignedForms(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException Deprecated.Returns the unassigned forms for a given group- Parameters:
groupKey
- the group key to get the forms- Returns:
- a tcResultSet of the unassigned forms. The following are the column names:
- Form Information.key
- Form Information.Class Name
- Form Information.Graphic Filename
- Form Information.Description
- Form Information.Type
- Throws:
tcAPIException
tcGroupNotFoundException
-
getAllForms
Deprecated.Returns all the forms available- Returns:
- a tcResultSet of all available forms. The following are the column names:
- Form Information.key
- Form Information.Class Name
- Form Information.Graphic Filename
- Form Information.Description
- Form Information.Type
- Throws:
tcAPIException
-
addMenuItem
@Deprecated void addMenuItem(long plGroupKey, long plWinKey) throws tcAPIException, tcGroupNotFoundException, tcFormNotFoundException, tcAPIException Deprecated.Adds a menu item to the specified group- Parameters:
plGroupKey
- the group keyplWinKey
- the menu item key- Throws:
tcAPIException
tcGroupNotFoundException
tcFormNotFoundException
-
addMenuItems
@Deprecated void addMenuItems(long groupKey, long[] winKeys) throws tcAPIException, tcGroupNotFoundException, tcFormNotFoundException, tcBulkException, tcAPIException Deprecated.Adds a list of menu items to the specified group- Parameters:
groupKey
- the group key to which the menu items to be addedwinKeys
- the menu item keys to be added- Throws:
tcAPIException
tcGroupNotFoundException
tcFormNotFoundException
tcBulkException
-
removeMenuItem
@Deprecated void removeMenuItem(long plGroupKey, long plWinKey) throws tcAPIException, tcGroupNotFoundException, tcFormNotFoundException, tcAPIException Deprecated.Removes the given menu item from a given group- Parameters:
plGroupKey
- the group keyplWinKey
- the menu item key- Throws:
tcAPIException
tcGroupNotFoundException
tcFormNotFoundException
-
removeMenuItems
@Deprecated void removeMenuItems(long groupKey, long[] winKeys) throws tcAPIException, tcGroupNotFoundException, tcFormNotFoundException, tcBulkException, tcAPIException Deprecated.Removes a list of menu items from the specified group- Parameters:
groupKey
- the group key from which the menu items to be removedwinKeys
- the menu item keys to be removed- Throws:
tcAPIException
tcGroupNotFoundException
tcFormNotFoundException
tcBulkException
-
getAssignedMenuItems
@Deprecated Thor.API.tcResultSet getAssignedMenuItems(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException Deprecated.Returns all the assigned Menu Items for a given group- Parameters:
groupKey
- the group key- Returns:
- a tcResultSet of all assigned Menu Items. The following are the column names:
- Form Information.Description
- Form Information.Type LI>Form Information.Class Name
- Groups.Key
- Form Information.key
- Groups-Form Information.Row Version
- Throws:
tcAPIException
tcGroupNotFoundException
-
getUnassignedMenuItems
@Deprecated Thor.API.tcResultSet getUnassignedMenuItems(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException Deprecated.Returns all the unassigned Menu Items for a given group- Parameters:
groupKey
- the group key- Returns:
- a tcResultSet of all unassigned Menu Items. The following are the column names:
- Form Information.Description
- Form Information.Type
- Form Information.Class Name
- Form Information.key
- Throws:
tcAPIException
tcGroupNotFoundException
-
getAllMenuItems
Deprecated.Returns all available Menu Items that can be assigned to a group- Returns:
- a tcResultSet of all available Menu Items. The following are the column names:
- Form Information.key
- Form Information.Class Name
- Form Information.Description
- Throws:
tcAPIException
-
addProvisionPolicy
void addProvisionPolicy(long plGroupKey, long plPolicyKey) throws tcAPIException, tcGroupNotFoundException, tcPolicyNotFoundException, tcAPIException Adds a Provision Policy to a given group- Parameters:
plGroupKey
- the group keyplPolicyKey
- the Policy key- Throws:
tcAPIException
tcGroupNotFoundException
tcPolicyNotFoundException
-
addProvisionPolicies
void addProvisionPolicies(long groupKey, long[] policykeys) throws tcAPIException, tcGroupNotFoundException, tcPolicyNotFoundException, tcBulkException, tcAPIException Adds a list of Provision Policies to the specified group- Parameters:
groupKey
- the group keypolicykeys
- the Policy keys to be added- Throws:
tcAPIException
tcGroupNotFoundException
tcPolicyNotFoundException
tcBulkException
-
removeProvisionPolicy
void removeProvisionPolicy(long plGroupKey, long plPolicyKey) throws tcAPIException, tcGroupNotFoundException, tcPolicyNotFoundException, tcAPIException Removes an assigned Provision Policy from the group- Parameters:
plGroupKey
- the group keyplPolicyKey
- the policy key- Throws:
tcAPIException
tcGroupNotFoundException
tcPolicyNotFoundException
-
removeProvisionPolicies
void removeProvisionPolicies(long groupKey, long[] policyKeys) throws tcAPIException, tcGroupNotFoundException, tcPolicyNotFoundException, tcBulkException, tcAPIException Removes a list of assigned Provision Policies from the specified group- Parameters:
groupKey
- the group keypolicyKeys
- the policy keys to be removed- Throws:
tcAPIException
tcGroupNotFoundException
tcPolicyNotFoundException
tcBulkException
-
getAssignedProvisionPolicies
Thor.API.tcResultSet getAssignedProvisionPolicies(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException Returns all the assign Provision Policies from a given group- Parameters:
groupKey
- the group key- Returns:
- a tcResultSet of all assigned Provision Policies. The following are the column names:
- Access Policies.Key
- Access Policies.Name
- Access Policies.Description
- Groups.Key
- Groups.Row Version
- Throws:
tcAPIException
tcGroupNotFoundException
-
getUnassignedProvisionPolicies
Thor.API.tcResultSet getUnassignedProvisionPolicies(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException Returns all the unassigned Provision Policies from a given group- Parameters:
groupKey
- the group key- Returns:
- a tcResultSet of all unassigned Provision Policies. The following are the column names:
- Access Policies.Key
- Access Policies.Name
- Access Policies.Description
- Throws:
tcAPIException
tcGroupNotFoundException
-
getAllProvisionPolicies
Returns all the available Provision Policies that can be assigned to groups- Returns:
- a tcResultSet of all available Provision Policies that can be assigned to groups. The following are the column names:
- Access Policies.Key
- Access Policies.Name
- Access Policies.Description
- Throws:
tcAPIException
-
addMembershipRule
void addMembershipRule(long plGroupKey, long plRuleKey) throws tcAPIException, tcGroupNotFoundException, tcRuleNotFoundException, tcAPIException Adds the Membership Rule to a given group- Parameters:
plGroupKey
- the group keyplRuleKey
- the Membership Rule to assign- Throws:
tcAPIException
tcGroupNotFoundException
tcRuleNotFoundException
-
addMembershipRules
void addMembershipRules(long groupKey, long[] ruleKeys) throws tcAPIException, tcGroupNotFoundException, tcRuleNotFoundException, tcBulkException, tcAPIException Adds a list of Membership Rules to a given group- Parameters:
groupKey
- the group keyruleKeys
- the Membership Rules to assign- Throws:
tcAPIException
tcGroupNotFoundException
tcRuleNotFoundException
tcBulkException
-
removeMembershipRule
void removeMembershipRule(long plGroupKey, long plRuleKey) throws tcAPIException, tcGroupNotFoundException, tcRuleNotFoundException, tcAPIException Removes a Membership Rule from a group- Parameters:
plGroupKey
- the group keyplRuleKey
- the Membership Rule to remove- Throws:
tcAPIException
tcGroupNotFoundException
tcRuleNotFoundException
-
removeMembershipRules
void removeMembershipRules(long groupKey, long[] ruleKeys) throws tcAPIException, tcGroupNotFoundException, tcRuleNotFoundException, tcBulkException, tcAPIException Removes a list of Membership Rules from a group- Parameters:
groupKey
- the group keyruleKeys
- the Membership Rules to remove- Throws:
tcAPIException
tcGroupNotFoundException
tcRuleNotFoundException
tcBulkException
-
getAssignedMembershipRules
Thor.API.tcResultSet getAssignedMembershipRules(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException Returns all the assigned Membership Rules for a given group- Parameters:
groupKey
- the group key- Returns:
- a tcResultSet of all assigned Membership Rules. The following are the column names:
- Groups.Key
- Rule Designer.Key
- Rule Designer.Name
- Throws:
tcAPIException
tcGroupNotFoundException
-
findAssignedMembershipRules
Thor.API.tcResultSet findAssignedMembershipRules(Map searchCriteria) throws tcAPIException, tcGroupNotFoundException, tcAPIException Gets a list of the assigned Membership Rules for a given group, which matches the string pattern entered by the user- Parameters:
searchCriteria
- Map holding the search criteria with key in Metadata form for filtering Assigned Rules e.g.Key=Rule Designer.Name & Value=Rule1, Groups.Key=1.- Returns:
- a tcResultSet of all assigned Membership Rules. The following are the column names:
- Groups.Key
- Groups.Group Name
- Rule Designer.Key
- Rule Designer.Name
- Throws:
tcAPIException
- thrown if an error occurrs while retrieving the data about assigned rules from the databasetcGroupNotFoundException
- Since:
- 9.2
-
getUnassignedMembershipRules
Thor.API.tcResultSet getUnassignedMembershipRules(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException Returns all the unassigned Membership Rules for a given group- Parameters:
groupKey
- the group key- Returns:
- a tcResultSet of all unassigned Membership Rules. The following are the column names:
- Rule Designer.Key
- Rule Designer.Name
- Rule Designer.Type
- Throws:
tcAPIException
tcGroupNotFoundException
-
findUnassignedMembershipRules
Gets a list of the unassigned Membership Rules for a given group, which matches the string pattern entered by the user- Parameters:
searchCriteria
- Map holding the search criteria with key in Metadata form for filtering Unassigned Rules e.g.Key=Rule Designer.Name & Value=Rule1, Groups.Key=1.- Returns:
- a tcResultSet of all unassigned Membership Rules. The following are the column names:
- Groups.Key
- Groups.Group Name
- Rule Designer.Key
- Rule Designer.Name
- Rule Designer.Type
- Throws:
tcAPIException
- thrown if an error occurrs while retrieving the data about unassigned rules from the database- Since:
- 9.2
-
getAllMembershipRules
Returns all the available Membership Rules in OIM- Returns:
- a tcResultSet of all available Membership Rules that can be assigned to groups. The following are the column names:
- Rule Designer.Key
- Rule Designer.Name
- Throws:
tcAPIException
-
addObjectPermission
@Deprecated void addObjectPermission(long plGroupKey, long plDobKey, boolean insertAllow, boolean updateAllow, boolean deleteAllow) throws tcAPIException, tcGroupNotFoundException, tcDataObjectNotFoundException, tcAPIException Deprecated.Adds an object permission to a given group- Parameters:
plGroupKey
- the group keyplDobKey
- the Object Data keyinsertAllow
- if it is allowed insertupdateAllow
- if it is allowed updatedeleteAllow
- if it is allowed delete- Throws:
tcAPIException
tcGroupNotFoundException
tcDataObjectNotFoundException
-
addObjectPermissions
@Deprecated void addObjectPermissions(long groupKey, long[] dobKeys, boolean[] insertAllow, boolean[] updateAllow, boolean[] deleteAllow) throws tcAPIException, tcGroupNotFoundException, tcDataObjectNotFoundException, tcBulkException, tcAPIException Deprecated.Adds object permissions to a given group- Parameters:
groupKey
- the group keydobKeys
- the Object Permission keysinsertAllow
- if it is allowed insertupdateAllow
- if it is allowed updatedeleteAllow
- if it is allowed delete- Throws:
tcAPIException
tcGroupNotFoundException
tcDataObjectNotFoundException
tcBulkException
-
removeObjectPermission
@Deprecated void removeObjectPermission(long plGroupKey, long plObjectPermissionKey) throws tcAPIException, tcGroupNotFoundException, tcDataObjectNotFoundException, tcAPIException Deprecated.Removes assigned Object Permission from the group- Parameters:
plGroupKey
- the group keyplObjectPermissionKey
- the Object Permission key (dob_key)- Throws:
tcAPIException
tcGroupNotFoundException
tcDataObjectNotFoundException
-
removeObjectPermissions
@Deprecated void removeObjectPermissions(long groupKey, long[] dobKeys) throws tcAPIException, tcGroupNotFoundException, tcDataObjectNotFoundException, tcBulkException, tcAPIException Deprecated.Removes assigned Object Permissions from the group- Parameters:
groupKey
- the group keydobKeys
- the Object Permission keys- Throws:
tcAPIException
tcGroupNotFoundException
tcDataObjectNotFoundException
tcBulkException
-
getAssignedObjectPermissions
@Deprecated Thor.API.tcResultSet getAssignedObjectPermissions(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException Deprecated.Get all assigned Object Permission for the given group- Parameters:
groupKey
- the group key- Returns:
- a tcResultSet of all assigned Object Permissions to the group. The following are the column names:
- Groups.Object Permissions.Key
- Groups.Key
- Data Object Manager.key
- Groups.Group Name
- Data Object Manager.Data Object
- Form Information.Description
- Groups.Object Permissions.Allow Insert
- Groups.Object Permissions.Allow Update
- Groups.Object Permissions.Allow Delete
- Groups.Object Permissions.Row Version
- Throws:
tcAPIException
tcGroupNotFoundException
-
getUnassignedObjectPermissions
@Deprecated Thor.API.tcResultSet getUnassignedObjectPermissions(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException Deprecated.Get all unassigned Object Permission for the given group- Parameters:
groupKey
- the group key- Returns:
- a tcResultSet of all unassigned Object Permissions to the group. The following are the column names:
- Data Object Manager.key
- Data Object Manager.Data Object
- Form Information.Description
- Throws:
tcAPIException
tcGroupNotFoundException
-
getAllObjectPermissions
Deprecated.Returns all available Object Permissions in the system- Returns:
- a tcResultSet of all available Membership Rules that can be assigned to groups. The following are the column names:
- Data Object Manager.key
- Data Object Manager.Data Object
- Form Information.Description
- Throws:
tcAPIException
-
updateObjectPermission
@Deprecated void updateObjectPermission(long groupKey, long dobKey, Map attribute) throws tcAPIException, tcGroupNotFoundException, tcDataObjectNotFoundException, tcAPIException Deprecated.Updates the object permission for the allow fields: insert, update, delete- Parameters:
groupKey
- the group keydobKey
- the object permission keyattribute
- the attribute list for the insert, update, delete allow- Throws:
tcAPIException
tcGroupNotFoundException
tcDataObjectNotFoundException
-
deleteGroup
Deletes a group from the OIM- Parameters:
groupKey
- key of the group to be deleted- Throws:
tcAPIException
tcGroupNotFoundException
-
deleteGroups
Deletes a set of groups from the array of group keys- Parameters:
groupKeys
- is an array of group keys to delete- Throws:
tcAPIException
tcGroupNotFoundException
-
getAllMembers
Thor.API.tcResultSet getAllMembers(long plGroupKey) throws tcGroupNotFoundException, tcAPIException, tcAPIException Gets a list of all users and groups that are member of the specified group by direct inclusion.- Parameters:
plGroupKey
- - The key of the group- Returns:
- A result set containing all the information about the users and groups that are members of this group The tcResultSet will contain an extra column called ???MemberType??? that distinguishes between users(U) and subgroups(G). The result set contains user key, login, first name, last name, and priority, group key, group name, priority and member type
- Throws:
tcGroupNotFoundException
- thrown if plGroupKey does not existtcAPIException
- thrown if data set errors occur
-
getAllMembers
Thor.API.tcResultSet getAllMembers(long plGroupKey, int startRow, int pageSize, String order, boolean ascendingOrder) throws tcAPIException, tcGroupNotFoundException, tcAPIException Gets a list of all users and groups that are member of the specified group by direct inclusion.- Parameters:
plGroupKey
- - The key of the groupstartRow
- - The starting row of the resultpageSize
- - The end row of the resultorder
- - The order in which the result set is based since only a subset of the whole matching set is return, the caller will not be able to sort accurately with only that subset.ascendingOrder
- - a boolean value if the sorting is to be ascending or descending- Returns:
- A result set containing all the information about the users and groups that are members of this group The tcResultSet will contain an extra column called ???MemberType??? that distinguishes between users(U) and subgroups(G). The result set contains user key, login, first name, last name, and priority, group key, group name, priority and member type
- Throws:
tcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not exist
-
removeAllMembers
void removeAllMembers(long plGroupKey) throws tcGroupNotFoundException, tcAPIException, tcAPIException Removes all member users and sub groups of the specified group- Parameters:
plGroupKey
- - The key of the group- Throws:
tcGroupNotFoundException
- thrown if plGroupKey does not existtcAPIException
- thrown if data set errors occur
-
updateObjectPermissions
@Deprecated void updateObjectPermissions(long groupKey, DataObjectPermissions[] dataObjectPermissions) throws tcAPIException, tcGroupNotFoundException, tcDataObjectNotFoundException, tcBulkException, tcAPIException Deprecated.Updates the object permission of the given adminisrtators of the object for the allow fields: insert, update, delete- Parameters:
groupKey
- the group key- Throws:
tcAPIException
tcGroupNotFoundException
tcDataObjectNotFoundException
tcBulkException
-
findUnAssignedGroups
Thor.API.tcResultSet findUnAssignedGroups(Map phAttributeList, long plUserKey) throws tcAPIException, tcAPIException Returns a list of groups (in the form of tcResultSet) that match the provided attribute list. The list included only the the groups the logged in user has read permissions over- Parameters:
phAttributeList
- - An array of tcMapping objects, each object holding the attribute-value pairs to match the group against. The Attribute names are the String column codes (from the OIM metadata). The Attribute Values are the String attributes to base the search on. The values could include wild cards (%).plUserKey
- Value holding the User Key (corresponds to value in theUSR_KEY
column)- Returns:
- A tcResultSet containing multiple rows, each holding information about the group
- Throws:
tcAPIException
- thrown if data set errors occur
-
getAllMemberUsersAndGroups
Thor.API.tcResultSet getAllMemberUsersAndGroups(long groupKey) throws tcGroupNotFoundException, tcAPIException, tcAPIException Gets a list of all users and groups that are members of the specified group by direct and indirect inclusion.- Parameters:
plGroupKey
- - The key of the group- Returns:
- A result set containing all the information about the users and groups that are members of this group The tcResultSet will contain an extra column called "MemberType" that distinguishes between users(U) and subgroups(G). The result set contains user key, login, first name, last name, group key, group name, parent group key, parent group name and member type
- Throws:
tcGroupNotFoundException
- thrown if plGroupKey does not existtcAPIException
- thrown if data set errors occur
-
getAllMemberUsersAndGroups
Thor.API.tcResultSet getAllMemberUsersAndGroups(long plGroupKey, int startRow, int pageSize, String order, boolean ascendingOrder) throws tcAPIException, tcGroupNotFoundException, tcAPIException Gets a list of all users and groups that are members of the specified group by direct and indirect inclusion.- Parameters:
plGroupKey
- - The key of the groupstartRow
- - The starting row of the resultpageSize
- - The end row of the resultorder
- - The order in which the result set is based since only a subset of the whole matching set is return, the caller will not be able to sort accurately with only that subset.ascendingOrder
- - a boolean value if the sorting is to be ascending or descending- Returns:
- A result set containing all the information about the users and groups that are members of this group The tcResultSet will contain an extra column called "MemberType" that distinguishes between users(U) and subgroups(G). The result set contains user key, login, first name, last name, group key, group name, parent group key, parent group name and member type
- Throws:
tcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not exist
-
getAdministrators
Thor.API.tcResultSet getAdministrators(Map searchCriteria) throws tcAPIException, tcGroupNotFoundException, tcAPIException Gets a list of the groups that have administrative control over the specified group- Parameters:
searchCriteria
- Map holding the search criteria with key in Metadata form for filtering Groups e.g. Key=Groups.Group Name & Value=G1, Groups.Key=1 Metadata Keys that can be passed are as follows: Groups-Group Ownership.Created By, Groups-Group Ownership.Note, Groups-Group Ownership.System Level, Groups-Group Ownership.Updated By, Groups-Group Ownership.Write Groups.Created By, Groups.E-mail, Groups.Group Name, Groups.Key- Returns:
- A tcResultSet, each row holding information about a group.
- Throws:
tcAPIException
- Thrown if an error occurrs while retrieving the data about unassigned groups from the databasetcGroupNotFoundException
- If the specified Group Key does not exist in the databse- Since:
- 9.2
-
getUnassignedAdministrators
Thor.API.tcResultSet getUnassignedAdministrators(Map searchCriteria) throws tcAPIException, tcGroupNotFoundException, tcAPIException Returns a list groups of that are not assigned as Administartive Groups for an specified group.- Parameters:
searchCriteria
- Map holding the search criteria with key in Metadata form for filtering Groups e.g. Key=Groups.Group Name & Value=G1, Groups.Key=1 Metadata Keys that can be passed are as follows: Groups-Group Ownership.Created By, Groups-Group Ownership.Note, Groups-Group Ownership.System Level, Groups-Group Ownership.Updated By, Groups-Group Ownership.Write Groups.Created By, Groups.E-mail, Groups.Group Name, Groups.Key- Returns:
- A tcResultSet, each row holding information about a group.
- Throws:
tcAPIException
- Thrown if an error occurrs while retrieving the data about unassigned groups from the databasetcGroupNotFoundException
- If the specified Group Key does not exist in the databse- Since:
- 9.2
-
getAssignedObjectPermissions
@Deprecated Thor.API.tcResultSet getAssignedObjectPermissions(Map searchCriteria) throws tcAPIException, tcGroupNotFoundException, tcAPIException Deprecated.Get all assigned Object Permission for the given group- Parameters:
Map
- contains keys "Form Information.Description", "Groups.Key" for filtering permission list Metadata Keys that can be passed are as follows: Groups.Object Permissions.Allow Delete, Groups.Object Permissions.Allow Insert, Groups.Object Permissions.Allow Update, Groups.Object Permissions.Created By, Groups.Object Permissions.Key, Groups.Object Permissions.Note, Groups.Object Permissions.System Level, Groups.Object Permissions.Updated By, Groups.Created By, Groups.E-mail, Groups.Group Name, Groups.Key, Groups.Updated By- Returns:
- a tcResultSet of all assigned Object Permissions to the group. The following are the column names:
- Groups.Object Permissions.Key
- Groups.Key
- Data Object Manager.key
- Groups.Group Name
- Data Object Manager.Data Object
- Form Information.Description
- Groups.Object Permissions.Allow Insert
- Groups.Object Permissions.Allow Update
- Groups.Object Permissions.Allow Delete
- Groups.Object Permissions.Row Version
- Throws:
tcAPIException
tcGroupNotFoundException
-
getUnassignedObjectPermissions
@Deprecated Thor.API.tcResultSet getUnassignedObjectPermissions(Map searchCriteria) throws tcAPIException, tcGroupNotFoundException, tcAPIException Deprecated.Get all unassigned Object Permission for the given group- Parameters:
groupKey
- the group key Metadata Keys that can be passed are as follows: Groups.Object Permissions.Allow Delete, Groups.Object Permissions.Allow Insert, Groups.Object Permissions.Allow Update, Groups.Object Permissions.Created By, Groups.Object Permissions.Key, Groups.Object Permissions.Note, Groups.Object Permissions.System Level, Groups.Object Permissions.Updated By, Groups.Created By, Groups.E-mail, Groups.Group Name, Groups.Key, Groups.Updated By- Returns:
- a tcResultSet of all unassigned Object Permissions to the group. The following are the column names:
- Data Object Manager.key
- Data Object Manager.Data Object
- Form Information.Description
- Throws:
tcAPIException
tcGroupNotFoundException
-
findGroupsFiltered
Thor.API.tcResultSet findGroupsFiltered(Map attributeMap, String[] fieldsList, int startRow, int pageSize, String[] order, boolean ascendingOrder) throws tcAPIException, tcAPIException Returns a list of users that match the provided attribute list. The fields returned in thetcResultSet
can be specified.- Parameters:
attributeMap
- AMap
of attribute-value pairs with each entry containing criteria to find users. TheMap
key should contain aString
representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. TheMap
value can contain aString
representation of the criteria to find the desired requests. Note that theMap
values can include wild cards(%).fieldsList
- The list of fields that is to be returned in thetcResultSet
. This can include user-defined fields as well as any of the following metadata codes:- Groups.Created By
- Groups.Creation Date
- Groups.E-mail
- Groups.Group Name
- Groups.Key
- Groups.Note
- Groups.Row Version
- Groups.System Level
- Groups.Update Date
- Groups.Updated By
- Groups.Viewset
- Groups.Created By Login
- Groups.Updated By Login
startRow
- The starting row of the resultpageSize
- The page size (how many rows to return)order
- The order in which the result set is based since only a subset of the whole matching set is returned, the caller will not be able to sort accurately with only that subset.ascendingOrder
- - a boolean value if the sorting is to be ascending or descending- Returns:
- A
tcResultSet
that contains the fields specified inpasFieldList
. - Throws:
tcAPIException
- Since:
- 9.1 BP02
-