Package Thor.API.Operations

Interface tcITResourceDefinitionOperationsIntf

All Superinterfaces:

tcUtilityOperationsIntf

public interface tcITResourceDefinitionOperationsIntf
extends tcUtilityOperationsIntf

Method Summary

Modifier and Type	Method	Description
Thor.API.tcResultSet	getITResourceDefinition(Map phAttributeList)	Returns the IT Resource definition(s) that match the provided attribute list.
Thor.API.tcResultSet	getITResourceDefinitionParameters(long plITResourceDefinitionKey)	Returns the IT Resource parameter(s) for the specified IT Resource definition.
void	updateITResourceDefinitionName(long itResourceDefinitionKey, Map attributes)	Updates the specified IT Resource type definition instance.

Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf

close, getName, setCountry, setLanguage, setVariant

Method Details

getITResourceDefinition

Thor.API.tcResultSet getITResourceDefinition(Map phAttributeList)
                                      throws tcAPIException,
tcAPIException

Returns the IT Resource definition(s) that match the provided attribute list.

Parameters:

phAttributeList - A Map of name-value pairs. The Map key should contain metadata codes and the Map value should contain the respective search criteria. Here is a list of metadata codes to use:

• IT Resources Type Definition.Key
• IT Resources Type Definition.Insert Multiple - value must be 0 or 1
• IT Resources Type Definition.Server Type - wild card(%) is allowed

Returns:

A tcResultSet containing the following IT Resource definition information:

• IT Resources Type Definition.Key
• IT Resources Type Definition.Server Type
• IT Resources Type Definition.Insert Multiple
• IT Resources Type Definition.Updated By
• IT Resources Type Definition.Update Date
• IT Resources Type Definition.Row Version
• IT Resources Type Definition.Creation Date
• IT Resources Type Definition.Created By

Throws:

tcAPIException

getITResourceDefinitionParameters

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

Returns the IT Resource parameter(s) for the specified IT Resource definition.

Parameters:

plITResourceDefinitionKey - The key of the IT Resource definition.

Returns:

A tcResultSet that contains the parameters for this IT Resource definition. Here is a list of metadata codes to use:

• IT Resources Type Parameter.Key
• IT Resources Type Parameter.Name
• IT Resources Type Parameter.Default
• IT Resources Type Parameter.Encrypted
• IT Resources Type Parameter.Updated By
• IT Resources Type Parameter.Update Date
• IT Resources Type Parameter.Row Version
• IT Resources Type Parameter.Creation Date
• IT Resources Type Parameter.Created By

Throws:

tcITResourceDefinitionNotFoundException

tcAPIException

updateITResourceDefinitionName

void updateITResourceDefinitionName(long itResourceDefinitionKey,
 Map attributes)
                             throws tcITResourceDefinitionNotFoundException,
tcAPIException,
tcInvalidAttributeException,
tcAPIException

Updates the specified IT Resource type definition instance.

Parameters:

itResourceDefinitionKey - The key of the IT Resource type definition instance

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

• IT Resources Type Definition.Server Type

Throws:

tcITResourceDefinitionNotFoundException - If the specified IT Resource type definition instance not found

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

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

Since:

11.1.1.4.0