Skip navigation links

Thor.API.Operations
Interface tcITResourceInstanceOperationsIntf

All Superinterfaces:

tcUtilityOperationsIntf

public interface tcITResourceInstanceOperationsIntf

extends tcUtilityOperationsIntf

Method Summary

void	addAdministrators(long plITResourceInstanceKey, long[] palAdminGroupKeys, boolean[] read, boolean[] write, boolean[] delete) Adds a list of groups to have administrative control over the specified group
long	createITResourceInstance(java.util.Map phAttributes) Create a ITResource with the list of specified attributes.
void	deleteITResourceInstance(long plITResourceInstanceKey) Deletes a IT Resource instance from the Xellerate
Thor.API.tcResultSet	findITResourceInstances(java.util.Map phAttributeList) Returns the IT Resource instances that match the provided criteria and based on the permissions available to the groups the calling user belongs.
Thor.API.tcResultSet	findITResourceInstancesByDefinition(long plITResourceDefinitionKey) Returns the IT Resource instances that have the specified IT Resource definition and depending on the permissions available to the groups the calling user belongs.
Thor.API.tcResultSet	findITResourceInstancesByRemoteManager(long plRemoteManagerInstanceKey) Returns the IT Resource instances that have the specified Remote Manager.
Thor.API.tcResultSet	findITResourceInstancesByRemoteManagerFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList) Returns the IT Resource instances that have the specified Remote Manager.
Thor.API.tcResultSet	getAdministrators(long plITResourceInstanceKey) Gets a list of the groups that have administrative control over the specified IT resource
Thor.API.tcResultSet	getAdministrators(java.util.Map searchCriteria) Gets a list of the groups that have administrative control over the specified IT resource
Thor.API.tcResultSet	getITResourceInstanceParameters(long plITResourceInstanceKey) Returns the parameter names and values of the specified IT Resource instance depending on the permissions available to the groups the calling user belongs.
java.util.HashMap	getITResourceInstances(java.lang.String psITResourceType) Returns the IT Resource instances for a given IT Resource type.
Thor.API.tcResultSet	getUnassignedAdministrators(long plITResourceInstanceKey) Gets a list of the groups that are not assigned as the administrator groups of a specified plITResourceInstanceKey
Thor.API.tcResultSet	getUnassignedAdministrators(java.util.Map searchCriteria) Gets a list of the groups that are not assigned as the administrative groups of a specified plITResourceInstanceKey
void	removeAdministrators(long plITResourceInstanceKey, long[] palAdminGroupKeys) Removes a list of groups from having administrative control over a specified IT Resource
void	updateAdministrators(long plITResourceInstanceKey, long[] palAdminGroupKeys, boolean[] read, boolean[] write, boolean[] delete) Updates the administrative access for a list of groups over the specified IT Resource
void	updateITResourceInstance(long msITResourceKey, java.util.Map attributes) Updates the specified IT Resource instance.
void	updateITResourceInstanceParameters(long plITResourceInstanceKey, java.util.Map attributes) Updates the parameter values of the specified IT Resource instance.

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf

close, getName, setCountry, setLanguage, setVariant

Method Detail

findITResourceInstances

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

Returns the IT Resource instances that match the provided criteria and based on the permissions available to the groups the calling user belongs.

Parameters:

phAttributeList - A Map of name-value pairs. The Map key can contain two different types of values:

1. IT resource parameter key which can be retrieved using the getITResourceDefinitionParameters method. The Map value would be the desired value for this IT resource parameter. The wildcard character(%) cannot be used here.
2. Metadata codes that are used to access the IT Resource Type and/or Remote Manager Name:
   • IT Resources Type Definition.Server Type
   • IT Resources.Remote Manager Name
   The Map value should contain the respective search criteria and the wildcard character(%) can be used in this case.

Returns:

A tcResultSet containing the following IT Resource instance information:

• IT Resources.Key
• IT Resources.Name
• IT Resources.Updated By
• IT Resources.Update Date
• IT Resources.Row Version
• IT Resources.Creation Date
• IT Resources.Created By

Throws:

tcAPIException

