Skip navigation links

Thor.API.Operations
Interface tcOrganizationOperationsIntf

All Superinterfaces:

tcUtilityOperationsIntf

public interface tcOrganizationOperationsIntf

extends tcUtilityOperationsIntf

Method Summary

void	addAdministrator(long plOrganizationKey, long plGroupKey, boolean pbWrite, boolean pbDelete) Adds a group to the list of groups that have authorization access over the specified object.
void	addObjectAllowed(long plOrganizationKey, long plObjectKey, boolean pbSelfServiceable) Deprecated.
void	addObjectAllowed(long plOrgKey, long plObjectKey, java.util.Map phAttributeList) Assigns an object to be allowed for an organization.
boolean	canResourceBeProvisioned(long orgKey, long objectKey) Determines if a resource can be provisioned to an organization or not.
long	createOrganization(java.util.Map phMapping) Creates an organization in Xellerate with the specified attributes.
void	deleteOrganization(long plOrgKey) Deletes a specified organization
void	deleteOrganizations(long[] palOrgKeys) Deletes a list of organizations
void	disableOrganization(long plOrgKey) Disables an enabled organization in Xellerate
void	disableOrganizations(long[] palOrgKeys) Disables a list of enabled organizations in Xellerate
void	enableOrganization(long plOrgKey) Enables a disabled organization in Xellerate
void	enableOrganizations(long[] palOrgKeys) Enables a list of disabled organizations in Xellerate
Thor.API.tcResultSet	findOrganizations(java.util.Map phAttributeList) Returns a list of organizations (in the form of a tcResultSet) that matches the provided attribute list.
Thor.API.tcResultSet	findOrganizationsFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList) Returns a list of organizations (in the form of a list of tcDataRecord) that matches the provided attribute list.
Thor.API.tcResultSet	findOrganizationsFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder) Returns a list of organizations (in the form of a list of tcDataRecord) that matches the provided attribute list.
Thor.API.tcResultSet	getAdministrators(long plOrganizationKey) Returns a list of groups that are administrative groups of the specified organization
Thor.API.tcResultSet	getAdministrators(java.util.Map searchCriteria) Returns a list of groups that are administrative groups of the specified organization
Thor.API.tcResultSet	getEncodedValue(java.lang.String strDecodeVal, java.lang.String strFieldName) This object returns a resultset of the object available for the given encoded value.
Thor.API.tcResultSet	getListOfUsers(long plOrganizationKey) Returns a list of users (in the form of a tcResultSet) that are in the specified organization
long	getNumberOfSubOrgs(long plOrgKey) Returns the number of sub-organization of a specified Organization
long	getNumberOfUsers(long plOrgKey) Returns the number of users associated to a specified organization
Thor.API.tcResultSet	getObjects(long orgKey) Gets a list of all the objects that have been provisioned for the given organization.
Thor.API.tcResultSet	getObjectsAllowed(long orgKey) Returns the list of allowed objects for a given organization
Thor.API.tcResultSet	getSubOrganizations(long plOrganizationKey) Returns a list of organizations (in the form of a tcResultSet) that are child organizations of the specified organization
Thor.API.tcResultSet	getUnassignedAdministrators(long plOrgKey) Returns a list groups of that are not assigned as administartive groups for an organization.
Thor.API.tcResultSet	getUnassignedAdministrators(java.util.Map searchCriteria) Returns a list groups of that are not assigned as administartive groups for specified organization.
Thor.API.tcResultSet	getUnassignedResources(long plOrgKey) Returns a list resource objects that are not assigned for the given organization.
Thor.API.tcResultSet	getUnassignedSubOrganizations(long plOrgKey) Returns a list organizations that are not assigned as suborganizations for the given organization.
Thor.API.tcResultSet	getUnassignedUsers(long plOrgKey) Returns a list users that are not assigned for the given organization.
void	moveOrganizations(long[] palOrgKeys, long plTargetOrgKey) Makes a list of organizations as sub-organization of a target organization
void	moveUsers(long[] palUserKeys, long plTargetOrgKey) moves the given users to a specified organization
long	provisionObject(long plOrgKey, long plObjectKey) Provision an object for an organization directly without going through a request.
long	provisionObject(long plOrgKey, long plObjectKey, java.util.Map phMapping) Provision an object for an organization directly without going through a request including any specific parameters
com.thortech.xl.vo.ResourceData	provisionResource(long plOrgKey, long plObjectKey) Provision an object for an organization directly without going through a request.
void	removeAdministrator(long plOrgKey, long plGroupKey) Removes a given administrator from the specified organization
void	removeObjectAllowed(long plOrgKey, long plObjectKey) Removes the Object allowed to the given organization
void	updateAdministrator(long plOrgKey, long plGroupKey, boolean pbWrite, boolean pbDelete) Updates a group that has administrative access over a specified organization.
void	updateObjectAllowed(long plOrgKey, long plObjectKey, java.util.Map phAttributeList) Updates the Object allowed servicesable information for the given organization
void	updateOrganization(long orgKey, java.util.Map attributes) Updates organization information based on the attribute that are passed to this method
void	updateOrganization(Thor.API.tcResultSet poOrgResultSet, java.util.Map phAttributeList) Updates an Organiztion in Xellerate.

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf

close, getName, setCountry, setLanguage, setVariant

Method Detail

findOrganizations

Thor.API.tcResultSet findOrganizations(java.util.Map phAttributeList)
                                       throws tcAPIException,
                                              tcAPIException

Returns a list of organizations (in the form of a tcResultSet) that matches the provided attribute list.

Parameters:

phAttributeList - The Key of the organization whose users are to be retrieved

Returns:

A tcResultSet in which each row holds details about the organizations that were found

Throws:

tcAPIException

findOrganizationsFiltered

Thor.API.tcResultSet findOrganizationsFiltered(java.util.Map phAttributeList,
                                               java.lang.String[] pasFieldList)
                                               throws tcAPIException,
                                                      tcAPIException

Returns a list of organizations (in the form of a list of tcDataRecord) that matches the provided attribute list.

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 (%).

pasFieldList - The list of fields (specified as column codes from the Xellerate metadata) that should be in the returned result set.

Returns:

A tcResultSet in which each row holds details about the organizations that were found

Throws:

tcAPIException

findOrganizationsFiltered

Thor.API.tcResultSet findOrganizationsFiltered(java.util.Map phAttributeList,
                                               java.lang.String[] pasFieldList,
                                               int startRow,
                                               int pageSize,
                                               java.lang.String[] order,
                                               boolean ascendingOrder)
                                               throws tcAPIException,
                                                      tcAPIException

Returns a list of organizations (in the form of a list of tcDataRecord) that matches the provided attribute list.

Parameters:

paoAttributeList - 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 (%).

pasFieldList - The list of fields (specified as column codes from the Xellerate metadata) that should be in the returned result set.

startRow - The starting row of the result

pageSize - The page size (how many rows to return)

order - The order in which the result set is based since only a subset of the whole matching set is returned, the caller will not be able to sort accurately with only that subset.

ascendingOrder - - a boolean value if the sorting is to be ascending or descending

Returns:

A tcResultSet in which each row holds details about the organizations that were found

Throws:

tcAPIException

getAdministrators

Thor.API.tcResultSet getAdministrators(long plOrganizationKey)
                                       throws tcAPIException,
                                              tcOrganizationNotFoundException,
                                              tcAPIException

Returns a list of groups that are administrative groups of the specified organization

Parameters:

plOrganizationKey - The Key of the organization whose administrative groups are to be retrieved

Returns:

A tcResultSet in which each row holds details (like group name, group key) about the administrative groups.

Throws:

tcAPIException

tcOrganizationNotFoundException

getListOfUsers

Thor.API.tcResultSet getListOfUsers(long plOrganizationKey)
                                    throws tcAPIException,
                                           tcOrganizationNotFoundException,
                                           tcAPIException

Returns a list of users (in the form of a tcResultSet) that are in the specified organization

Parameters:

plOrganizationKey - The Key of the organization whose users are to be retrieved

Returns:

A tcResultSet in which each row holds details about the users

Throws:

tcAPIException

tcOrganizationNotFoundException

getSubOrganizations

Thor.API.tcResultSet getSubOrganizations(long plOrganizationKey)
                                         throws tcAPIException,
                                                tcOrganizationNotFoundException,
                                                tcAPIException

Returns a list of organizations (in the form of a tcResultSet) that are child organizations of the specified organization

Parameters:

plOrganizationKey - The Key of the organization whose sub-organizations are to be retrieved

Returns:

A tcResultSet in which each row holds details about the sub-organizations

Throws:

tcAPIException

tcOrganizationNotFoundException

createOrganization

long createOrganization(java.util.Map phMapping)
                        throws tcDuplicateOrganizationException,
                               tcAttributeMissingException,
                               tcInvalidAttributeException,
                               tcInvalidNameException,
                               tcAPIException,
                               tcAPIException

Creates an organization in Xellerate with the specified attributes.

Parameters:

phMapping - A map of name-value pairs, each entry representing an attribute to be set for the organization.

Returns:

The organization key of the newly created organization.

Throws:

tcDuplicateOrganizationException

tcAttributeMissingException

tcInvalidAttributeException

tcAPIException

tcInvalidNameException

addAdministrator

void addAdministrator(long plOrganizationKey,
                      long plGroupKey,
                      boolean pbWrite,
                      boolean pbDelete)
                      throws tcAPIException,
                             tcOrganizationNotFoundException,
                             tcGroupNotFoundException,
                             tcAPIException

Adds a group to the list of groups that have authorization access over the specified object.

Parameters:

plOrganizationKey - The Key of the organization to which an administrator group is to be assigned

plGroupKey - String holding the Group Key (corresponds to value in the UGP_KEY column)

pbWrite - Whether the group has Write permissions

pbDelete - Whether the group has Delete permissions

Throws:

tcAPIException

tcOrganizationNotFoundException

tcGroupNotFoundException

addObjectAllowed

void addObjectAllowed(long plOrganizationKey,
                      long plObjectKey,
                      boolean pbSelfServiceable)
                      throws tcOrganizationNotFoundException,
                             tcObjectNotFoundException,
                             tcAPIException,
                             tcAPIException

Deprecated.

Assigns an object to be allowed for an organization.

Parameters:

plOrganizationKey - The key of the organization to which the object is to be assigned

plObjectKey - The key of the object to be assigned

pbSelfServiceable - Specifies whether or not the object is self serviceable

Throws:

tcOrganizationNotFoundException

tcObjectNotFoundException

tcAPIException

addObjectAllowed

void addObjectAllowed(long plOrgKey,
                      long plObjectKey,
                      java.util.Map phAttributeList)
                      throws tcAPIException,
                             tcOrganizationNotFoundException,
                             tcObjectNotFoundException,
                             tcInvalidAttributeException,
                             tcAPIException

Assigns an object to be allowed for an organization.

Parameters:

plOrgKey - the organization key

plObjectKey - the object key

phAttributeList - Map containing the serviceable flag for the object allowed

Throws:

tcAPIException

tcOrganizationNotFoundException

tcObjectNotFoundException

tcInvalidAttributeException

updateOrganization

void updateOrganization(Thor.API.tcResultSet poOrgResultSet,
                        java.util.Map phAttributeList)
                        throws tcAPIException,
                               tcOrganizationNotFoundException,
                               tcStaleDataUpdateException,
                               tcAPIException

