|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface tcITResourceInstanceOperationsIntf
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 |
findITResourceInstancesAnonymous(java.util.Map phAttributeList) Returns the IT Resource instances that match the provided criteria. |
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 |
---|
Thor.API.tcResultSet findITResourceInstances(java.util.Map phAttributeList) throws tcAPIException, tcAPIException
phAttributeList
- A Map
of name-value pairs. The Map
key can contain two different types of values:
getITResourceDefinitionParameters
method. The Map
value would be the desired value for this IT resource parameter. The wildcard character(%) cannot be used here.Map
value should contain the respective search criteria and the wildcard character(%) can be used in this case.tcResultSet
containing the following IT Resource instance information:
tcAPIException
Thor.API.tcResultSet findITResourceInstancesAnonymous(java.util.Map phAttributeList) throws tcAPIException, tcAPIException
phAttributeList
- A Map
of name-value pairs. The Map
key can contain two different types of values:
getITResourceDefinitionParameters
method. The Map
value would be the desired value for this IT resource parameter. The wildcard character(%) cannot be used here.Map
value should contain the respective search criteria and the wildcard character(%) can be used in this case.tcResultSet
containing the following IT Resource instance information:
tcAPIException
Thor.API.tcResultSet getITResourceInstanceParameters(long plITResourceInstanceKey) throws tcITResourceNotFoundException, tcAPIException, tcAPIException
plITResourceInstanceKey
- The key of the IT resource instance.tcResultSet
containing the following information about the IT resource instance's parameters:
tcITResourceNotFoundException
tcAPIException
Thor.API.tcResultSet findITResourceInstancesByDefinition(long plITResourceDefinitionKey) throws tcITResourceDefinitionNotFoundException, tcAPIException, tcAPIException
plITResourceDefinitionKey
- The key of the IT Resource definition.tcResultSet
containing the following IT resource instance information:
tcITResourceDefinitionNotFoundException
tcAPIException
Thor.API.tcResultSet findITResourceInstancesByRemoteManager(long plRemoteManagerInstanceKey) throws tcRemoteManagerNotFoundException, tcAPIException, tcAPIException
plRemoteManagerInstanceKey
- The key of a Remote Manager instance.tcResultSet
containing the following IT resource instance information:
tcRemoteManagerNotFoundException
tcAPIException
Thor.API.tcResultSet findITResourceInstancesByRemoteManagerFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList) throws tcAPIException, tcInvalidAttributeException, tcAPIException
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.tcResultSet
containing the following IT resource instance information:
tcAPIException
tcInvalidAttributeException
void updateITResourceInstanceParameters(long plITResourceInstanceKey, java.util.Map attributes) throws tcITResourceNotFoundException, tcInvalidAttributeException, tcAPIException, tcAPIException
plITResourceInstanceKey
- The key of the IT resource instance.attributes
- Map containing the It Resource instance attribute key, value pairtcITResourceNotFoundException,
- If the specified IT Resource instance not foundtcInvalidAttributeException,
- If one or more of the attributes in the map are invalid attributes of the specified IT Resource instancetcAPIException
tcITResourceNotFoundException
tcInvalidAttributeException
void updateITResourceInstance(long msITResourceKey, java.util.Map attributes) throws tcITResourceNotFoundException, tcInvalidAttributeException, tcAPIException, tcAPIException
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.tcITResourceNotFoundException,
- If the specified IT Resource instance not foundtcInvalidAttributeException,
- If one or more of the attributes in the map are invalid attributes of the specified IT Resource instancetcAPIException
tcITResourceNotFoundException
tcInvalidAttributeException
java.util.HashMap getITResourceInstances(java.lang.String psITResourceType) throws tcAPIException, tcAPIException
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.HashMap
containing the key, name pair of IT resource instances for the given type. Returns an empty HashMap if the search yield no returns.tcAPIException
long createITResourceInstance(java.util.Map phAttributes) throws tcAPIException, tcAttributeMissingException, DuplicateITResourceInstanceException, tcInvalidAttributeException, tcAPIException
phAttributes
- - The attributes to set for the new ITResource being createdtcAPIException
- thrown if errors occur while savingDuplicateITResourceInstanceException
- thrown if IT Resource Name already existstcInvalidAttributeException
- thrown if a IT Resource instance key is provided as an attributetcAttributeMissingException
Thor.API.tcResultSet getAdministrators(long plITResourceInstanceKey) throws tcAPIException, tcITResourceNotFoundException, tcAPIException
plITResourceInstanceKey
- - IT Resource instance keytcAPIException
- thrown if data set errors occurtcITResourceNotFoundException
- thrown if plITResourceInstanceKey does not existThor.API.tcResultSet getUnassignedAdministrators(long plITResourceInstanceKey) throws tcITResourceNotFoundException, tcAPIException, tcAPIException
plITResourceInstanceKey
- - IT Resource instance keytcITResourceNotFoundException
- thrown if plITResourceInstanceKey does not existtcAPIException
- thrown if data set errors occurvoid addAdministrators(long plITResourceInstanceKey, long[] palAdminGroupKeys, boolean[] read, boolean[] write, boolean[] delete) throws tcAdminNotFoundException, tcAdminGroupInvalidException, tcITResourceNotFoundException, tcAPIException, tcBulkException, tcAPIException
plITResourceInstanceKey
- - IT Resource instance keypalAdminGroupKeys
- - The keys of the admin groupsread
- - Whether the admin groups to have write access over the specified IT Resourcewrite
- - Whether the admin groups to have write access over the specified IT Resourcedelete
- - Whether the admin groups to have delete access over the specified IT ResourcetcAdminNotFoundException
- thrown if one or many palAdminGroupKeys do not existtcAdminGroupInvalidException
- thrown if administrator is not allowed to be updatedtcITResourceNotFoundException
- thrown if plITResourceInstanceKey does not existtcAPIException
- thrown if errors occur in the data set OR while savingtcBulkException
void updateAdministrators(long plITResourceInstanceKey, long[] palAdminGroupKeys, boolean[] read, boolean[] write, boolean[] delete) throws tcAdminNotFoundException, tcITResourceNotFoundException, tcAPIException, tcBulkException, tcAPIException
plITResourceInstanceKey
- - IT Resource instance keypalAdminGroupKeys
- - List of keys of the admin groupsread
- - Whether the admin groups to have read access over the specified IT Resourcewrite
- - Whether the admin groups to have write access over the specified IT Resourcedelete
- - Whether the admin groups to have delete access over the specified IT ResourcetcAdminNotFoundException
- thrown if one or many palAdminGroupKeys do not existtcITResourceNotFoundException
- thrown if plITResourceInstanceKey does not existtcAPIException
- thrown if data set errors occur OR while saving OR plGroupKey does not correspond with palAdminGroupKeystcBulkException
void removeAdministrators(long plITResourceInstanceKey, long[] palAdminGroupKeys) throws tcAdminNotFoundException, tcITResourceNotFoundException, tcAPIException, tcBulkException, tcAPIException
plITResourceInstanceKey
- - IT Resource instance keypalAdminGroupKeys
- - The keys of the admin groupstcAdminNotFoundException
- thrown if one or many palAdminGroupKeys do not existtcITResourceNotFoundException
- thrown if plITResourceInstanceKey does not existtcAPIException
- thrown if data set errors occur OR while saving OR Group key doesn't correspond to Administrator Group keystcBulkException
void deleteITResourceInstance(long plITResourceInstanceKey) throws tcAPIException, tcITResourceNotFoundException, tcAPIException
plITResourceInstanceKey
- key of the IT Resource instance to be deletedtcAPIException
tcITResourceNotFoundException
Thor.API.tcResultSet getAdministrators(java.util.Map searchCriteria) throws tcAPIException, tcITResourceNotFoundException, tcAPIException
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.DeletetcAPIException
- Thrown if an error occurrs while retrieving the data about unassigned groups from the databasetcITResourceNotFoundException
- If the specified IT Resource Key does not exist in the databseThor.API.tcResultSet getUnassignedAdministrators(java.util.Map searchCriteria) throws tcAPIException, tcITResourceNotFoundException, tcAPIException
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.DeletetcAPIException
- Thrown if an error occurrs while retrieving the data about unassigned groups from the databasetcITResourceNotFoundException
- If the specified IT Resource Key does not exist in the databse
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |