Thor.API.Operations
Interface tcOrganizationOperationsIntf

public interface tcOrganizationOperationsIntf

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	getAdministrators(long plOrganizationKey) 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	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.
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

Method Detail

findOrganizations

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

public Thor.API.tcResultSet findOrganizationsFiltered(java.util.Map phAttributeList,
                                                      java.lang.String[] pasFieldList)
                                               throws Thor.API.Exceptions.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

getAdministrators

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

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

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

public long createOrganization(java.util.Map phMapping)
                        throws Thor.API.Exceptions.tcDuplicateOrganizationException,
                               Thor.API.Exceptions.tcAttributeMissingException,
                               Thor.API.Exceptions.tcInvalidAttributeException,
                               Thor.API.Exceptions.tcInvalidNameException,
                               Thor.API.Exceptions.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

Thor.API.Exceptions.tcInvalidNameException

addAdministrator

public void addAdministrator(long plOrganizationKey,
                             long plGroupKey,
                             boolean pbWrite,
                             boolean pbDelete)
                      throws Thor.API.Exceptions.tcAPIException,
                             Thor.API.Exceptions.tcOrganizationNotFoundException,
                             Thor.API.Exceptions.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

public void addObjectAllowed(long plOrganizationKey,
                             long plObjectKey,
                             boolean pbSelfServiceable)
                      throws Thor.API.Exceptions.tcOrganizationNotFoundException,
                             Thor.API.Exceptions.tcObjectNotFoundException,
                             Thor.API.Exceptions.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

public void addObjectAllowed(long plOrgKey,
                             long plObjectKey,
                             java.util.Map phAttributeList)
                      throws Thor.API.Exceptions.tcAPIException,
                             Thor.API.Exceptions.tcOrganizationNotFoundException,
                             Thor.API.Exceptions.tcObjectNotFoundException,
                             Thor.API.Exceptions.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

public void updateOrganization(long orgKey,
                               java.util.Map attributes)
                        throws Thor.API.Exceptions.tcAPIException,
                               Thor.API.Exceptions.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

public void enableOrganization(long plOrgKey)
                        throws Thor.API.Exceptions.tcInvalidOperationException,
                               Thor.API.Exceptions.tcOrganizationNotFoundException,
                               Thor.API.Exceptions.tcAPIException,
                               tcAPIException

Enables a disabled organization in Xellerate

Parameters:

plOrgKey - the organization key

Throws:

tcInvalidOperationException

tcOrganizationNotFoundException

tcAPIException

enableOrganizations

public void enableOrganizations(long[] palOrgKeys)
                         throws Thor.API.Exceptions.tcInvalidOperationException,
                                Thor.API.Exceptions.tcOrganizationNotFoundException,
                                Thor.API.Exceptions.tcAPIException,
                                Thor.API.Exceptions.tcBulkException,
                                tcAPIException

Enables a list of disabled organizations in Xellerate

Parameters:

palOrgKeys - the organization keys to be disbaled

Throws:

tcInvalidOperationException

tcOrganizationNotFoundException

tcAPIException

tcBulkException

disableOrganization

public void disableOrganization(long plOrgKey)
                         throws Thor.API.Exceptions.tcInvalidOperationException,
                                Thor.API.Exceptions.tcOrganizationNotFoundException,
                                Thor.API.Exceptions.tcAPIException,
                                tcAPIException

Disables an enabled organization in Xellerate

Parameters:

plOrgKey - the organization key

Throws:

tcInvalidOperationException

tcOrganizationNotFoundException

tcAPIException

disableOrganizations

public void disableOrganizations(long[] palOrgKeys)
                          throws Thor.API.Exceptions.tcInvalidOperationException,
                                 Thor.API.Exceptions.tcOrganizationNotFoundException,
                                 Thor.API.Exceptions.tcAPIException,
                                 Thor.API.Exceptions.tcBulkException,
                                 tcAPIException

Disables a list of enabled organizations in Xellerate

Parameters:

palOrgKeys - the organization keys to be disabled

Throws:

tcInvalidOperationException

tcOrganizationNotFoundException

tcAPIException

tcBulkException

deleteOrganization

public void deleteOrganization(long plOrgKey)
                        throws Thor.API.Exceptions.tcInvalidOperationException,
                               Thor.API.Exceptions.tcOrganizationNotFoundException,
                               Thor.API.Exceptions.tcAPIException,
                               tcAPIException

Deletes a specified organization

Parameters:

plOrgKey - the organization to delete

Throws:

tcInvalidOperationException

tcOrganizationNotFoundException

tcAPIException

deleteOrganizations

public void deleteOrganizations(long[] palOrgKeys)
                         throws Thor.API.Exceptions.tcInvalidOperationException,
                                Thor.API.Exceptions.tcOrganizationNotFoundException,
                                Thor.API.Exceptions.tcAPIException,
                                Thor.API.Exceptions.tcBulkException,
                                tcAPIException

Deletes a list of organizations

Parameters:

palOrgKeys - the organization keys to delete

Throws:

tcInvalidOperationException

tcOrganizationNotFoundException

tcAPIException

tcBulkException

getNumberOfUsers

public long getNumberOfUsers(long plOrgKey)
                      throws Thor.API.Exceptions.tcOrganizationNotFoundException,
                             Thor.API.Exceptions.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

public long getNumberOfSubOrgs(long plOrgKey)
                        throws Thor.API.Exceptions.tcOrganizationNotFoundException,
                               Thor.API.Exceptions.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

public void removeObjectAllowed(long plOrgKey,
                                long plObjectKey)
                         throws Thor.API.Exceptions.tcAPIException,
                                Thor.API.Exceptions.tcOrganizationNotFoundException,
                                Thor.API.Exceptions.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

public void updateObjectAllowed(long plOrgKey,
                                long plObjectKey,
                                java.util.Map phAttributeList)
                         throws Thor.API.Exceptions.tcAPIException,
                                Thor.API.Exceptions.tcOrganizationNotFoundException,
                                Thor.API.Exceptions.tcObjectNotFoundException,
                                Thor.API.Exceptions.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

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

Returns the list of allowed objects for a given organization

Parameters:

orgKey - the organization key

Returns:

a ResultSet

Throws:

tcAPIException

tcOrganizationNotFoundException

removeAdministrator

public void removeAdministrator(long plOrgKey,
                                long plGroupKey)
                         throws Thor.API.Exceptions.tcAPIException,
                                Thor.API.Exceptions.tcOrganizationNotFoundException,
                                Thor.API.Exceptions.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

public void updateAdministrator(long plOrgKey,
                                long plGroupKey,
                                boolean pbWrite,
                                boolean pbDelete)
                         throws Thor.API.Exceptions.tcOrganizationNotFoundException,
                                Thor.API.Exceptions.tcGroupNotFoundException,
                                Thor.API.Exceptions.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

public void moveUsers(long[] palUserKeys,
                      long plTargetOrgKey)
               throws Thor.API.Exceptions.tcAPIException,
                      Thor.API.Exceptions.tcUserNotFoundException,
                      Thor.API.Exceptions.tcOrganizationNotFoundException,
                      Thor.API.Exceptions.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

public void moveOrganizations(long[] palOrgKeys,
                              long plTargetOrgKey)
                       throws Thor.API.Exceptions.tcAPIException,
                              Thor.API.Exceptions.tcOrganizationNotFoundException,
                              Thor.API.Exceptions.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

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

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

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

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

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

public long provisionObject(long plOrgKey,
                            long plObjectKey)
                     throws Thor.API.Exceptions.tcAPIException,
                            Thor.API.Exceptions.tcObjectNotFoundException,
                            Thor.API.Exceptions.tcProvisioningNotAllowedException,
                            Thor.API.Exceptions.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

public com.thortech.xl.vo.ResourceData provisionResource(long plOrgKey,
                                                         long plObjectKey)
                                                  throws Thor.API.Exceptions.tcAPIException,
                                                         Thor.API.Exceptions.tcObjectNotFoundException,
                                                         Thor.API.Exceptions.tcProvisioningNotAllowedException,
                                                         Thor.API.Exceptions.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

public boolean canResourceBeProvisioned(long orgKey,
                                        long objectKey)
                                 throws Thor.API.Exceptions.tcAPIException,
                                        Thor.API.Exceptions.tcOrganizationNotFoundException,
                                        Thor.API.Exceptions.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

Thor.API.Exceptions.tcOrganizationNotFoundException

Thor.API.Exceptions.tcObjectNotFoundException

getEncodedValue

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

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

Returns:

tcResultSet of the available objects for the Encoded Value

Throws:

tcUserNotFoundException

tcAPIException