Thor.API.Operations
Interface tcGroupOperationsIntf

public interface tcGroupOperationsIntf

Method Summary

void	addAdministrator(long plGroupKey, long plAdminGroupKey, boolean pbWrite, boolean pbDelete) Adds a group to have administrative control over the specified group
void	addAdministrators(long plGroupKey, long[] palAdminGroupKeys, boolean[] pbWrite, boolean[] pbDelete) Adds a list of groups to have administrative control over the specified group
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	addMemberUsers(long plGroupKey, long[] paUserKeys) Adds the specified users to the specified group.
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
void	addReports(long groupKey, long[] reportKeys) Adds a list of reports to the specified 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 Xellerate
void	deleteGroups(long[] groupKeys) Deletes a set of groups from the array of group keys
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	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	getAdministrators(long plGroupKey) 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	getAllMembershipRules() Returns all the available Membership Rules in Xellerate
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	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	getAssignedProvisionPolicies(long groupKey) Returns all the assign Provision Policies from a given group
Thor.API.tcResultSet	getAssignedReports(long plGroupKey) Returns all the assigned Reports for 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	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	getUnassignedProvisionPolicies(long groupKey) Returns all the unassigned Provision Policies from a given group
Thor.API.tcResultSet	getUnassignedReports(long plGroupKey) Returns all the unassigned Reports for 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
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	removeMemberUsers(long plGroupKey, long[] paUserKeys) Removes the specified users from the specified group.
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	removeReports(long groupKey, long[] reportKeys) Removes a list of reports from the specified group
void	setMemberGroupPriority(long plGroupKey, long plMemberGroupKey, int pnPriority) Set the priority of a group member in the specified group
void	setMemberUserPriority(long plGroupKey, long plUserKey, int pnPriority) Set the priority of a user member in the specified group
void	updateAdministrator(long plGroupKey, long plAdminGroupKey, boolean pbWrite, boolean pbDelete) Updates the administrative access a group has over the specified group
void	updateAdministrators(long plGroupKey, long[] palAdminGroupKeys, boolean[] pbWrite, boolean[] pbDelete) Updates the administrative access for a list of groups over the specified group
void	updateGroup(Thor.API.tcResultSet poGroupResultSet, java.util.Map phAttributeList) Updates a group in Xellerate.
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, com.thortech.xl.vo.DataObjectPermissions[] dataObjectPermissions) Updates the object permission of the given adminisrtators of the object for the allow fields: insert, update, delete

Method Detail

addAdministrator

public void addAdministrator(long plGroupKey,
                             long plAdminGroupKey,
                             boolean pbWrite,
                             boolean pbDelete)
                      throws Thor.API.Exceptions.tcAPIException,
                             Thor.API.Exceptions.tcGroupNotFoundException,
                             Thor.API.Exceptions.tcAdminNotFoundException,
                             Thor.API.Exceptions.tcAdminGroupInvalidException,
                             tcAPIException

Adds a group to have administrative control over the specified group

Parameters:

plGroupKey - - The key of the group

plAdminGroupKey - - The key of the admin group

pbWrite - - Whether the group has write access to the group

pbDelete - - Whether the group has delete access to the group

Throws:

tcAPIException - thrown if errors occur in the data set OR while saving

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcAdminNotFoundException - thrown if plAdminGroupKey does not exist

tcAdminGroupInvalidException - thrown if administrator is not allowed to be added

addAdministrators

public void addAdministrators(long plGroupKey,
                              long[] palAdminGroupKeys,
                              boolean[] pbWrite,
                              boolean[] pbDelete)
                       throws Thor.API.Exceptions.tcAdminNotFoundException,
                              Thor.API.Exceptions.tcAdminGroupInvalidException,
                              Thor.API.Exceptions.tcGroupNotFoundException,
                              Thor.API.Exceptions.tcAPIException,
                              Thor.API.Exceptions.tcBulkException,
                              tcAPIException

Adds a list of groups to have administrative control over the specified group

Parameters:

plGroupKey - - The key of the group

palAdminGroupKeys - - The keys of the admin groups

pbWrite - - Whether the admin groups to have write access over the specified group

pbDelete - - Whether the admin groups to have delete access over the specified group

Throws:

tcAdminNotFoundException - thrown if one or many palAdminGroupKeys do not exist

tcAdminGroupInvalidException - thrown if administrator is not allowed to be updated

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcAPIException - thrown if errors occur in the data set OR while saving

tcBulkException

addMemberGroup

public void addMemberGroup(long plGroupKey,
                           long plMemberGroupKey)
                    throws Thor.API.Exceptions.tcAPIException,
                           Thor.API.Exceptions.tcGroupNotFoundException,
                           Thor.API.Exceptions.tcInvalidMemberGroupException,
                           Thor.API.Exceptions.tcMemberGroupNotFoundException,
                           tcAPIException

Adds a group as a member to the specified group.

Parameters:

plGroupKey - - The key of the group to add the member to

plMemberGroupKey - - The key of the group to add as a member

Throws:

tcAPIException - thrown if data set errors occur OR while saving

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcInvalidMemberGroupException - thrown if member is not allowed to be added to the group

tcMemberGroupNotFoundException - thrown if plMemberGroupKey does not exist

addMemberGroups

public void addMemberGroups(long plGroupKey,
                            long[] palMemberGroupKeys)
                     throws Thor.API.Exceptions.tcGroupNotFoundException,
                            Thor.API.Exceptions.tcInvalidMemberGroupException,
                            Thor.API.Exceptions.tcMemberGroupNotFoundException,
                            Thor.API.Exceptions.tcAPIException,
                            Thor.API.Exceptions.tcBulkException,
                            tcAPIException

Adds a list of user groups as members to the specified group.

Parameters:

plGroupKey - - The key of the group to add members to

palMemberGroupKeys - - The keys of the member groups to be added

Throws:

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcInvalidMemberGroupException - thrown if member is not allowed to be added to the group

tcMemberGroupNotFoundException - thrown if one or many palMemberGroupKeys do not exist

tcAPIException - thrown if data set errors occur OR while saving

tcBulkException

addMemberUser

public void addMemberUser(long plGroupKey,
                          long plUserKey)
                   throws Thor.API.Exceptions.tcAPIException,
                          Thor.API.Exceptions.tcGroupNotFoundException,
                          Thor.API.Exceptions.tcUserNotFoundException,
                          tcAPIException

Adds the specified user to the specified group.

Parameters:

plGroupKey - - The key of the group to add the user to

plUserKey - - The key of the user to add

Throws:

tcAPIException - thrown if data set errors occur OR while saving

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcUserNotFoundException - thrown if plUserKey does not exist

addMemberUsers

public void addMemberUsers(long plGroupKey,
                           long[] paUserKeys)
                    throws Thor.API.Exceptions.tcAPIException,
                           Thor.API.Exceptions.tcGroupNotFoundException,
                           Thor.API.Exceptions.tcUserNotFoundException,
                           tcAPIException

Adds the specified users to the specified group.

Parameters:

plGroupKey - - The key of the group to add the user to

paUserKeys - - The key of the user to add

Throws:

tcAPIException - thrown if data set errors occur OR while saving

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcUserNotFoundException - thrown if plUserKey does not exist

createGroup

public long createGroup(java.util.Map phAttributes)
                 throws Thor.API.Exceptions.tcAPIException,
                        Thor.API.Exceptions.tcDuplicateGroupException,
                        Thor.API.Exceptions.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 saving

tcDuplicateGroupException - thrown if Group Name already exists

tcInvalidAttributeException - thrown if a group key is provided as an attribute

decreaseMemberGroupPriority

public void decreaseMemberGroupPriority(long plGroupKey,
                                        long plMemberGroupKey)
                                 throws Thor.API.Exceptions.tcAPIException,
                                        Thor.API.Exceptions.tcGroupNotFoundException,
                                        Thor.API.Exceptions.tcMemberGroupNotFoundException,
                                        tcAPIException

Decrease the priority of a group member in the specified group

Parameters:

plGroupKey - - The key of the parent group

plMemberGroupKey - - The key of the member group

Throws:

tcAPIException - thrown if data set errors occur OR while saving OR member group doesn't correspong to group

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcMemberGroupNotFoundException - thrown if plMemberGroupKey does not exist

decreaseMemberUserPriority

public void decreaseMemberUserPriority(long plGroupKey,
                                       long plUserKey)
                                throws Thor.API.Exceptions.tcAPIException,
                                       Thor.API.Exceptions.tcUserNotFoundException,
                                       Thor.API.Exceptions.tcGroupNotFoundException,
                                       tcAPIException

Decrease the priority of a user member in the specified group

Parameters:

plGroupKey - - The key of the group

plUserKey - - The key of the user

Throws:

tcAPIException - thrown if data set errors occur OR while saving OR user doesn't correspong to group

tcUserNotFoundException - thrown if plUserKey does not exist

tcGroupNotFoundException - thrown if plGroupKey does not exist

findGroups

public Thor.API.tcResultSet findGroups(java.util.Map phAttributeList)
                                throws Thor.API.Exceptions.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 Xellerate 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

public Thor.API.tcResultSet findGroups(java.util.Map phAttributeList,
                                       java.lang.String permission)
                                throws Thor.API.Exceptions.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 Xellerate 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

public Thor.API.tcResultSet getAdministrators(long plGroupKey)
                                       throws Thor.API.Exceptions.tcAPIException,
                                              Thor.API.Exceptions.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 occur

tcGroupNotFoundException - thrown if plGroupKey does not exist

getUnassignedMemberUsers

public Thor.API.tcResultSet getUnassignedMemberUsers(long groupKey,
                                                     java.util.Map attributeMap)
                                              throws Thor.API.Exceptions.tcGroupNotFoundException,
                                                     Thor.API.Exceptions.tcAPIException,
                                                     tcAPIException

Gets a list of the users that are not assigned as members of the given group

Returns:

Result set containing the unassigned users

Throws:

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcAPIException - thrown if data set errors occur

getUnassignedMemberGroups

public Thor.API.tcResultSet getUnassignedMemberGroups(long groupKey,
                                                      java.util.Map attributeMap)
                                               throws Thor.API.Exceptions.tcGroupNotFoundException,
                                                      Thor.API.Exceptions.tcAPIException,
                                                      tcAPIException

Gets a list of the groups that are not assigned as member groups of the given group

Returns:

Result set containing the unassigned groups

Throws:

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcAPIException - thrown if data set errors occur

getUnassignedAdministrators

public Thor.API.tcResultSet getUnassignedAdministrators(long plGroupKey)
                                                 throws Thor.API.Exceptions.tcGroupNotFoundException,
                                                        Thor.API.Exceptions.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 exist

tcAPIException - thrown if data set errors occur

getAllMemberUsers

public Thor.API.tcResultSet getAllMemberUsers(long plGroupKey)
                                       throws Thor.API.Exceptions.tcAPIException,
                                              Thor.API.Exceptions.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 occur

tcGroupNotFoundException - thrown if plGroupKey does not exist

getAllMemberUsers

public Thor.API.tcResultSet getAllMemberUsers(long plGroupKey,
                                              int startRow,
                                              int pageSize,
                                              java.lang.String order,
                                              boolean ascendingOrder)
                                       throws Thor.API.Exceptions.tcAPIException,
                                              Thor.API.Exceptions.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

startRow - - The starting row of the result

pageSize - - The end row of the result

order - - 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 occur

tcGroupNotFoundException - thrown if plGroupKey does not exist

getMemberGroups

public Thor.API.tcResultSet getMemberGroups(long plGroupKey)
                                     throws Thor.API.Exceptions.tcAPIException,
                                            Thor.API.Exceptions.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 occur

tcGroupNotFoundException - thrown if plGroupKey does not exist

getAllMemberGroups

public Thor.API.tcResultSet getAllMemberGroups(long plGroupKey)
                                        throws Thor.API.Exceptions.tcAPIException,
                                               Thor.API.Exceptions.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 occur

tcGroupNotFoundException - thrown if plGroupKey does not exist

getAllMemberGroupsData

public com.thortech.xl.orb.dataaccess.tcDataSetData getAllMemberGroupsData(long plGroupKey)
                                                                    throws Thor.API.Exceptions.tcAPIException,
                                                                           Thor.API.Exceptions.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 occur

tcGroupNotFoundException - thrown if plGroupKey does not exist

getAllParentGroups

public Thor.API.tcResultSet getAllParentGroups(long groupKey)
                                        throws Thor.API.Exceptions.tcAPIException,
                                               Thor.API.Exceptions.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 occur

tcGroupNotFoundException - thrown if plGroupKey does not exist

getMemberUsers

public Thor.API.tcResultSet getMemberUsers(long plGroupKey)
                                    throws Thor.API.Exceptions.tcAPIException,
                                           Thor.API.Exceptions.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 occur

tcGroupNotFoundException - thrown if plGroupKey does not exist

increaseMemberGroupPriority

public void increaseMemberGroupPriority(long plGroupKey,
                                        long plMemberGroupKey)
                                 throws Thor.API.Exceptions.tcAPIException,
                                        Thor.API.Exceptions.tcGroupNotFoundException,
                                        Thor.API.Exceptions.tcMemberGroupNotFoundException,
                                        tcAPIException

Increase the priority of a group member in the specified group

Parameters:

plGroupKey - - The key of the parent group

plMemberGroupKey - - The key of the member group

Throws:

tcAPIException - thrown if data set errors occur OR while saving OR member group doesn't correspong to group

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcMemberGroupNotFoundException - thrown if plMemberGroupKey does not exist

increaseMemberUserPriority

public void increaseMemberUserPriority(long plGroupKey,
                                       long plUserKey)
                                throws Thor.API.Exceptions.tcAPIException,
                                       Thor.API.Exceptions.tcGroupNotFoundException,
                                       Thor.API.Exceptions.tcUserNotFoundException,
                                       tcAPIException

Increase the priority of a user member in the specified group

Parameters:

plGroupKey - - The key of the group

plUserKey - - The key of the user

Throws:

tcAPIException - thrown if data set errors occur OR while saving OR User does not correspond to group

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcUserNotFoundException - thrown if plUserKey does not exist

removeAdministrator

public void removeAdministrator(long plGroupKey,
                                long plAdminGroupKey)
                         throws Thor.API.Exceptions.tcAPIException,
                                Thor.API.Exceptions.tcGroupNotFoundException,
                                Thor.API.Exceptions.tcAdminNotFoundException,
                                tcAPIException

Removes a group from having administrative control over the specified group

Parameters:

plGroupKey - - The key of the group

plAdminGroupKey - - 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 key

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcAdminNotFoundException - thrown if plAdminGroupKey does not exist

removeAdministrators

public void removeAdministrators(long plGroupKey,
                                 long[] palAdminGroupKeys)
                          throws Thor.API.Exceptions.tcAdminNotFoundException,
                                 Thor.API.Exceptions.tcGroupNotFoundException,
                                 Thor.API.Exceptions.tcAPIException,
                                 Thor.API.Exceptions.tcBulkException,
                                 tcAPIException

Removes a list of groups from having administrative control over a specified group

Parameters:

plGroupKey - - The key of the group

palAdminGroupKeys - - The keys of the admin groups

Throws:

tcAdminNotFoundException - thrown if one or many palAdminGroupKeys do not exist

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcAPIException - thrown if data set errors occur OR while saving OR Group key doesn't correspond to Administrator Group keys

tcBulkException

removeMemberGroup

public void removeMemberGroup(long plGroupKey,
                              long plMemberGroupKey)
                       throws Thor.API.Exceptions.tcAPIException,
                              Thor.API.Exceptions.tcGroupNotFoundException,
                              Thor.API.Exceptions.tcMemberGroupNotFoundException,
                              tcAPIException

Removes the specified member group from the specified group.

Parameters:

plGroupKey - - The key of the group to remove the member group from

plMemberGroupKey - - 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 key

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcMemberGroupNotFoundException - thrown if plMemberGroupKey does not exist

removeMemberGroups

public void removeMemberGroups(long plGroupKey,
                               long[] palMemberGroupKeys)
                        throws Thor.API.Exceptions.tcGroupNotFoundException,
                               Thor.API.Exceptions.tcInvalidMemberGroupException,
                               Thor.API.Exceptions.tcMemberGroupNotFoundException,
                               Thor.API.Exceptions.tcAPIException,
                               Thor.API.Exceptions.tcBulkException,
                               tcAPIException

Removes a list of user group members from the specified group.

Parameters:

plGroupKey - - The key of the group to remove the members from

palMemberGroupKeys - - The keys of the member groups to remove

Throws:

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcInvalidMemberGroupException - thrown if member is not allowed to remove from the group

tcMemberGroupNotFoundException - thrown if one or many palMemberGroupKeys do not exist

tcAPIException - thrown if data set errors occur OR while saving

tcBulkException

removeMemberUser

public void removeMemberUser(long plGroupKey,
                             long plUserKey)
                      throws Thor.API.Exceptions.tcAPIException,
                             Thor.API.Exceptions.tcGroupNotFoundException,
                             Thor.API.Exceptions.tcUserNotFoundException,
                             tcAPIException

Removes the specified user from the specified group.

Parameters:

plGroupKey - - The key of the group to remove the user from

plUserKey - - 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 correspond

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcUserNotFoundException - thrown if plUserKey does not exist

removeMemberUsers

public void removeMemberUsers(long plGroupKey,
                              long[] paUserKeys)
                       throws Thor.API.Exceptions.tcAPIException,
                              Thor.API.Exceptions.tcGroupNotFoundException,
                              Thor.API.Exceptions.tcUserNotFoundException,
                              tcAPIException

Removes the specified users from the specified group.

Parameters:

plGroupKey - - The key of the group to remove the user from

paUserKeys - - 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 correspond

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcUserNotFoundException - thrown if plUserKey does not exist

setMemberGroupPriority

public void setMemberGroupPriority(long plGroupKey,
                                   long plMemberGroupKey,
                                   int pnPriority)
                            throws Thor.API.Exceptions.tcAPIException,
                                   Thor.API.Exceptions.tcGroupNotFoundException,
                                   Thor.API.Exceptions.tcMemberGroupNotFoundException,
                                   tcAPIException

Set the priority of a group member in the specified group

Parameters:

plGroupKey - - The key of the parent group

plMemberGroupKey - - The key of the member group

pnPriority - - 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 key

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcMemberGroupNotFoundException - thrown if plMemberGroupKey does not exist

setMemberUserPriority

public void setMemberUserPriority(long plGroupKey,
                                  long plUserKey,
                                  int pnPriority)
                           throws Thor.API.Exceptions.tcAPIException,
                                  Thor.API.Exceptions.tcGroupNotFoundException,
                                  Thor.API.Exceptions.tcUserNotFoundException,
                                  tcAPIException

Set the priority of a user member in the specified group

Parameters:

plGroupKey - - The key of the group

plUserKey - - The key of the user

pnPriority - - The new priority number to set

Throws:

tcAPIException - thrown if data set errors occur OR while saving OR Group and User keys do not correspond

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcUserNotFoundException - thrown if plUserKey does not exist

updateAdministrator

public void updateAdministrator(long plGroupKey,
                                long plAdminGroupKey,
                                boolean pbWrite,
                                boolean pbDelete)
                         throws Thor.API.Exceptions.tcAPIException,
                                Thor.API.Exceptions.tcGroupNotFoundException,
                                Thor.API.Exceptions.tcAdminNotFoundException,
                                tcAPIException

Updates the administrative access a group has over the specified group

Parameters:

plGroupKey - - The key of the group

plAdminGroupKey - - The key of the admin group

pbWrite - - Whether the group has write access to the group

pbDelete - - 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 plAdminGroupKey

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcAdminNotFoundException - thrown if plAdminGroupKey does not exist

updateAdministrators

public void updateAdministrators(long plGroupKey,
                                 long[] palAdminGroupKeys,
                                 boolean[] pbWrite,
                                 boolean[] pbDelete)
                          throws Thor.API.Exceptions.tcAdminNotFoundException,
                                 Thor.API.Exceptions.tcGroupNotFoundException,
                                 Thor.API.Exceptions.tcAPIException,
                                 Thor.API.Exceptions.tcBulkException,
                                 tcAPIException

Updates the administrative access for a list of groups over the specified group

Parameters:

plGroupKey - - The key of the group

palAdminGroupKeys - - List of keys of the admin groups

pbWrite - - Whether the admin groups to have write access over the specified group

pbDelete - - Whether the admin groups to have delete access over the specified group

Throws:

