Thor.API.Operations
Interface tcLocationOperationsIntf

public interface tcLocationOperationsIntf

Method Summary

Thor.API.tcResultSet	findLocations(java.util.Map phAttributeList) Returns a list of locations (in the form of a tcResultSet) that matches the provided attribute list.
Thor.API.tcResultSet	findLocationsFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList) Returns a list of Locations (in the form of tcResultSet) that match the provided attribute list.
Thor.API.tcResultSet	findSites(java.util.Map phAttributeList) Returns a list of sites (in the form of a tcResultSet) that matches the provided attribute list.
Thor.API.tcResultSet	getListOfSites(long plLocationKey) Returns a list of sites (in the form of a tcResultSet) that are in the specified location
java.lang.String[]	getUserLocationRoles() Returns a list of all the roles that can be assigned to a location when it is attached to a user.

Method Detail

findLocations

public Thor.API.tcResultSet findLocations(java.util.Map phAttributeList)
                                   throws Thor.API.Exceptions.tcAPIException,
                                          tcAPIException

Returns a list of locations (in the form of a tcResultSet) that matches the provided attribute list.

Parameters:

phAttributeList - A map of name-value pairs, each entry holding an attribute-value pair to match the location 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 (%).

Returns:

A tcResultSet in which each row holds details about the locations that were found

Throws:

tcAPIException

findLocationsFiltered

public Thor.API.tcResultSet findLocationsFiltered(java.util.Map phAttributeList,
                                                  java.lang.String[] pasFieldList)
                                           throws Thor.API.Exceptions.tcAPIException,
                                                  tcAPIException

Returns a list of Locations (in the form of tcResultSet) that match the provided attribute list.

Parameters:

phAttributeList - A map of name-value pairs, each entry holding an attribute-value pair to match the Location 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 multiple rows, each holding information about the Location

Throws:

tcAPIException

findSites

public Thor.API.tcResultSet findSites(java.util.Map phAttributeList)
                               throws Thor.API.Exceptions.tcAPIException,
                                      tcAPIException

Returns a list of sites (in the form of a tcResultSet) that matches the provided attribute list. The site information includes all the location information of that site.

Parameters:

phAttributeList - A map of name-value pairs, each entry holding an attribute-value pair to match the sites 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 (%). If the string includes a “”, replace it with a “%”. This enables the client using the API to use “” as a wild-card character.

Returns:

A tcResultSet in which each row holds details about the sites that were found

Throws:

tcAPIException

getListOfSites

public Thor.API.tcResultSet getListOfSites(long plLocationKey)
                                    throws Thor.API.Exceptions.tcAPIException,
                                           Thor.API.Exceptions.tcLocationNotFoundException,
                                           tcAPIException

Returns a list of sites (in the form of a tcResultSet) that are in the specified location

Parameters:

plLocationKey - The Key of the location whose sites are to be retrieved

Returns:

A tcResultSet in which each row holds details about the sites

Throws:

tcAPIException

tcLocationNotFoundException

getUserLocationRoles

public java.lang.String[] getUserLocationRoles()
                                        throws Thor.API.Exceptions.tcAPIException,
                                               tcAPIException

Returns a list of all the roles that can be assigned to a location when it is attached to a user.

Returns:

An array of strings in which each string holds a role name

Throws:

tcAPIException