com.technia.tvc.core.db

Class PropertyUtils

java.lang.Object

com.technia.tvc.core.db.PropertyUtils

public final class PropertyUtils
extends java.lang.Object

This class simplifies the retrieval of properties on admin objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertyUtils.Property This class encapsulates a property on a specific admin.

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,PropertyUtils.Property>	listPropertiesOn(java.lang.String adminType, java.lang.String name) Lists the properties on the specified admin and returns them as a Map where the name of the property has been used as key.
static java.util.Map<java.lang.String,PropertyUtils.Property>	listPropertiesOn(java.lang.String onAdminType, java.lang.String onName, java.lang.String toAdminType, java.lang.String toName) Lists the properties on the specified admin and returns them as a Map where the name of the property has been used as key.
static PropertyUtils.Property	printPropertyOn(java.lang.String adminType, java.lang.String name, java.lang.String property) Prints the specified property on the specified admin.
static void	setPropertyOn(java.lang.String type, java.lang.String name, java.lang.String propertyName, java.lang.String propertyValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

listPropertiesOn

public static java.util.Map<java.lang.String,PropertyUtils.Property> listPropertiesOn(java.lang.String adminType,
                                                                                      java.lang.String name)
                                                                               throws TVCException

Lists the properties on the specified admin and returns them as a Map where the name of the property has been used as key. Each property is abstracted by an instance of PropertyUtils.Property.

Parameters:

adminType - the admin type (e.g., type, attribute, program).

name - the name of the admin (i.e., the name of the type, or attribute, or program).

Returns:

a Map containing the properties on the specified admin.

Throws:

TVCException - if unable to retrieve the properties on the specified admin.

java.lang.NullPointerException - if any of the arguments are null.

listPropertiesOn

public static java.util.Map<java.lang.String,PropertyUtils.Property> listPropertiesOn(java.lang.String onAdminType,
                                                                                      java.lang.String onName,
                                                                                      java.lang.String toAdminType,
                                                                                      java.lang.String toName)
                                                                               throws TVCException

Lists the properties on the specified admin and returns them as a Map where the name of the property has been used as key. Each property is abstracted by an instance of PropertyUtils.Property.

Parameters:

onAdminType - the admin type (e.g., type, attribute, program) where to find the properties.

onName - the name of the admin (i.e., the name of the type, or attribute, or program) where to find the properties.

toAdminType - the admin type (e.g., type, attribute, program), which the properties are to.

toName - the name of the admin (i.e., the name of the type, or attribute, or program), which the properties are to.

Returns:

a Map containing the properties on the specified "on" admin to the specified "to" admin.

Throws:

TVCException - if unable to retrieve the properties on the specified admin.

java.lang.NullPointerException - if the ctx, onAdminType, or onName arguments are null.

printPropertyOn

public static PropertyUtils.Property printPropertyOn(java.lang.String adminType,
                                                     java.lang.String name,
                                                     java.lang.String property)
                                              throws TVCException

Prints the specified property on the specified admin.

Parameters:

adminType - the admin type (e.g., type, attribute, program).

name - the name of the admin (i.e., the name of the type, or attribute, or program)

property - the name of the property.

Throws:

TVCException - if unable to print the specified property.

java.lang.NullPointerException - if any of the arguments are null.

setPropertyOn

public static void setPropertyOn(java.lang.String type,
                                 java.lang.String name,
                                 java.lang.String propertyName,
                                 java.lang.String propertyValue)
                          throws TVCException

Throws:

TVCException