tcAdminNotFoundException - thrown if one or many palAdminGroupKeys do not exist

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcAPIException - thrown if data set errors occur OR while saving OR plGroupKey does not correspond with palAdminGroupKeys

tcBulkException

updateGroup

public void updateGroup(Thor.API.tcResultSet poGroupResultSet,
                        java.util.Map phAttributeList)
                 throws Thor.API.Exceptions.tcAPIException,
                        Thor.API.Exceptions.tcGroupNotFoundException,
                        tcAPIException

Updates a group in Xellerate. 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 Xellerate 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

addForm

public void addForm(long plGroupKey,
                    long plWinKey,
                    long plParentKey,
                    int sequence,
                    int nestlevel)
             throws Thor.API.Exceptions.tcAPIException,
                    Thor.API.Exceptions.tcGroupNotFoundException,
                    Thor.API.Exceptions.tcFormNotFoundException,
                    tcAPIException

Adds a form to a given group

Parameters:

plGroupKey - is the group key to add the form to

plWinKey - is the form key that we want to add

plParentKey - is the parent form key

sequence - is the sequence for this form

nestlevel - is the level nested for this form

Throws:

tcAPIException

tcGroupNotFoundException

tcFormNotFoundException

addForms

public void addForms(long plGroupKey,
                     long[] palWinKeys,
                     long[] palParentKeys,
                     int[] sequence,
                     int[] nestlevel)
              throws Thor.API.Exceptions.tcAPIException,
                     Thor.API.Exceptions.tcGroupNotFoundException,
                     Thor.API.Exceptions.tcFormNotFoundException,
                     Thor.API.Exceptions.tcBulkException,
                     tcAPIException

Adds a set of form to a given group

Parameters:

plGroupKey - is the group key to add the form to

palWinKeys - is the form key that we want to add

palParentKeys - is the parent form key

sequence - is the sequence for this form

nestlevel - is the level nested for this form

Throws:

tcAPIException

tcGroupNotFoundException

tcFormNotFoundException

tcBulkException

removeForm

public void removeForm(long plGroupKey,
                       long plWinKey)
                throws Thor.API.Exceptions.tcAPIException,
                       Thor.API.Exceptions.tcGroupNotFoundException,
                       Thor.API.Exceptions.tcFormNotFoundException,
                       tcAPIException

Removes a specific form from a group

Parameters:

plGroupKey - the group key to remove the form

plWinKey - the form key

Throws:

tcAPIException

tcGroupNotFoundException

tcFormNotFoundException

removeForms

public void removeForms(long groupKey,
                        long[] winKeys)
                 throws Thor.API.Exceptions.tcAPIException,
                        Thor.API.Exceptions.tcGroupNotFoundException,
                        Thor.API.Exceptions.tcFormNotFoundException,
                        Thor.API.Exceptions.tcBulkException,
                        tcAPIException

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 from

winKeys - the form keys to be removed

Throws:

tcAPIException

tcGroupNotFoundException

tcFormNotFoundException

tcBulkException

getAssignedForms

public Thor.API.tcResultSet getAssignedForms(long groupKey)
                                      throws Thor.API.Exceptions.tcAPIException,
                                             Thor.API.Exceptions.tcGroupNotFoundException,
                                             tcAPIException

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

public Thor.API.tcResultSet getUnassignedForms(long groupKey)
                                        throws Thor.API.Exceptions.tcAPIException,
                                               Thor.API.Exceptions.tcGroupNotFoundException,
                                               tcAPIException

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

public Thor.API.tcResultSet getAllForms()
                                 throws Thor.API.Exceptions.tcAPIException,
                                        tcAPIException

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

public void addMenuItem(long plGroupKey,
                        long plWinKey)
                 throws Thor.API.Exceptions.tcAPIException,
                        Thor.API.Exceptions.tcGroupNotFoundException,
                        Thor.API.Exceptions.tcFormNotFoundException,
                        tcAPIException

Adds a menu item to the specified group

Parameters:

plGroupKey - the group key

plWinKey - the menu item key

Throws:

tcAPIException

tcGroupNotFoundException

tcFormNotFoundException

addMenuItems

public void addMenuItems(long groupKey,
                         long[] winKeys)
                  throws Thor.API.Exceptions.tcAPIException,
                         Thor.API.Exceptions.tcGroupNotFoundException,
                         Thor.API.Exceptions.tcFormNotFoundException,
                         Thor.API.Exceptions.tcBulkException,
                         tcAPIException

Adds a list of menu items to the specified group

Parameters:

groupKey - the group key to which the menu items to be added

winKeys - the menu item keys to be added

Throws:

tcAPIException

tcGroupNotFoundException

tcFormNotFoundException

tcBulkException

removeMenuItem

public void removeMenuItem(long plGroupKey,
                           long plWinKey)
                    throws Thor.API.Exceptions.tcAPIException,
                           Thor.API.Exceptions.tcGroupNotFoundException,
                           Thor.API.Exceptions.tcFormNotFoundException,
                           tcAPIException

Removes the given menu item from a given group

Parameters:

plGroupKey - the group key

plWinKey - the menu item key

Throws:

tcAPIException

tcGroupNotFoundException

tcFormNotFoundException

removeMenuItems

