Thor.API.Operations
Interface tcITResourceInstanceOperationsIntf

public interface tcITResourceInstanceOperationsIntf

Method Summary

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	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.
void	updateITResourceInstanceParameters(long plITResourceInstanceKey, java.util.Map attributes) Updates the parameter values of the specified IT Resource instance.

Method Detail

findITResourceInstances

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

public Thor.API.tcResultSet getITResourceInstanceParameters(long plITResourceInstanceKey)
                                                     throws Thor.API.Exceptions.tcITResourceNotFoundException,
                                                            Thor.API.Exceptions.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

public Thor.API.tcResultSet findITResourceInstancesByDefinition(long plITResourceDefinitionKey)
                                                         throws Thor.API.Exceptions.tcITResourceDefinitionNotFoundException,
                                                                Thor.API.Exceptions.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

public Thor.API.tcResultSet findITResourceInstancesByRemoteManager(long plRemoteManagerInstanceKey)
                                                            throws Thor.API.Exceptions.tcRemoteManagerNotFoundException,
                                                                   Thor.API.Exceptions.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

updateITResourceInstanceParameters

public void updateITResourceInstanceParameters(long plITResourceInstanceKey,
                                               java.util.Map attributes)
                                        throws Thor.API.Exceptions.tcITResourceNotFoundException,
                                               Thor.API.Exceptions.tcInvalidAttributeException,
                                               Thor.API.Exceptions.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

Thor.API.Exceptions.tcITResourceNotFoundException

Thor.API.Exceptions.tcInvalidAttributeException

Since:

8.0

getITResourceInstances

public java.util.HashMap getITResourceInstances(java.lang.String psITResourceType)
                                         throws Thor.API.Exceptions.tcAPIException,
                                                tcAPIException

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

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