Updates an Organiztion in Xellerate. Requires a result set to maintain our locking mechanism. This result set should be retrieved from the findOrganizations method. This method is in addition to the existing updateOrganization method that takes organization key and attribute map as parameters. Unlike the other method, this handles multiple users updating organizations at the same time by providing as locking mechanism.

Parameters:

poOrgResultSet - A result set containing at the minimum the Organization key and the row version of the Organization record to update. Note that if the result set contains multiple Organization, only the first Organization 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 Organization. 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

tcOrganizationNotFoundException

tcStaleDataUpdateException

updateOrganization

void updateOrganization(long orgKey,
                        java.util.Map attributes)
                        throws tcAPIException,
                               tcOrganizationNotFoundException,
                               tcAPIException

Updates organization information based on the attribute that are passed to this method

Parameters:

orgKey - the organization key

attributes - a map of updated attributes

Throws:

tcAPIException

tcOrganizationNotFoundException

enableOrganization

void enableOrganization(long plOrgKey)
                        throws tcInvalidOperationException,
                               tcOrganizationNotFoundException,
                               tcAPIException,
                               tcAPIException

Enables a disabled organization in Xellerate

Parameters:

plOrgKey - the organization key

Throws:

tcInvalidOperationException

tcOrganizationNotFoundException

tcAPIException

enableOrganizations

void enableOrganizations(long[] palOrgKeys)
                         throws tcInvalidOperationException,
                                tcOrganizationNotFoundException,
                                tcAPIException,
                                tcBulkException,
                                tcAPIException

Enables a list of disabled organizations in Xellerate

Parameters:

palOrgKeys - the organization keys to be disbaled

Throws:

tcInvalidOperationException

tcOrganizationNotFoundException

tcAPIException

tcBulkException

disableOrganization

void disableOrganization(long plOrgKey)
                         throws tcInvalidOperationException,
                                tcOrganizationNotFoundException,
                                tcAPIException,
                                tcAPIException

Disables an enabled organization in Xellerate

Parameters:

plOrgKey - the organization key

Throws:

tcInvalidOperationException

tcOrganizationNotFoundException

tcAPIException

disableOrganizations

void disableOrganizations(long[] palOrgKeys)
                          throws tcInvalidOperationException,
                                 tcOrganizationNotFoundException,
                                 tcAPIException,
                                 tcBulkException,
                                 tcAPIException

Disables a list of enabled organizations in Xellerate

Parameters:

palOrgKeys - the organization keys to be disabled

Throws:

tcInvalidOperationException

tcOrganizationNotFoundException

tcAPIException

tcBulkException

deleteOrganization

void deleteOrganization(long plOrgKey)
                        throws tcInvalidOperationException,
                               tcOrganizationNotFoundException,
                               tcAPIException,
                               tcAPIException

Deletes a specified organization

Parameters:

plOrgKey - the organization to delete

Throws:

tcInvalidOperationException

tcOrganizationNotFoundException

tcAPIException

deleteOrganizations

void deleteOrganizations(long[] palOrgKeys)
                         throws tcInvalidOperationException,
                                tcOrganizationNotFoundException,
                                tcAPIException,
                                tcBulkException,
                                tcAPIException

Deletes a list of organizations

Parameters:

palOrgKeys - the organization keys to delete

Throws:

tcInvalidOperationException

tcOrganizationNotFoundException

tcAPIException

tcBulkException

getNumberOfUsers

long getNumberOfUsers(long plOrgKey)
                      throws tcOrganizationNotFoundException,
                             tcAPIException,
                             tcAPIException

Returns the number of users associated to a specified organization

Parameters:

plOrgKey - the organization key

Returns:

integer representing the number of users in the organization

Throws:

tcOrganizationNotFoundException

tcAPIException

getNumberOfSubOrgs

long getNumberOfSubOrgs(long plOrgKey)
                        throws tcOrganizationNotFoundException,
                               tcAPIException,
                               tcAPIException

Returns the number of sub-organization of a specified Organization

Parameters:

plOrgKey - the organization

Returns:

an integer reflecting the number of sub-organizations

Throws:

tcOrganizationNotFoundException

tcAPIException

removeObjectAllowed

void removeObjectAllowed(long plOrgKey,
                         long plObjectKey)
                         throws tcAPIException,
                                tcOrganizationNotFoundException,
                                tcObjectNotFoundException,
                                tcAPIException

Removes the Object allowed to the given organization

Parameters:

plOrgKey - The Organization Key

plObjectKey - The object to be removed form allowed list

Throws:

tcAPIException

tcOrganizationNotFoundException

tcObjectNotFoundException

updateObjectAllowed

void updateObjectAllowed(long plOrgKey,
                         long plObjectKey,
                         java.util.Map phAttributeList)
                         throws tcAPIException,
                                tcOrganizationNotFoundException,
                                tcObjectNotFoundException,
                                tcInvalidAttributeException,
                                tcAPIException

Updates the Object allowed servicesable information for the given organization

Parameters:

plOrgKey - the organization key

plObjectKey - the object key

phAttributeList - Map containing the serviceable flag for the object allowed

Throws:

tcAPIException

tcOrganizationNotFoundException

tcObjectNotFoundException

tcInvalidAttributeException

getObjectsAllowed

Thor.API.tcResultSet getObjectsAllowed(long orgKey)
                                       throws tcAPIException,
                                              tcOrganizationNotFoundException,
                                              tcAPIException

Returns the list of allowed objects for a given organization

Parameters:

orgKey - the organization key

Returns:

a ResultSet

Throws:

tcAPIException

tcOrganizationNotFoundException

removeAdministrator

void removeAdministrator(long plOrgKey,
                         long plGroupKey)
                         throws tcAPIException,
                                tcOrganizationNotFoundException,
                                tcGroupNotFoundException,
                                tcAPIException

Removes a given administrator from the specified organization

Parameters:

plOrgKey - the organization key

plGroupKey - the group key of the administrator to remove

Throws:

tcAPIException

tcOrganizationNotFoundException

tcGroupNotFoundException

updateAdministrator

void updateAdministrator(long plOrgKey,
                         long plGroupKey,
                         boolean pbWrite,
                         boolean pbDelete)
                         throws tcOrganizationNotFoundException,
                                tcGroupNotFoundException,
                                tcAPIException,
                                tcAPIException

Updates a group that has administrative access over a specified organization.

Parameters:

plOrgKey - The Key of the organization

plGroupKey - String holding the Group Key

pbWrite - Whether the group has Write permissions

pbDelete - Whether the group has Delete permissions

Throws:

tcOrganizationNotFoundException

tcGroupNotFoundException

tcAPIException

moveUsers

void moveUsers(long[] palUserKeys,
               long plTargetOrgKey)
               throws tcAPIException,
                      tcUserNotFoundException,
                      tcOrganizationNotFoundException,
                      tcBulkException,
                      tcAPIException

moves the given users to a specified organization

Parameters:

palUserKeys - the user keys

plTargetOrgKey - the target organization key

Throws:

tcAPIException - thrown if an error occurs while getting the users or organization information

tcUserNotFoundException - thrown if one or many of the users do not exist in the databse

tcOrganizationNotFoundException - thrown if the specified organization does not exist in the databse

tcBulkException - thrown if an error occurs during the bulk move operation

moveOrganizations

void moveOrganizations(long[] palOrgKeys,
                       long plTargetOrgKey)
                       throws tcAPIException,
                              tcOrganizationNotFoundException,
                              tcBulkException,
                              tcAPIException

Makes a list of organizations as sub-organization of a target organization

Parameters:

palOrgKeys - the sub-oragnization keys

plTargetOrgKey - the target organization key

Throws:

tcAPIException - thrown if an error occurs while getting organization information

tcOrganizationNotFoundException - thrown if the specified organizations do not exist in the databse

tcBulkException - thrown if an error occurs during the bulk move operation