public void removeMenuItems(long groupKey,
                            long[] winKeys)
                     throws Thor.API.Exceptions.tcAPIException,
                            Thor.API.Exceptions.tcGroupNotFoundException,
                            Thor.API.Exceptions.tcFormNotFoundException,
                            Thor.API.Exceptions.tcBulkException,
                            tcAPIException

Removes a list of menu items from the specified group

Parameters:

groupKey - the group key from which the menu items to be removed

winKeys - the menu item keys to be removed

Throws:

tcAPIException

tcGroupNotFoundException

tcFormNotFoundException

tcBulkException

getAssignedMenuItems

public Thor.API.tcResultSet getAssignedMenuItems(long groupKey)
                                          throws Thor.API.Exceptions.tcAPIException,
                                                 Thor.API.Exceptions.tcGroupNotFoundException,
                                                 tcAPIException

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

public Thor.API.tcResultSet getUnassignedMenuItems(long groupKey)
                                            throws Thor.API.Exceptions.tcAPIException,
                                                   Thor.API.Exceptions.tcGroupNotFoundException,
                                                   tcAPIException

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

public Thor.API.tcResultSet getAllMenuItems()
                                     throws Thor.API.Exceptions.tcAPIException,
                                            tcAPIException

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

public void addProvisionPolicy(long plGroupKey,
                               long plPolicyKey)
                        throws Thor.API.Exceptions.tcAPIException,
                               Thor.API.Exceptions.tcGroupNotFoundException,
                               Thor.API.Exceptions.tcPolicyNotFoundException,
                               tcAPIException

Adds a Provision Policy to a given group

Parameters:

plGroupKey - the group key

plPolicyKey - the Policy key

Throws:

tcAPIException

tcGroupNotFoundException

tcPolicyNotFoundException

addProvisionPolicies

public void addProvisionPolicies(long groupKey,
                                 long[] policykeys)
                          throws Thor.API.Exceptions.tcAPIException,
                                 Thor.API.Exceptions.tcGroupNotFoundException,
                                 Thor.API.Exceptions.tcPolicyNotFoundException,
                                 Thor.API.Exceptions.tcBulkException,
                                 tcAPIException

Adds a list of Provision Policies to the specified group

Parameters:

groupKey - the group key

policykeys - the Policy keys to be added

Throws:

tcAPIException

tcGroupNotFoundException

tcPolicyNotFoundException

tcBulkException

removeProvisionPolicy

public void removeProvisionPolicy(long plGroupKey,
                                  long plPolicyKey)
                           throws Thor.API.Exceptions.tcAPIException,
                                  Thor.API.Exceptions.tcGroupNotFoundException,
                                  Thor.API.Exceptions.tcPolicyNotFoundException,
                                  tcAPIException

Removes an assigned Provision Policy from the group

Parameters:

plGroupKey - the group key

plPolicyKey - the policy key

Throws:

tcAPIException

tcGroupNotFoundException

tcPolicyNotFoundException

removeProvisionPolicies

public void removeProvisionPolicies(long groupKey,
                                    long[] policyKeys)
                             throws Thor.API.Exceptions.tcAPIException,
                                    Thor.API.Exceptions.tcGroupNotFoundException,
                                    Thor.API.Exceptions.tcPolicyNotFoundException,
                                    Thor.API.Exceptions.tcBulkException,
                                    tcAPIException

Removes a list of assigned Provision Policies from the specified group

Parameters:

groupKey - the group key

policyKeys - the policy keys to be removed

Throws:

tcAPIException

tcGroupNotFoundException

tcPolicyNotFoundException

tcBulkException

getAssignedProvisionPolicies

public Thor.API.tcResultSet getAssignedProvisionPolicies(long groupKey)
                                                  throws Thor.API.Exceptions.tcAPIException,
                                                         Thor.API.Exceptions.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

public Thor.API.tcResultSet getUnassignedProvisionPolicies(long groupKey)
                                                    throws Thor.API.Exceptions.tcAPIException,
                                                           Thor.API.Exceptions.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

public Thor.API.tcResultSet getAllProvisionPolicies()
                                             throws Thor.API.Exceptions.tcAPIException,
                                                    tcAPIException

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

public void addMembershipRule(long plGroupKey,
                              long plRuleKey)
                       throws Thor.API.Exceptions.tcAPIException,
                              Thor.API.Exceptions.tcGroupNotFoundException,
                              Thor.API.Exceptions.tcRuleNotFoundException,
                              tcAPIException

Adds the Membership Rule to a given group

Parameters:

plGroupKey - the group key

plRuleKey - the Membership Rule to assign

Throws:

tcAPIException

tcGroupNotFoundException

tcRuleNotFoundException

addMembershipRules

public void addMembershipRules(long groupKey,
                               long[] ruleKeys)
                        throws Thor.API.Exceptions.tcAPIException,
                               Thor.API.Exceptions.tcGroupNotFoundException,
                               Thor.API.Exceptions.tcRuleNotFoundException,
                               Thor.API.Exceptions.tcBulkException,
                               tcAPIException

Adds a list of Membership Rules to a given group

Parameters:

groupKey - the group key

ruleKeys - the Membership Rules to assign

Throws:

tcAPIException

tcGroupNotFoundException

tcRuleNotFoundException

tcBulkException

removeMembershipRule

public void removeMembershipRule(long plGroupKey,
                                 long plRuleKey)
                          throws Thor.API.Exceptions.tcAPIException,
                                 Thor.API.Exceptions.tcGroupNotFoundException,
                                 Thor.API.Exceptions.tcRuleNotFoundException,
                                 tcAPIException

Removes a Membership Rule from a group

Parameters:

plGroupKey - the group key

plRuleKey - the Membership Rule to remove

Throws:

tcAPIException

tcGroupNotFoundException

tcRuleNotFoundException

removeMembershipRules

public void removeMembershipRules(long groupKey,
                                  long[] ruleKeys)
                           throws Thor.API.Exceptions.tcAPIException,
                                  Thor.API.Exceptions.tcGroupNotFoundException,
                                  Thor.API.Exceptions.tcRuleNotFoundException,
                                  Thor.API.Exceptions.tcBulkException,
                                  tcAPIException

Removes a list of Membership Rules from a group

Parameters:

groupKey - the group key

ruleKeys - the Membership Rules to remove

Throws:

tcAPIException

tcGroupNotFoundException

tcRuleNotFoundException

tcBulkException

getAssignedMembershipRules

public Thor.API.tcResultSet getAssignedMembershipRules(long groupKey)
                                                throws Thor.API.Exceptions.tcAPIException,
                                                       Thor.API.Exceptions.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

getUnassignedMembershipRules

public Thor.API.tcResultSet getUnassignedMembershipRules(long groupKey)
                                                  throws Thor.API.Exceptions.tcAPIException,
                                                         Thor.API.Exceptions.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

getAllMembershipRules

public Thor.API.tcResultSet getAllMembershipRules()
                                           throws Thor.API.Exceptions.tcAPIException,
                                                  tcAPIException

Returns all the available Membership Rules in Xellerate

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

public void addObjectPermission(long plGroupKey,
                                long plDobKey,
                                boolean insertAllow,
                                boolean updateAllow,
                                boolean deleteAllow)
                         throws Thor.API.Exceptions.tcAPIException,
                                Thor.API.Exceptions.tcGroupNotFoundException,
                                Thor.API.Exceptions.tcDataObjectNotFoundException,
                                tcAPIException

Adds an object permission to a given group

Parameters:

plGroupKey - the group key

plDobKey - the Object Data key

insertAllow - if it is allowed insert

updateAllow - if it is allowed update

deleteAllow - if it is allowed delete

Throws:

tcAPIException

tcGroupNotFoundException

tcDataObjectNotFoundException

addObjectPermissions

public void addObjectPermissions(long groupKey,
                                 long[] dobKeys,
                                 boolean[] insertAllow,
                                 boolean[] updateAllow,
                                 boolean[] deleteAllow)
                          throws Thor.API.Exceptions.tcAPIException,
                                 Thor.API.Exceptions.tcGroupNotFoundException,
                                 Thor.API.Exceptions.tcDataObjectNotFoundException,
                                 Thor.API.Exceptions.tcBulkException,
                                 tcAPIException

Adds object permissions to a given group

Parameters:

groupKey - the group key

dobKeys - the Object Permission keys

insertAllow - if it is allowed insert

updateAllow - if it is allowed update

deleteAllow - if it is allowed delete

Throws:

tcAPIException

tcGroupNotFoundException

tcDataObjectNotFoundException

tcBulkException

removeObjectPermission

public void removeObjectPermission(long plGroupKey,
                                   long plObjectPermissionKey)
                            throws Thor.API.Exceptions.tcAPIException,
                                   Thor.API.Exceptions.tcGroupNotFoundException,
                                   Thor.API.Exceptions.tcDataObjectNotFoundException,
                                   tcAPIException

Removes assigned Object Permission from the group

Parameters:

plGroupKey - the group key

plObjectPermissionKey - the Object Permission key (dob_key)

Throws:

tcAPIException

tcGroupNotFoundException

tcDataObjectNotFoundException

removeObjectPermissions

public void removeObjectPermissions(long groupKey,
                                    long[] dobKeys)
                             throws Thor.API.Exceptions.tcAPIException,
                                    Thor.API.Exceptions.tcGroupNotFoundException,
                                    Thor.API.Exceptions.tcDataObjectNotFoundException,
                                    Thor.API.Exceptions.tcBulkException,
                                    tcAPIException

Removes assigned Object Permissions from the group

Parameters:

groupKey - the group key

dobKeys - the Object Permission keys

Throws:

tcAPIException

tcGroupNotFoundException

tcDataObjectNotFoundException

tcBulkException

getAssignedObjectPermissions

public Thor.API.tcResultSet getAssignedObjectPermissions(long groupKey)
                                                  throws Thor.API.Exceptions.tcAPIException,
                                                         Thor.API.Exceptions.tcGroupNotFoundException,
                                                         tcAPIException

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

public Thor.API.tcResultSet getUnassignedObjectPermissions(long groupKey)
                                                    throws Thor.API.Exceptions.tcAPIException,
                                                           Thor.API.Exceptions.tcGroupNotFoundException,
                                                           tcAPIException

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

public Thor.API.tcResultSet getAllObjectPermissions()
                                             throws Thor.API.Exceptions.tcAPIException,
                                                    tcAPIException

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