getITResourceInstanceParameters

Thor.API.tcResultSet getITResourceInstanceParameters(long plITResourceInstanceKey)
                                                     throws tcITResourceNotFoundException,
                                                            tcAPIException,
                                                            tcAPIException

Returns the parameter names and values of the specified IT Resource instance depending on the permissions available to the groups the calling user belongs.

Parameters:

plITResourceInstanceKey - The key of the IT resource instance.

Returns:

A tcResultSet containing the following information about the IT resource instance's parameters:

• IT Resources Type Parameter Value.Key
• IT Resources Type Parameter Value.Value
• IT Resources Type Parameter.Default
• IT Resources Type Parameter.Encrypted
• IT Resources Type Parameter.Key
• IT Resources Type Parameter.Name

Throws:

tcITResourceNotFoundException

tcAPIException

findITResourceInstancesByDefinition

Thor.API.tcResultSet findITResourceInstancesByDefinition(long plITResourceDefinitionKey)
                                                         throws tcITResourceDefinitionNotFoundException,
                                                                tcAPIException,
                                                                tcAPIException

Returns the IT Resource instances that have the specified IT Resource definition and depending on the permissions available to the groups the calling user belongs.

Parameters:

plITResourceDefinitionKey - The key of the IT Resource definition.

Returns:

A tcResultSet containing the following IT resource instance information:

• IT Resources.Key
• IT Resources.Name
• IT Resources.Updated By
• IT Resources.Update Date
• IT Resources.Row Version
• IT Resources.Creation Date
• IT Resources.Created By

Throws:

tcITResourceDefinitionNotFoundException

tcAPIException

findITResourceInstancesByRemoteManager

Thor.API.tcResultSet findITResourceInstancesByRemoteManager(long plRemoteManagerInstanceKey)
                                                            throws tcRemoteManagerNotFoundException,
                                                                   tcAPIException,
                                                                   tcAPIException

Returns the IT Resource instances that have the specified Remote Manager. Checks the permissions for the current user/group to see if accessing the IT Resource Instances is allowed.

Parameters:

plRemoteManagerInstanceKey - The key of a Remote Manager instance.

Returns:

A tcResultSet containing the following IT resource instance information:

• IT Resources.Key
• IT Resources.Name
• IT Resources.Updated By
• IT Resources.Update Date
• IT Resources.Row Version
• IT Resources.Creation Date
• IT Resources.Created By

Throws:

tcRemoteManagerNotFoundException

tcAPIException

findITResourceInstancesByRemoteManagerFiltered

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

Returns the IT Resource instances that have the specified Remote Manager. Checks the permissions for the current user/group to see if accessing the IT Resource Instances is allowed.

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 containing the following IT resource instance information:

• IT Resources.Key
• IT Resources.Name
• IT Resources.Updated By
• IT Resources.Update Date
• IT Resources.Row Version
• IT Resources.Creation Date
• IT Resources.Created By

Throws:

tcAPIException

tcInvalidAttributeException

Since:

9.1

updateITResourceInstanceParameters

void updateITResourceInstanceParameters(long plITResourceInstanceKey,
                                        java.util.Map attributes)
                                        throws tcITResourceNotFoundException,
                                               tcInvalidAttributeException,
                                               tcAPIException,
                                               tcAPIException

Updates the parameter values of the specified IT Resource instance.

Parameters:

plITResourceInstanceKey - The key of the IT resource instance.

attributes - Map containing the It Resource instance attribute key, value pair

Throws:

tcITResourceNotFoundException, - If the specified IT Resource instance not found

tcInvalidAttributeException, - If one or more of the attributes in the map are invalid attributes of the specified IT Resource instance

tcAPIException

tcITResourceNotFoundException

tcInvalidAttributeException

Since:

8.0

updateITResourceInstance

void updateITResourceInstance(long msITResourceKey,
                              java.util.Map attributes)
                              throws tcITResourceNotFoundException,
                                     tcInvalidAttributeException,
                                     tcAPIException,
                                     tcAPIException

Updates the specified IT Resource instance.

Parameters:

msITResourceKey - The key of the IT resource instance.

attributes - A map of name-value pairs, each entry holding an attribute-value pair to set/modify for this IT resource. The Attribute names are the String column codes (from the Xellerate metadata). The Attribute Values are the String attributes of the columns to set.

Throws:

tcITResourceNotFoundException, - If the specified IT Resource instance not found

tcInvalidAttributeException, - If one or more of the attributes in the map are invalid attributes of the specified IT Resource instance

tcAPIException

tcITResourceNotFoundException

tcInvalidAttributeException

Since:

9.1

getITResourceInstances

java.util.HashMap getITResourceInstances(java.lang.String psITResourceType)
                                         throws tcAPIException,
                                                tcAPIException

Returns the IT Resource instances for a given IT Resource type. Note that this API doesn't take permissions into consideration.

Parameters:

psITResourceType, - IT Resource type. This API allows passing wildcard IT Resource type values. If a * is passed as IT resource type, API returns all the IT Resource instances in the system.

Returns:

A HashMap containing the key, name pair of IT resource instances for the given type. Returns an empty HashMap if the search yield no returns.

Throws:

tcAPIException

createITResourceInstance

long createITResourceInstance(java.util.Map phAttributes)
                              throws tcAPIException,
                                     tcAttributeMissingException,
                                     DuplicateITResourceInstanceException,
                                     tcInvalidAttributeException,
                                     tcAPIException

Create a ITResource with the list of specified attributes.

Parameters:

phAttributes - - The attributes to set for the new ITResource being created

Returns:

A long containing the key of the IT Resource created

Throws:

tcAPIException - thrown if errors occur while saving

DuplicateITResourceInstanceException - thrown if IT Resource Name already exists

tcInvalidAttributeException - thrown if a IT Resource instance key is provided as an attribute

tcAttributeMissingException

Since:

9.1

getAdministrators

Thor.API.tcResultSet getAdministrators(long plITResourceInstanceKey)
                                       throws tcAPIException,
                                              tcITResourceNotFoundException,
                                              tcAPIException

Gets a list of the groups that have administrative control over the specified IT resource

Parameters:

plITResourceInstanceKey - - IT Resource instance key

Returns:

A result set containing all the information about the groups that have administrative control over this IT Resource

Throws:

tcAPIException - thrown if data set errors occur

tcITResourceNotFoundException - thrown if plITResourceInstanceKey does not exist

Since:

9.1

getUnassignedAdministrators

Thor.API.tcResultSet getUnassignedAdministrators(long plITResourceInstanceKey)
                                                 throws tcITResourceNotFoundException,
                                                        tcAPIException,
                                                        tcAPIException

Gets a list of the groups that are not assigned as the administrator groups of a specified plITResourceInstanceKey

Parameters:

plITResourceInstanceKey - - IT Resource instance key

Returns:

Result set containing the unassigned Group key and names

Throws:

tcITResourceNotFoundException - thrown if plITResourceInstanceKey does not exist

tcAPIException - thrown if data set errors occur

Since:

9.1

addAdministrators

void addAdministrators(long plITResourceInstanceKey,
                       long[] palAdminGroupKeys,
                       boolean[] read,
                       boolean[] write,
                       boolean[] delete)
                       throws tcAdminNotFoundException,
                              tcAdminGroupInvalidException,
                              tcITResourceNotFoundException,
                              tcAPIException,
                              tcBulkException,
                              tcAPIException

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

Parameters:

plITResourceInstanceKey - - IT Resource instance key

palAdminGroupKeys - - The keys of the admin groups

read - - Whether the admin groups to have write access over the specified IT Resource

write - - Whether the admin groups to have write access over the specified IT Resource

delete - - Whether the admin groups to have delete access over the specified IT Resource

Throws:

tcAdminNotFoundException - thrown if one or many palAdminGroupKeys do not exist

tcAdminGroupInvalidException - thrown if administrator is not allowed to be updated

tcITResourceNotFoundException - thrown if plITResourceInstanceKey does not exist

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

tcBulkException

Since:

9.1

updateAdministrators

