|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface tcGroupOperationsIntf
Method Summary | |
---|---|
void |
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) Adds a form to a given group |
void |
addForms(long plGroupKey, long[] palWinKeys, long[] palParentKeys, int[] sequence, int[] nestlevel) Adds a set of form to a given group |
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 group |
void |
addMembershipRules(long groupKey, long[] ruleKeys) Adds a list of Membership Rules to a given group |
void |
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. |
java.util.Map |
addMemberUsersNoTxn(long plGroupKey, long[] paUserKeys, boolean evaluatePolicies) Deprecated. |
void |
addMenuItem(long plGroupKey, long plWinKey) Adds a menu item to the specified group |
void |
addMenuItems(long groupKey, long[] winKeys) Adds a list of menu items to the specified group |
void |
addObjectPermission(long plGroupKey, long plDobKey, boolean insertAllow, boolean updateAllow, boolean deleteAllow) Adds an object permission to a given group |
void |
addObjectPermissions(long groupKey, long[] dobKeys, boolean[] insertAllow, boolean[] updateAllow, boolean[] deleteAllow) Adds object permissions to a given group |
void |
addProvisionPolicies(long groupKey, long[] policykeys) Adds a list of Provision Policies to the specified group |
void |
addProvisionPolicy(long plGroupKey, long plPolicyKey) Adds a Provision Policy to a given group |
long |
createGroup(java.util.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 group |
void |
decreaseMemberUserPriority(long plGroupKey, long plUserKey) Decrease the priority of a user member in the specified group |
void |
deleteGroup(long groupKey) Deletes a group from the OIM |
void |
deleteGroups(long[] groupKeys) Deletes a set of groups from the array of group keys |
Thor.API.tcResultSet |
findAssignedMembershipRules(java.util.Map searchCriteria) Gets a list of the assigned Membership Rules for a given group, which matches the string pattern entered by the user |
Thor.API.tcResultSet |
findGroups(java.util.Map phAttributeList) Returns a list of groups (in the form of tcResultSet) that match the provided attribute list. |
Thor.API.tcResultSet |
findGroups(java.util.Map phAttributeList, java.lang.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(java.util.Map attributeMap, java.lang.String[] fieldsList, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder) Returns a list of users that match the provided attribute list. |
Thor.API.tcResultSet |
findUnAssignedGroups(java.util.Map phAttributeList, long plUserKey) Returns a list of groups (in the form of tcResultSet) that match the provided attribute list. |
Thor.API.tcResultSet |
findUnassignedMembershipRules(java.util.Map searchCriteria) Gets a list of the unassigned Membership Rules for a given group, which matches the string pattern entered by the user |
Thor.API.tcResultSet |
getAdministrators(long plGroupKey) Gets a list of the groups that have administrative control over the specified group |
Thor.API.tcResultSet |
getAdministrators(java.util.Map searchCriteria) Gets a list of the groups that have administrative control over the specified group |
Thor.API.tcResultSet |
getAllForms() Returns all the forms available |
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, java.lang.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 |
getAllMembershipRules() Returns all the available Membership Rules in OIM |
Thor.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, java.lang.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, java.lang.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 |
getAllMenuItems() Returns all available Menu Items that can be assigned to a group |
Thor.API.tcResultSet |
getAllObjectPermissions() Returns all available Object Permissions in the system |
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 |
getAllProvisionPolicies() Returns all the available Provision Policies that can be assigned to groups |
Thor.API.tcResultSet |
getAssignedForms(long groupKey) Returns the assigned forms for a given group |
Thor.API.tcResultSet |
getAssignedMembershipRules(long groupKey) Returns all the assigned Membership Rules for a given group |
Thor.API.tcResultSet |
getAssignedMenuItems(long groupKey) Returns all the assigned Menu Items for a given group |
Thor.API.tcResultSet |
getAssignedObjectPermissions(long groupKey) Get all assigned Object Permission for the given group |
Thor.API.tcResultSet |
getAssignedObjectPermissions(java.util.Map searchCriteria) Get all assigned Object Permission for the given group |
Thor.API.tcResultSet |
getAssignedProvisionPolicies(long groupKey) Returns all the assign Provision Policies from a given group |
Thor.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 group |
Thor.API.tcResultSet |
getUnassignedAdministrators(java.util.Map searchCriteria) Returns a list groups of that are not assigned as Administartive Groups for an specified group. |
Thor.API.tcResultSet |
getUnassignedForms(long groupKey) Returns the unassigned forms for a given group |
Thor.API.tcResultSet |
getUnassignedMemberGroups(long groupKey, java.util.Map attributeMap) Gets a list of the groups that are not assigned as member groups of the given group |
Thor.API.tcResultSet |
getUnassignedMembershipRules(long groupKey) Returns all the unassigned Membership Rules for a given group |
Thor.API.tcResultSet |
getUnassignedMemberUsers(long groupKey, java.util.Map attributeMap) Gets a list of the users that are not assigned as members of the given group |
Thor.API.tcResultSet |
getUnassignedMenuItems(long groupKey) Returns all the unassigned Menu Items for a given group |
Thor.API.tcResultSet |
getUnassignedObjectPermissions(long groupKey) Get all unassigned Object Permission for the given group |
Thor.API.tcResultSet |
getUnassignedObjectPermissions(java.util.Map searchCriteria) Get all unassigned Object Permission for the given group |
Thor.API.tcResultSet |
getUnassignedProvisionPolicies(long groupKey) Returns all the unassigned Provision Policies from a given group |
void |
increaseMemberGroupPriority(long plGroupKey, long plMemberGroupKey) Increase the priority of a group member in the specified group |
void |
increaseMemberUserPriority(long plGroupKey, long plUserKey) Increase the priority of a user member in the specified group |
java.lang.Boolean |
isUserGroupMember(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 group |
void |
removeAdministrators(long plGroupKey, long[] palAdminGroupKeys) Removes a list of groups from having administrative control over a specified group |
void |
removeAllMembers(long plGroupKey) Removes all member users and sub groups of the specified group |
void |
removeForm(long plGroupKey, long plWinKey) Removes a specific form from a group |
void |
removeForms(long groupKey, long[] winKeys) 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 |
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 group |
void |
removeMembershipRules(long groupKey, long[] ruleKeys) Removes a list of Membership Rules from a group |
void |
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. |
java.util.Map |
removeMemberUsersNoTxn(long plGroupKey, long[] paUserKeys, boolean evaluatePolicies) Deprecated. |
void |
removeMenuItem(long plGroupKey, long plWinKey) Removes the given menu item from a given group |
void |
removeMenuItems(long groupKey, long[] winKeys) Removes a list of menu items from the specified group |
void |
removeObjectPermission(long plGroupKey, long plObjectPermissionKey) Removes assigned Object Permission from the group |
void |
removeObjectPermissions(long groupKey, long[] dobKeys) Removes assigned Object Permissions from the group |
void |
removeProvisionPolicies(long groupKey, long[] policyKeys) Removes a list of assigned Provision Policies from the specified group |
void |
removeProvisionPolicy(long plGroupKey, long plPolicyKey) Removes an assigned Provision Policy from the group |
void |
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, java.util.Map phAttributeList) Updates a group in OIM. |
void |
updateObjectPermission(long groupKey, long dobKey, java.util.Map attribute) Updates the object permission for the allow fields: insert, update, delete |
void |
updateObjectPermissions(long groupKey, DataObjectPermissions[] dataObjectPermissions) Updates the object permission of the given adminisrtators of the object for the allow fields: insert, update, delete |
Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf |
---|
close, getName, setCountry, setLanguage, setVariant |
Method Detail |
---|
@Deprecated
void addAdministrator(long plGroupKey,
long plAdminGroupKey,
boolean pbWrite,
boolean pbDelete)
throws tcAPIException,
tcGroupNotFoundException,
tcAdminNotFoundException,
tcAdminGroupInvalidException,
tcAPIException
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 grouptcAPIException
- 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
@Deprecated
void addAdministrators(long plGroupKey,
long[] palAdminGroupKeys,
boolean[] pbWrite,
boolean[] pbDelete)
throws tcAdminNotFoundException,
tcAdminGroupInvalidException,
tcGroupNotFoundException,
tcAPIException,
tcBulkException,
tcAPIException
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 grouptcAdminNotFoundException
- 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
void addMemberGroup(long plGroupKey, long plMemberGroupKey) throws tcAPIException, tcGroupNotFoundException, tcInvalidMemberGroupException, tcMemberGroupNotFoundException, tcAPIException
plGroupKey
- - The key of the group to add the member toplMemberGroupKey
- - The key of the group to add as a membertcAPIException
- 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 existvoid addMemberGroups(long plGroupKey, long[] palMemberGroupKeys) throws tcGroupNotFoundException, tcInvalidMemberGroupException, tcMemberGroupNotFoundException, tcAPIException, tcBulkException, tcAPIException
plGroupKey
- - The key of the group to add members topalMemberGroupKeys
- - The keys of the member groups to be addedtcGroupNotFoundException
- 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
void addMemberUser(long plGroupKey, long plUserKey) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException
plGroupKey
- - The key of the group to add the user toplUserKey
- - The key of the user to addtcAPIException
- thrown if data set errors occur OR while savingtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not exist
@Deprecated
void addMemberUser(long plGroupKey,
long plUserKey,
boolean evaluatePolicies)
throws tcAPIException,
tcGroupNotFoundException,
tcUserNotFoundException,
tcAPIException
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 grouptcAPIException
- thrown if data set errors occur OR while savingtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not existvoid addMemberUsers(long plGroupKey, long[] paUserKeys) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException
plGroupKey
- - The key of the group to add the user topaUserKeys
- - The key of the user to addtcAPIException
- thrown if data set errors occur OR while savingtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not exist
@Deprecated
java.util.Map addMemberUsersNoTxn(long plGroupKey,
long[] paUserKeys,
boolean evaluatePolicies)
throws tcAPIException,
tcGroupNotFoundException,
tcUserNotFoundException,
tcAPIException
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 grouptcAPIException
- thrown if data set errors occur OR while savingtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not exist
@Deprecated
void addMemberUsers(long plGroupKey,
long[] paUserKeys,
boolean evaluatePolicies)
throws tcAPIException,
tcGroupNotFoundException,
tcUserNotFoundException,
tcAPIException
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 grouptcAPIException
- thrown if data set errors occur OR while savingtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not existlong createGroup(java.util.Map phAttributes) throws tcAPIException, tcDuplicateGroupException, tcInvalidAttributeException, tcAPIException
phAttributes
- - The attributes to set for the new group being createdtcAPIException
- thrown if errors occur while savingtcDuplicateGroupException
- thrown if Group Name already existstcInvalidAttributeException
- thrown if a group key is provided as an attributevoid decreaseMemberGroupPriority(long plGroupKey, long plMemberGroupKey) throws tcAPIException, tcGroupNotFoundException, tcMemberGroupNotFoundException, tcAPIException
plGroupKey
- - The key of the parent groupplMemberGroupKey
- - The key of the member grouptcAPIException
- 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 existvoid decreaseMemberUserPriority(long plGroupKey, long plUserKey) throws tcAPIException, tcUserNotFoundException, tcGroupNotFoundException, tcAPIException
plGroupKey
- - The key of the groupplUserKey
- - The key of the usertcAPIException
- 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 existThor.API.tcResultSet findGroups(java.util.Map phAttributeList) throws tcAPIException, tcAPIException
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 (%).tcAPIException
- thrown if data set errors occurThor.API.tcResultSet findGroups(java.util.Map phAttributeList, java.lang.String permission) throws tcAPIException, tcAPIException
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.tcAPIException
- thrown if data set errors occurThor.API.tcResultSet getAdministrators(long plGroupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
plGroupKey
- - The key of the grouptcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not existThor.API.tcResultSet getUnassignedMemberUsers(long groupKey, java.util.Map attributeMap) throws tcGroupNotFoundException, tcAPIException, tcAPIException
groupKey
- - The key of the grouptcGroupNotFoundException
- thrown if plGroupKey does not existtcAPIException
- thrown if data set errors occurThor.API.tcResultSet getUnassignedMemberGroups(long groupKey, java.util.Map attributeMap) throws tcGroupNotFoundException, tcAPIException, tcAPIException
groupKey
- - The key of the grouptcGroupNotFoundException
- thrown if plGroupKey does not existtcAPIException
- thrown if data set errors occurThor.API.tcResultSet getUnassignedAdministrators(long plGroupKey) throws tcGroupNotFoundException, tcAPIException, tcAPIException
plGroupKey
- - The key of the grouptcGroupNotFoundException
- thrown if plGroupKey does not existtcAPIException
- thrown if data set errors occurThor.API.tcResultSet getAllMemberUsers(long plGroupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
plGroupKey
- - The key of the grouptcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not existThor.API.tcResultSet getAllMemberUsers(long plGroupKey, int startRow, int pageSize, java.lang.String order, boolean ascendingOrder) throws tcAPIException, tcGroupNotFoundException, tcAPIException
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 descendingtcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not existThor.API.tcResultSet getMemberGroups(long plGroupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
plGroupKey
- - The key of the grouptcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not existThor.API.tcResultSet getAllMemberGroups(long plGroupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
plGroupKey
- - The key of the grouptcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not existcom.thortech.xl.orb.dataaccess.tcDataSetData getAllMemberGroupsData(long plGroupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
plGroupKey
- - The key of the grouptcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not existThor.API.tcResultSet getAllParentGroups(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
groupKey
- - The key of the grouptcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not existjava.lang.Boolean isUserGroupMember(long plGroupKey, long plUserKey) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException
plGroupKey
- - The key of the groupplUserKey
- - The key of the usertcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not existtcUserNotFoundException
- thrown if plUserKey does not existThor.API.tcResultSet getMemberUsers(long plGroupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
plGroupKey
- - The key of the grouptcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not existvoid increaseMemberGroupPriority(long plGroupKey, long plMemberGroupKey) throws tcAPIException, tcGroupNotFoundException, tcMemberGroupNotFoundException, tcAPIException
plGroupKey
- - The key of the parent groupplMemberGroupKey
- - The key of the member grouptcAPIException
- 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 existvoid increaseMemberUserPriority(long plGroupKey, long plUserKey) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException
plGroupKey
- - The key of the groupplUserKey
- - The key of the usertcAPIException
- 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 existvoid removeAdministrator(long plGroupKey, long plAdminGroupKey) throws tcAPIException, tcGroupNotFoundException, tcAdminNotFoundException, tcAPIException
plGroupKey
- - The key of the groupplAdminGroupKey
- - The key of the admin grouptcAPIException
- 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 existvoid removeAdministrators(long plGroupKey, long[] palAdminGroupKeys) throws tcAdminNotFoundException, tcGroupNotFoundException, tcAPIException, tcBulkException, tcAPIException
plGroupKey
- - The key of the grouppalAdminGroupKeys
- - The keys of the admin groupstcAdminNotFoundException
- 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
void removeMemberGroup(long plGroupKey, long plMemberGroupKey) throws tcAPIException, tcGroupNotFoundException, tcMemberGroupNotFoundException, tcAPIException
plGroupKey
- - The key of the group to remove the member group fromplMemberGroupKey
- - The key of the member group to removetcAPIException
- 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 existvoid removeMemberGroups(long plGroupKey, long[] palMemberGroupKeys) throws tcGroupNotFoundException, tcInvalidMemberGroupException, tcMemberGroupNotFoundException, tcAPIException, tcBulkException, tcAPIException
plGroupKey
- - The key of the group to remove the members frompalMemberGroupKeys
- - The keys of the member groups to removetcGroupNotFoundException
- 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
void removeMemberUser(long plGroupKey, long plUserKey) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException
plGroupKey
- - The key of the group to remove the user fromplUserKey
- - The key of the user to removetcAPIException
- 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
@Deprecated
void removeMemberUser(long plGroupKey,
long plUserKey,
boolean evaluatePolicies)
throws tcAPIException,
tcGroupNotFoundException,
tcUserNotFoundException,
tcAPIException
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 grouptcAPIException
- 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 existvoid removeMemberUsers(long plGroupKey, long[] paUserKeys) throws tcAPIException, tcGroupNotFoundException, tcUserNotFoundException, tcAPIException
plGroupKey
- - The key of the group to remove the user frompaUserKeys
- - The keys of the users to removetcAPIException
- 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
@Deprecated
java.util.Map removeMemberUsersNoTxn(long plGroupKey,
long[] paUserKeys,
boolean evaluatePolicies)
throws tcAPIException,
tcGroupNotFoundException,
tcUserNotFoundException,
tcAPIException
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 grouptcAPIException
- 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
@Deprecated
void removeMemberUsers(long plGroupKey,
long[] paUserKeys,
boolean evaluatePolicies)
throws tcAPIException,
tcGroupNotFoundException,
tcUserNotFoundException,
tcAPIException
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 grouptcAPIException
- 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
@Deprecated
void setMemberGroupPriority(long plGroupKey,
long plMemberGroupKey,
int pnPriority)
throws tcAPIException,
tcGroupNotFoundException,
tcMemberGroupNotFoundException,
tcAPIException
plGroupKey
- - The key of the parent groupplMemberGroupKey
- - The key of the member grouppnPriority
- - The priority number to settcAPIException
- 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
@Deprecated
void setMemberUserPriority(long plGroupKey,
long plUserKey,
int pnPriority)
throws tcAPIException,
tcGroupNotFoundException,
tcUserNotFoundException,
tcAPIException
plGroupKey
- - The key of the groupplUserKey
- - The key of the userpnPriority
- - The new priority number to settcAPIException
- 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
@Deprecated
void updateAdministrator(long plGroupKey,
long plAdminGroupKey,
boolean pbWrite,
boolean pbDelete)
throws tcAPIException,
tcGroupNotFoundException,
tcAdminNotFoundException,
tcAPIException
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 grouptcAPIException
- 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
@Deprecated
void updateAdministrators(long plGroupKey,
long[] palAdminGroupKeys,
boolean[] pbWrite,
boolean[] pbDelete)
throws tcAdminNotFoundException,
tcGroupNotFoundException,
tcAPIException,
tcBulkException,
tcAPIException
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 grouptcAdminNotFoundException
- 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
void updateGroup(Thor.API.tcResultSet poGroupResultSet, java.util.Map phAttributeList) throws tcAPIException, tcGroupNotFoundException, tcStaleDataUpdateException, tcAPIException
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.tcAPIException
tcGroupNotFoundException
tcStaleDataUpdateException
void addForm(long plGroupKey, long plWinKey, long plParentKey, int sequence, int nestlevel) throws tcAPIException, tcGroupNotFoundException, tcFormNotFoundException, tcAPIException
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 formtcAPIException
tcGroupNotFoundException
tcFormNotFoundException
void addForms(long plGroupKey, long[] palWinKeys, long[] palParentKeys, int[] sequence, int[] nestlevel) throws tcAPIException, tcGroupNotFoundException, tcFormNotFoundException, tcBulkException, tcAPIException
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 formtcAPIException
tcGroupNotFoundException
tcFormNotFoundException
tcBulkException
void removeForm(long plGroupKey, long plWinKey) throws tcAPIException, tcGroupNotFoundException, tcFormNotFoundException, tcAPIException
plGroupKey
- the group key to remove the formplWinKey
- the form keytcAPIException
tcGroupNotFoundException
tcFormNotFoundException
void removeForms(long groupKey, long[] winKeys) throws tcAPIException, tcGroupNotFoundException, tcFormNotFoundException, tcBulkException, tcAPIException
groupKey
- the group key to remove the forms fromwinKeys
- the form keys to be removedtcAPIException
tcGroupNotFoundException
tcFormNotFoundException
tcBulkException
Thor.API.tcResultSet getAssignedForms(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
groupKey
- the group key to get the formstcAPIException
tcGroupNotFoundException
Thor.API.tcResultSet getUnassignedForms(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
groupKey
- the group key to get the formstcAPIException
tcGroupNotFoundException
Thor.API.tcResultSet getAllForms() throws tcAPIException, tcAPIException
tcAPIException
void addMenuItem(long plGroupKey, long plWinKey) throws tcAPIException, tcGroupNotFoundException, tcFormNotFoundException, tcAPIException
plGroupKey
- the group keyplWinKey
- the menu item keytcAPIException
tcGroupNotFoundException
tcFormNotFoundException
void addMenuItems(long groupKey, long[] winKeys) throws tcAPIException, tcGroupNotFoundException, tcFormNotFoundException, tcBulkException, tcAPIException
groupKey
- the group key to which the menu items to be addedwinKeys
- the menu item keys to be addedtcAPIException
tcGroupNotFoundException
tcFormNotFoundException
tcBulkException
void removeMenuItem(long plGroupKey, long plWinKey) throws tcAPIException, tcGroupNotFoundException, tcFormNotFoundException, tcAPIException
plGroupKey
- the group keyplWinKey
- the menu item keytcAPIException
tcGroupNotFoundException
tcFormNotFoundException
void removeMenuItems(long groupKey, long[] winKeys) throws tcAPIException, tcGroupNotFoundException, tcFormNotFoundException, tcBulkException, tcAPIException
groupKey
- the group key from which the menu items to be removedwinKeys
- the menu item keys to be removedtcAPIException
tcGroupNotFoundException
tcFormNotFoundException
tcBulkException
Thor.API.tcResultSet getAssignedMenuItems(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
groupKey
- the group keytcAPIException
tcGroupNotFoundException
Thor.API.tcResultSet getUnassignedMenuItems(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
groupKey
- the group keytcAPIException
tcGroupNotFoundException
Thor.API.tcResultSet getAllMenuItems() throws tcAPIException, tcAPIException
tcAPIException
void addProvisionPolicy(long plGroupKey, long plPolicyKey) throws tcAPIException, tcGroupNotFoundException, tcPolicyNotFoundException, tcAPIException
plGroupKey
- the group keyplPolicyKey
- the Policy keytcAPIException
tcGroupNotFoundException
tcPolicyNotFoundException
void addProvisionPolicies(long groupKey, long[] policykeys) throws tcAPIException, tcGroupNotFoundException, tcPolicyNotFoundException, tcBulkException, tcAPIException
groupKey
- the group keypolicykeys
- the Policy keys to be addedtcAPIException
tcGroupNotFoundException
tcPolicyNotFoundException
tcBulkException
void removeProvisionPolicy(long plGroupKey, long plPolicyKey) throws tcAPIException, tcGroupNotFoundException, tcPolicyNotFoundException, tcAPIException
plGroupKey
- the group keyplPolicyKey
- the policy keytcAPIException
tcGroupNotFoundException
tcPolicyNotFoundException
void removeProvisionPolicies(long groupKey, long[] policyKeys) throws tcAPIException, tcGroupNotFoundException, tcPolicyNotFoundException, tcBulkException, tcAPIException
groupKey
- the group keypolicyKeys
- the policy keys to be removedtcAPIException
tcGroupNotFoundException
tcPolicyNotFoundException
tcBulkException
Thor.API.tcResultSet getAssignedProvisionPolicies(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
groupKey
- the group keytcAPIException
tcGroupNotFoundException
Thor.API.tcResultSet getUnassignedProvisionPolicies(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
groupKey
- the group keytcAPIException
tcGroupNotFoundException
Thor.API.tcResultSet getAllProvisionPolicies() throws tcAPIException, tcAPIException
tcAPIException
void addMembershipRule(long plGroupKey, long plRuleKey) throws tcAPIException, tcGroupNotFoundException, tcRuleNotFoundException, tcAPIException
plGroupKey
- the group keyplRuleKey
- the Membership Rule to assigntcAPIException
tcGroupNotFoundException
tcRuleNotFoundException
void addMembershipRules(long groupKey, long[] ruleKeys) throws tcAPIException, tcGroupNotFoundException, tcRuleNotFoundException, tcBulkException, tcAPIException
groupKey
- the group keyruleKeys
- the Membership Rules to assigntcAPIException
tcGroupNotFoundException
tcRuleNotFoundException
tcBulkException
void removeMembershipRule(long plGroupKey, long plRuleKey) throws tcAPIException, tcGroupNotFoundException, tcRuleNotFoundException, tcAPIException
plGroupKey
- the group keyplRuleKey
- the Membership Rule to removetcAPIException
tcGroupNotFoundException
tcRuleNotFoundException
void removeMembershipRules(long groupKey, long[] ruleKeys) throws tcAPIException, tcGroupNotFoundException, tcRuleNotFoundException, tcBulkException, tcAPIException
groupKey
- the group keyruleKeys
- the Membership Rules to removetcAPIException
tcGroupNotFoundException
tcRuleNotFoundException
tcBulkException
Thor.API.tcResultSet getAssignedMembershipRules(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
groupKey
- the group keytcAPIException
tcGroupNotFoundException
Thor.API.tcResultSet findAssignedMembershipRules(java.util.Map searchCriteria) throws tcAPIException, tcGroupNotFoundException, tcAPIException
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.tcAPIException
- thrown if an error occurrs while retrieving the data about assigned rules from the databasetcGroupNotFoundException
Thor.API.tcResultSet getUnassignedMembershipRules(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
groupKey
- the group keytcAPIException
tcGroupNotFoundException
Thor.API.tcResultSet findUnassignedMembershipRules(java.util.Map searchCriteria) throws tcAPIException
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.tcAPIException
- thrown if an error occurrs while retrieving the data about unassigned rules from the databaseThor.API.tcResultSet getAllMembershipRules() throws tcAPIException, tcAPIException
tcAPIException
void addObjectPermission(long plGroupKey, long plDobKey, boolean insertAllow, boolean updateAllow, boolean deleteAllow) throws tcAPIException, tcGroupNotFoundException, tcDataObjectNotFoundException, tcAPIException
plGroupKey
- the group keyplDobKey
- the Object Data keyinsertAllow
- if it is allowed insertupdateAllow
- if it is allowed updatedeleteAllow
- if it is allowed deletetcAPIException
tcGroupNotFoundException
tcDataObjectNotFoundException
void addObjectPermissions(long groupKey, long[] dobKeys, boolean[] insertAllow, boolean[] updateAllow, boolean[] deleteAllow) throws tcAPIException, tcGroupNotFoundException, tcDataObjectNotFoundException, tcBulkException, tcAPIException
groupKey
- the group keydobKeys
- the Object Permission keysinsertAllow
- if it is allowed insertupdateAllow
- if it is allowed updatedeleteAllow
- if it is allowed deletetcAPIException
tcGroupNotFoundException
tcDataObjectNotFoundException
tcBulkException
void removeObjectPermission(long plGroupKey, long plObjectPermissionKey) throws tcAPIException, tcGroupNotFoundException, tcDataObjectNotFoundException, tcAPIException
plGroupKey
- the group keyplObjectPermissionKey
- the Object Permission key (dob_key)tcAPIException
tcGroupNotFoundException
tcDataObjectNotFoundException
void removeObjectPermissions(long groupKey, long[] dobKeys) throws tcAPIException, tcGroupNotFoundException, tcDataObjectNotFoundException, tcBulkException, tcAPIException
groupKey
- the group keydobKeys
- the Object Permission keystcAPIException
tcGroupNotFoundException
tcDataObjectNotFoundException
tcBulkException
Thor.API.tcResultSet getAssignedObjectPermissions(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
groupKey
- the group keytcAPIException
tcGroupNotFoundException
Thor.API.tcResultSet getUnassignedObjectPermissions(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
groupKey
- the group keytcAPIException
tcGroupNotFoundException
Thor.API.tcResultSet getAllObjectPermissions() throws tcAPIException, tcAPIException
tcAPIException
void updateObjectPermission(long groupKey, long dobKey, java.util.Map attribute) throws tcAPIException, tcGroupNotFoundException, tcDataObjectNotFoundException, tcAPIException
groupKey
- the group keydobKey
- the object permission keyattribute
- the attribute list for the insert, update, delete allowtcAPIException
tcGroupNotFoundException
tcDataObjectNotFoundException
void deleteGroup(long groupKey) throws tcAPIException, tcGroupNotFoundException, tcAPIException
groupKey
- key of the group to be deletedtcAPIException
tcGroupNotFoundException
void deleteGroups(long[] groupKeys) throws tcAPIException, tcGroupNotFoundException, tcAPIException
groupKeys
- is an array of group keys to deletetcAPIException
tcGroupNotFoundException
Thor.API.tcResultSet getAllMembers(long plGroupKey) throws tcGroupNotFoundException, tcAPIException, tcAPIException
plGroupKey
- - The key of the grouptcGroupNotFoundException
- thrown if plGroupKey does not existtcAPIException
- thrown if data set errors occurThor.API.tcResultSet getAllMembers(long plGroupKey, int startRow, int pageSize, java.lang.String order, boolean ascendingOrder) throws tcAPIException, tcGroupNotFoundException, tcAPIException
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 descendingtcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not existvoid removeAllMembers(long plGroupKey) throws tcGroupNotFoundException, tcAPIException, tcAPIException
plGroupKey
- - The key of the grouptcGroupNotFoundException
- thrown if plGroupKey does not existtcAPIException
- thrown if data set errors occurvoid updateObjectPermissions(long groupKey, DataObjectPermissions[] dataObjectPermissions) throws tcAPIException, tcGroupNotFoundException, tcDataObjectNotFoundException, tcBulkException, tcAPIException
groupKey
- the group keytcAPIException
tcGroupNotFoundException
tcDataObjectNotFoundException
tcBulkException
Thor.API.tcResultSet findUnAssignedGroups(java.util.Map phAttributeList, long plUserKey) throws tcAPIException, tcAPIException
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 the USR_KEY
column)tcAPIException
- thrown if data set errors occurThor.API.tcResultSet getAllMemberUsersAndGroups(long groupKey) throws tcGroupNotFoundException, tcAPIException, tcAPIException
plGroupKey
- - The key of the grouptcGroupNotFoundException
- thrown if plGroupKey does not existtcAPIException
- thrown if data set errors occurThor.API.tcResultSet getAllMemberUsersAndGroups(long plGroupKey, int startRow, int pageSize, java.lang.String order, boolean ascendingOrder) throws tcAPIException, tcGroupNotFoundException, tcAPIException
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 descendingtcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not existThor.API.tcResultSet getAdministrators(java.util.Map searchCriteria) throws tcAPIException, tcGroupNotFoundException, tcAPIException
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.KeytcAPIException
- 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 databseThor.API.tcResultSet getUnassignedAdministrators(java.util.Map searchCriteria) throws tcAPIException, tcGroupNotFoundException, tcAPIException
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.KeytcAPIException
- 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 databseThor.API.tcResultSet getAssignedObjectPermissions(java.util.Map searchCriteria) throws tcAPIException, tcGroupNotFoundException, tcAPIException
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 BytcAPIException
tcGroupNotFoundException
Thor.API.tcResultSet getUnassignedObjectPermissions(java.util.Map searchCriteria) throws tcAPIException, tcGroupNotFoundException, tcAPIException
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 BytcAPIException
tcGroupNotFoundException
Thor.API.tcResultSet findGroupsFiltered(java.util.Map attributeMap, java.lang.String[] fieldsList, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder) throws tcAPIException, tcAPIException
tcResultSet
can be specified.attributeMap
- A Map
of attribute-value pairs with each entry containing criteria to find users. The Map
key should contain a String
representation of the metadata codes and/or user-defined columns. The metadata codes are listed below in the contents of the returned tcResultSet. The Map
value can contain a String
representation of the criteria to find the desired requests. Note that the Map
values can include wild cards(%).fieldsList
- The list of fields that is to be returned in the tcResultSet
. This can include user-defined fields as well as any of the following metadata codes:
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 descendingtcResultSet
that contains the fields specified in pasFieldList
.tcAPIException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |