org.tranche.clc
Class TrancheServerCommandLineClientItemAttribute

java.lang.Object
  org.tranche.clc.TrancheServerCommandLineClientItemAttribute

public class TrancheServerCommandLineClientItemAttribute
extends java.lang.Object

A Tranch Server CLC item attribute class.

Author:

Jayson Falkner - jfalkner@umich.edu

Constructor Summary

TrancheServerCommandLineClientItemAttribute(java.lang.String name, java.lang.String description)
Create a CLC item attribute with a name, description defaulting that the attribute is not required.

TrancheServerCommandLineClientItemAttribute(java.lang.String name, java.lang.String description, boolean required)
Createa a CLC item attribute with a name, description, and marking if it is a required attribute.

Method Summary

java.lang.String	getDescription() Retrieve the description of the item attribute.
java.lang.String	getName() Retrieve the name of the item attribute.
boolean	isRequired() Return true if item attribute is required; otherwise false.

Methods inherited from class java.lang.Object

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

Constructor Detail

TrancheServerCommandLineClientItemAttribute

public TrancheServerCommandLineClientItemAttribute(java.lang.String name,
                                                   java.lang.String description)

Create a CLC item attribute with a name, description defaulting that the attribute is not required.

Parameters:

name - the name of the attribute

description - the description of the attribute

TrancheServerCommandLineClientItemAttribute

public TrancheServerCommandLineClientItemAttribute(java.lang.String name,
                                                   java.lang.String description,
                                                   boolean required)

Createa a CLC item attribute with a name, description, and marking if it is a required attribute.

Parameters:

name - the name of the attribute

description - the description of the attribute

required - the required flag

Method Detail

getName

public java.lang.String getName()

Retrieve the name of the item attribute.

Returns:

the name of an attribute

getDescription

public java.lang.String getDescription()

Retrieve the description of the item attribute.

Returns:

the description of an attribute

isRequired

public boolean isRequired()

Return true if item attribute is required; otherwise false.

Returns:

true is an attribute is required; false otherwise