getUnassignedAdministrators

Thor.API.tcResultSet getUnassignedAdministrators(long plOrgKey)
                                                 throws tcAPIException,
                                                        tcOrganizationNotFoundException,
                                                        tcAPIException

Returns a list groups of that are not assigned as administartive groups for an organization.

Parameters:

plOrgKey - The organization key return a tcResultSet of the unassigned administrators. The result set contains column names:

• Groups.Key
• Groups.Group Name

Returns:

tcResultSet

Throws:

tcAPIException - Thrown if an error occurrs while retrieving the data about unassigned groups from the database

tcOrganizationNotFoundException - If the specified orgnization does not exist in the databse

getUnassignedResources

Thor.API.tcResultSet getUnassignedResources(long plOrgKey)
                                            throws tcAPIException,
                                                   tcOrganizationNotFoundException,
                                                   tcAPIException

Returns a list resource objects that are not assigned for the given organization.

Parameters:

plOrgKey - The Organization key

Returns:

a tcResultSet of the unassigned objects. The result set contains column names:

• Objects.Key
• Objects.Name

Throws:

tcAPIException

tcOrganizationNotFoundException

getUnassignedSubOrganizations

Thor.API.tcResultSet getUnassignedSubOrganizations(long plOrgKey)
                                                   throws tcAPIException,
                                                          tcOrganizationNotFoundException,
                                                          tcAPIException

Returns a list organizations that are not assigned as suborganizations for the given organization.

Parameters:

plOrgKey - The Organization key

Returns:

a tcResultSet of the unassigned organizations. The result set contains column names:

• Organizations.Key
• Organizations.Organization Name

Throws:

tcAPIException

tcOrganizationNotFoundException

getUnassignedUsers

Thor.API.tcResultSet getUnassignedUsers(long plOrgKey)
                                        throws tcAPIException,
                                               tcOrganizationNotFoundException,
                                               tcAPIException

Returns a list users that are not assigned for the given organization.

Parameters:

plOrgKey - The Organization key

Returns:

a tcResultSet of the unassigned organizations. The result set contains column names:

• Users.Key
• Users.User ID
• Users.First Name
• Users.Last Name

Throws:

tcAPIException

tcOrganizationNotFoundException

getObjects

Thor.API.tcResultSet getObjects(long orgKey)
                                throws tcAPIException,
                                       tcOrganizationNotFoundException,
                                       tcAPIException

Gets a list of all the objects that have been provisioned for the given organization.

Parameters:

orgKey - Value holding the Organization Key

Returns:

A tcResultSet, each row holding information about an object that has been provisioned for the organization.

Throws:

tcAPIException

tcOrganizationNotFoundException

provisionObject

long provisionObject(long plOrgKey,
                     long plObjectKey,
                     java.util.Map phMapping)
                     throws tcAPIException,
                            tcObjectNotFoundException,
                            tcProvisioningNotAllowedException,
                            tcOrganizationNotFoundException,
                            tcAPIException

Provision an object for an organization directly without going through a request including any specific parameters

Parameters:

plOrgKey - The key of the organization to which the resource to be provisioned.

plObjectKey - The key of the object to provision.

phMapping - The Map with attributes.

Returns:

The Object Instance Key for the provisioning record created

Throws:

tcAPIException

tcObjectNotFoundException

tcProvisioningNotAllowedException

tcOrganizationNotFoundException

Since:

11.1.1.3.0

provisionObject

long provisionObject(long plOrgKey,
                     long plObjectKey)
                     throws tcAPIException,
                            tcObjectNotFoundException,
                            tcProvisioningNotAllowedException,
                            tcOrganizationNotFoundException,
                            tcAPIException

Provision an object for an organization directly without going through a request.

Parameters:

plOrgKey - The key of the organization to which the resource to be provisioned.

plObjectKey - The key of the object to provision.

Returns:

The Object Instance Key for the provisioning record created

Throws:

tcAPIException

