com.uc4.api

Class UC4UserName

java.lang.Object

com.uc4.api.UC4ObjectName

com.uc4.api.UC4UserName

public class UC4UserName
extends UC4ObjectName

This class represents the name of a USER object. It contains checks to test if the name is valid for a USER object.

Constructor Summary

Constructors

Constructor and Description
UC4UserName(String name) Constructs a UC4UserName using the specified name.
UC4UserName(UC4UserName name) Constructs a UC4UserName using the specified parameters.

Method Summary

Modifier and Type	Method and Description
String	getAllowedChars() Returns the allowed characters of an object name
boolean	isValid(String name) Tests if the supplied name would be a valid name for an object in the Automation Engine.
boolean	isValidUsername() Returns true if this object contains a valid user name.

Methods inherited from class com.uc4.api.UC4ObjectName

containsVariable, containsVariable, equals, getName, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UC4UserName

public UC4UserName(String name)
            throws InvalidUC4NameException

Constructs a UC4UserName using the specified name.

Parameters:

name - name

Throws:

InvalidUC4NameException - if the name is not empty and invalid

UC4UserName

public UC4UserName(UC4UserName name)

Constructs a UC4UserName using the specified parameters.

Parameters:

name - UC4UserName

Method Detail

isValid

public boolean isValid(String name)

Description copied from class: UC4ObjectName

Tests if the supplied name would be a valid name for an object in the Automation Engine. The test is case insensitive.

Overrides:

isValid in class UC4ObjectName

Parameters:

name - Name to be tested

Returns:

true if this is a valid name of an object

isValidUsername

public boolean isValidUsername()

Returns true if this object contains a valid user name.

Returns:

true if a user object with this name can be created, false if the name is not allowed.

getAllowedChars

public String getAllowedChars()

Description copied from class: UC4ObjectName

Returns the allowed characters of an object name

Overrides:

getAllowedChars in class UC4ObjectName

Returns:

String containing allowed characters. NULL is never returned.