com.wm.app.tn.doc
Class BizDocAttribute

java.lang.Object
  com.wm.app.tn.util.TNFixedData
      com.wm.app.tn.doc.BizDocAttribute

All Implemented Interfaces:

com.wm.data.IData, java.lang.Cloneable

public class BizDocAttribute
extends TNFixedData

Definition of an attribute that can be extracted from documents. All attributes are associated with an internal ID, a name, a description, and a type. They can also be disabled, which means they won't be used anymore.

Nested Class Summary

Nested classes/interfaces inherited from class com.wm.app.tn.util.TNFixedData

TNFixedData.TreeCursor

Field Summary

static java.lang.String	TYPE_DATETIME
static java.lang.String	TYPE_DATETIME_LIST
static java.lang.String	TYPE_NUMBER
static java.lang.String	TYPE_NUMBER_LIST
static java.lang.String	TYPE_STRING
static java.lang.String	TYPE_STRING_LIST

Constructor Summary

BizDocAttribute()
For internal use only

BizDocAttribute(java.lang.String id, java.lang.String name, java.lang.String description, java.lang.String type, boolean deleted)

BizDocAttribute(java.lang.String id, java.lang.String name, java.lang.String description, java.lang.String type, boolean deleted, boolean persist)
For internal use only

Method Summary

static boolean	checkAttribCondition(BizDocAttribute a, BizDocEnvelope env, java.lang.String op, java.lang.String target) For internal use only
static com.wm.data.IData	create() For internal use only
boolean	equals(java.lang.Object o)
java.lang.String	getDescription()
java.lang.String	getId()
java.sql.Timestamp	getLastModifiedTime()
java.lang.String	getName()
java.lang.String	getType()
boolean	isDate()
boolean	isDateList()
boolean	isDeleted()
boolean	isList() Internal use only
boolean	isNumberList()
boolean	isNumeric()
boolean	isPersist()
boolean	isString()
boolean	isStringList()
boolean	isSystem()
boolean	isType(java.lang.String type)
void	setDeleted(boolean deleted) For internal use only
void	setDescription(java.lang.String description) For internal use only
void	setId(java.lang.String id) For internal use only
void	setLastModifiedTime(java.sql.Timestamp time) For internal use only
void	setName(java.lang.String name) For internal use only
void	setPersist(boolean persist) For internal use only
void	setSystem(boolean system) For internal use only
void	setType(java.lang.String type) For internal use only
java.lang.String	toMwSString()
java.lang.String	toString() Default toString implementation returns class name followed by contents.
static boolean	validateAttributeCondition(BizDocAttribute att, java.lang.String op, java.lang.String target) For internal use only

Methods inherited from class com.wm.app.tn.util.TNFixedData

clone, dataSize, get, get, getCursor, getHashCursor, getIndexCursor, getKey, getSharedCursor, getTreeCursor, indexOf, merge, set, set

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_STRING

public static final java.lang.String TYPE_STRING

See Also:

Constant Field Values

TYPE_NUMBER

public static final java.lang.String TYPE_NUMBER

See Also:

Constant Field Values

TYPE_DATETIME

public static final java.lang.String TYPE_DATETIME

See Also:

Constant Field Values

TYPE_STRING_LIST

public static final java.lang.String TYPE_STRING_LIST

See Also:

Constant Field Values

TYPE_NUMBER_LIST

public static final java.lang.String TYPE_NUMBER_LIST

See Also:

Constant Field Values

TYPE_DATETIME_LIST

public static final java.lang.String TYPE_DATETIME_LIST

See Also:

Constant Field Values

Constructor Detail

BizDocAttribute

public BizDocAttribute(java.lang.String id,
                       java.lang.String name,
                       java.lang.String description,
                       java.lang.String type,
                       boolean deleted,
                       boolean persist)

For internal use only

BizDocAttribute

public BizDocAttribute(java.lang.String id,
                       java.lang.String name,
                       java.lang.String description,
                       java.lang.String type,
                       boolean deleted)

BizDocAttribute

public BizDocAttribute()

For internal use only

Method Detail

getId

public java.lang.String getId()

Returns:

the internal ID of this attribute

getLastModifiedTime

public java.sql.Timestamp getLastModifiedTime()

Returns:

the time this attribute was last saved

getName

public java.lang.String getName()

Returns:

the name of this attribute

getDescription

public java.lang.String getDescription()

Returns:

the description of this attribute

getType

public java.lang.String getType()

Returns:

the type of this attribute (see TYPE_* constants)

isDeleted

public final boolean isDeleted()

Returns:

is this attribute deleted?

isPersist

public final boolean isPersist()

Returns:

should this attribute be persisted?

isSystem

public final boolean isSystem()

Returns:

is this attribute a system attribute?

isString

public final boolean isString()

Returns:

is this attribute a string?

isNumeric

public final boolean isNumeric()

Returns:

is this attribute a number?

isDate

public final boolean isDate()

Returns:

is this attribute a date?

isStringList

public final boolean isStringList()

Returns:

is this attribute a string list?

isNumberList

public final boolean isNumberList()

Returns:

is this attribute a number list?

isDateList

public final boolean isDateList()

Returns:

is this attribute a date list?

isType

public final boolean isType(java.lang.String type)

Returns:

is this attribute the specified type?

isList

public final boolean isList()

Internal use only

setId

public final void setId(java.lang.String id)

For internal use only

setLastModifiedTime

public final void setLastModifiedTime(java.sql.Timestamp time)

For internal use only

setName

public final void setName(java.lang.String name)

For internal use only

setDescription

public final void setDescription(java.lang.String description)

For internal use only

setType

public final void setType(java.lang.String type)

For internal use only

setDeleted

public final void setDeleted(boolean deleted)

For internal use only

setPersist

public final void setPersist(boolean persist)

For internal use only

setSystem

public final void setSystem(boolean system)

For internal use only

toString

public java.lang.String toString()

Description copied from class: TNFixedData

Default toString implementation returns class name followed by contents.

Overrides:

toString in class TNFixedData

Returns:

string rep for this object

toMwSString

public java.lang.String toMwSString()

Returns:

a String representation of a BizDocAttribute

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

Returns:

true if the supplied object is an attribute with the same internal ID as this one, false otherwise

create

public static com.wm.data.IData create()

For internal use only

checkAttribCondition

public static boolean checkAttribCondition(BizDocAttribute a,
                                           BizDocEnvelope env,
                                           java.lang.String op,
                                           java.lang.String target)
                                    throws java.lang.Exception

For internal use only

Throws:

java.lang.Exception

validateAttributeCondition

public static boolean validateAttributeCondition(BizDocAttribute att,
                                                 java.lang.String op,
                                                 java.lang.String target)

For internal use only