void updateAdministrators(long plITResourceInstanceKey,
                          long[] palAdminGroupKeys,
                          boolean[] read,
                          boolean[] write,
                          boolean[] delete)
                          throws tcAdminNotFoundException,
                                 tcITResourceNotFoundException,
                                 tcAPIException,
                                 tcBulkException,
                                 tcAPIException

Updates the administrative access for a list of groups over the specified IT Resource

Parameters:

plITResourceInstanceKey - - IT Resource instance key

palAdminGroupKeys - - List of keys of the admin groups

read - - Whether the admin groups to have read access over the specified IT Resource

write - - Whether the admin groups to have write access over the specified IT Resource

delete - - Whether the admin groups to have delete access over the specified IT Resource

Throws:

tcAdminNotFoundException - thrown if one or many palAdminGroupKeys do not exist

tcITResourceNotFoundException - thrown if plITResourceInstanceKey does not exist

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

tcBulkException

Since:

9.1

removeAdministrators

void removeAdministrators(long plITResourceInstanceKey,
                          long[] palAdminGroupKeys)
                          throws tcAdminNotFoundException,
                                 tcITResourceNotFoundException,
                                 tcAPIException,
                                 tcBulkException,
                                 tcAPIException

Removes a list of groups from having administrative control over a specified IT Resource

Parameters:

plITResourceInstanceKey - - IT Resource instance key

palAdminGroupKeys - - The keys of the admin groups

Throws:

tcAdminNotFoundException - thrown if one or many palAdminGroupKeys do not exist

tcITResourceNotFoundException - thrown if plITResourceInstanceKey does not exist

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

tcBulkException

Since:

9.1

deleteITResourceInstance

void deleteITResourceInstance(long plITResourceInstanceKey)
                              throws tcAPIException,
                                     tcITResourceNotFoundException,
                                     tcAPIException

Deletes a IT Resource instance from the Xellerate

Parameters:

plITResourceInstanceKey - key of the IT Resource instance to be deleted

Throws:

tcAPIException

tcITResourceNotFoundException

Since:

9.1

getAdministrators

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

Gets a list of the groups that have administrative control over the specified IT resource

Parameters:

searchCriteria - Map holding the search criteria with key in Metadata form for filtering Groups e.g. Key=Groups.Group Name & Value=G1, IT Resource.Key=1 Metadata Keys that can be passed are as follows: IT Resource.Key, IT Resource.Name, IT Resource.Note, IT Resource.Parameter.Key, IT Resource.Parameter.Value, IT Resource.Row Version, IT Resource.System Level, IT Resource.Updated By, Groups.Created By, Groups.E-mail, Groups.Group Name, Groups.Key, IT Resource-IT Resource Ownership.Read, IT Resource-IT Resource Ownership.Write IT Resource-IT Resource Ownership.Delete

Returns:

A result set containing the key, name and read/write/delete permissions of the groups that have administrative control over this IT resource

Throws:

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

tcITResourceNotFoundException - If the specified IT Resource Key does not exist in the databse

Since:

9.2

getUnassignedAdministrators

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

Gets a list of the groups that are not assigned as the administrative groups of a specified plITResourceInstanceKey

Parameters:

searchCriteria - Map holding the search criteria with key in Metadata form for filtering Groups e.g. Key=Groups.Group Name & Value=G1, IT Resource.Key=1 Metadata Keys that can be passed are as follows: IT Resource.Key, IT Resource.Name, IT Resource.Note, IT Resource.Parameter.Key, IT Resource.Parameter.Value, IT Resource.Row Version, IT Resource.System Level, IT Resource.Updated By, Groups.Created By, Groups.E-mail, Groups.Group Name, Groups.Key, IT Resource-IT Resource Ownership.Read, IT Resource-IT Resource Ownership.Write IT Resource-IT Resource Ownership.Delete

Returns:

A result set containing the key, name and read/write/delete permissions of the groups that are not assigned as the administrative group for this IT resource

Throws:

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

tcITResourceNotFoundException - If the specified IT Resource Key does not exist in the databse

Since:

9.2

Skip navigation links