public void updateObjectPermission(long groupKey,
                                   long dobKey,
                                   java.util.Map attribute)
                            throws Thor.API.Exceptions.tcAPIException,
                                   Thor.API.Exceptions.tcGroupNotFoundException,
                                   Thor.API.Exceptions.tcDataObjectNotFoundException,
                                   tcAPIException

Updates the object permission for the allow fields: insert, update, delete

Parameters:

groupKey - the group key

dobKey - the object permission key

attribute - the attribute list for the insert, update, delete allow

Throws:

tcAPIException

tcGroupNotFoundException

tcDataObjectNotFoundException

deleteGroup

public void deleteGroup(long groupKey)
                 throws Thor.API.Exceptions.tcAPIException,
                        Thor.API.Exceptions.tcGroupNotFoundException,
                        tcAPIException

Deletes a group from the Xellerate

Parameters:

groupKey - key of the group to be deleted

Throws:

tcAPIException

tcGroupNotFoundException

deleteGroups

public void deleteGroups(long[] groupKeys)
                  throws Thor.API.Exceptions.tcAPIException,
                         Thor.API.Exceptions.tcGroupNotFoundException,
                         tcAPIException

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

public Thor.API.tcResultSet getAllMembers(long plGroupKey)
                                   throws Thor.API.Exceptions.tcGroupNotFoundException,
                                          Thor.API.Exceptions.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 exist

tcAPIException - thrown if data set errors occur

removeAllMembers

public void removeAllMembers(long plGroupKey)
                      throws Thor.API.Exceptions.tcGroupNotFoundException,
                             Thor.API.Exceptions.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 exist

tcAPIException - thrown if data set errors occur

updateObjectPermissions

public void updateObjectPermissions(long groupKey,
                                    com.thortech.xl.vo.DataObjectPermissions[] dataObjectPermissions)
                             throws Thor.API.Exceptions.tcAPIException,
                                    Thor.API.Exceptions.tcGroupNotFoundException,
                                    Thor.API.Exceptions.tcDataObjectNotFoundException,
                                    Thor.API.Exceptions.tcBulkException,
                                    tcAPIException

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

Thor.API.Exceptions.tcBulkException

findUnAssignedGroups

public Thor.API.tcResultSet findUnAssignedGroups(java.util.Map phAttributeList,
                                                 long plUserKey)
                                          throws Thor.API.Exceptions.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 Xellerate 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)

Returns:

A tcResultSet containing multiple rows, each holding information about the group

Throws:

tcAPIException - thrown if data set errors occur

getAssignedReports

public Thor.API.tcResultSet getAssignedReports(long plGroupKey)
                                        throws Thor.API.Exceptions.tcAPIException,
                                               Thor.API.Exceptions.tcGroupNotFoundException,
                                               tcAPIException

Returns all the assigned Reports for a given group

Parameters:

plGroupKey - the group key

Returns:

a tcResultSet of all assigned Reports. The following are the column names:

• Reports.Report Key
• Reports.Report Name
• Reports.Report Code
• Reports.Report Type
• Reports.Report List Type
• Reports.Report Description
• Groups.Key
• Reports-Groups.Row Version

Throws:

tcAPIException

tcGroupNotFoundException

getUnassignedReports

public Thor.API.tcResultSet getUnassignedReports(long plGroupKey)
                                          throws Thor.API.Exceptions.tcAPIException,
                                                 Thor.API.Exceptions.tcGroupNotFoundException,
                                                 tcAPIException

Returns all the unassigned Reports for a given group

Parameters:

plGroupKey - the group key

Returns:

a tcResultSet of all unassigned Reports. The following are the column names:

• Reports.Report Key
• Reports.Report Name
• Reports.Report Code
• Reports.Report Type
• Reports.Report List Type
• Reports.Report Description
• Groups.Key
• Reports-Groups.Row Version

Throws:

tcAPIException

tcGroupNotFoundException

addReports

public void addReports(long groupKey,
                       long[] reportKeys)
                throws Thor.API.Exceptions.tcAPIException,
                       Thor.API.Exceptions.tcGroupNotFoundException,
                       Thor.API.Exceptions.tcBulkException,
                       tcAPIException

Adds a list of reports to the specified group

Parameters:

groupKey - the group key to which the reports to be added

reportKeys - the report keys to be added

Throws:

tcAPIException

tcGroupNotFoundException

tcBulkException

removeReports

public void removeReports(long groupKey,
                          long[] reportKeys)
                   throws Thor.API.Exceptions.tcAPIException,
                          Thor.API.Exceptions.tcGroupNotFoundException,
                          Thor.API.Exceptions.tcBulkException,
                          tcAPIException

Removes a list of reports from the specified group

Parameters:

groupKey - the group key from which the reports to be removed

reportKeys - the report keys to be removed

Throws:

tcAPIException

tcGroupNotFoundException

tcBulkException

getAllMemberUsersAndGroups

public Thor.API.tcResultSet getAllMemberUsersAndGroups(long groupKey)
                                                throws Thor.API.Exceptions.tcGroupNotFoundException,
                                                       Thor.API.Exceptions.tcAPIException,
                                                       tcAPIException

Gets a list of all users and groups that are members of the specified group by direct and indirect inclusion.

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 exist

tcAPIException - thrown if data set errors occur