tcObjectNotFoundException

tcProvisioningNotAllowedException

tcOrganizationNotFoundException

provisionResource

com.thortech.xl.vo.ResourceData provisionResource(long plOrgKey,
                                                  long plObjectKey)
                                                  throws tcAPIException,
                                                         tcObjectNotFoundException,
                                                         tcProvisioningNotAllowedException,
                                                         tcOrganizationNotFoundException,
                                                         tcAPIException

Provision an object for an organization directly without going through a request.

Parameters:

plOrgKey - The key of the organization to which the resource to be provisioned.

plObjectKey - The key of the object to provision.

Returns:

The ResourceData which contain obi and oio key for the provisioning record created

Throws:

tcAPIException

tcObjectNotFoundException

tcProvisioningNotAllowedException

tcOrganizationNotFoundException

canResourceBeProvisioned

boolean canResourceBeProvisioned(long orgKey,
                                 long objectKey)
                                 throws tcAPIException,
                                        tcOrganizationNotFoundException,
                                        tcObjectNotFoundException,
                                        tcAPIException

Determines if a resource can be provisioned to an organization or not.

Parameters:

orgKey - The key of the organization to which the resource is to be provisioned.

objectKey - This is the resource object key

Returns:

A tcResultSet each row holding information about a group the user is not a member of.

Throws:

tcAPIException

tcUserNotFoundException

tcOrganizationNotFoundException

tcObjectNotFoundException

getEncodedValue

Thor.API.tcResultSet getEncodedValue(java.lang.String strDecodeVal,
                                     java.lang.String strFieldName)
                                     throws tcAPIException,
                                            tcAPIException

This object returns a resultset of the object available for the given encoded value.

Parameters:

valDecodes. - If a null or empty array is passed, this function will raise the tcAPIException

Returns:

tcResultSet of the available objects for the Encoded Value

Throws:

tcUserNotFoundException

tcAPIException

getAdministrators

Thor.API.tcResultSet getAdministrators(java.util.Map searchCriteria)
                                       throws tcAPIException,
                                              tcOrganizationNotFoundException,
                                              tcAPIException

Returns a list of groups that are administrative groups of the specified organization

Parameters:

searchCriteria - Map holding the search criteria with key in Metadata form for filtering Groups e.g. Key=Groups.Group Name & Value=G1, Organizations.key=1

Returns:

A tcResultSet, each row holding information about a group. Metadata Keys that can be passed are as follows: Organizations-Groups.Created By, Organizations-Groups.Delete Permission Organizations-Groups.Updated By, Organizations-Groups.Write Access Groups.Created By, Groups.E-mail, Groups.Group Name, Groups.Key, Groups.Updated By

Throws:

tcAPIException - Thrown if an error occurrs while retrieving the data about unassigned groups from the database

tcOrganizationNotFoundException - If the specified orgnization does not exist in the databse

Since:

9.2

getUnassignedAdministrators

Thor.API.tcResultSet getUnassignedAdministrators(java.util.Map searchCriteria)
                                                 throws tcAPIException,
                                                        tcOrganizationNotFoundException,
                                                        tcAPIException

Returns a list groups of that are not assigned as administartive groups for specified organization.

Parameters:

searchCriteria - Map holding the search criteria with key in Metadata form for filtering Groups e.g. Key=Groups.Group Name & Value=G1, Organizations.key=1 Metadata Keys that can be passed are as follows: Organizations-Groups.Created By, Organizations-Groups.Delete Permission Organizations-Groups.Updated By, Organizations-Groups.Write Access Groups.Created By, Groups.E-mail, Groups.Group Name, Groups.Key, Groups.Updated By

Returns:

A tcResultSet, each row holding information about a group.

Throws:

tcAPIException - Thrown if an error occurrs while retrieving the data about unassigned groups from the database

tcOrganizationNotFoundException - If the specified orgnization does not exist in the databse

Since:

9.2

Skip navigation links