|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.waveset.object.AccountAttributeType
Provides the mapping between a Waveset user attribute and a resource-specific account attribute. It can also provide default values for the resource account attribute if the Waveset user does not have a value.
If a Waveset user attribute is used across multiple resources,
it should be defined globally as an AttributeDefinition
.
setAttributeDefinition(AttributeDefinition)
,
If a Waveset user attribute is used only for a single resource,
it can be described locally using methods of this class:
- {@link #setName()}
- {@link #setSyntax()}
- {@link #setMulti()}
- {@link #setOrdered()}
- {@link #setReadOnly()}
- {@link #setWriteOnly()}
it should refer to an AttributeDefinition.
NOTE:Fields that describe how the attribute maps to a
Resource are always defined locally:
- {@link #setMapName()}
- {@link #setMapType()}
- {@link #setRequired()}
- {@link #setIsAuditable()}
Field Summary | |
static java.lang.String |
ATT_ID
|
static java.lang.String |
ATT_MULTI
|
static java.lang.String |
ATT_ORDERED
|
static java.lang.String |
ATT_READONLY
|
static java.lang.String |
ATT_VISUALIZE
|
static java.lang.String |
ATT_WRITEONLY
|
static java.lang.String |
code_id
|
static java.lang.String |
EL_VIEWS
|
protected static Trace |
trace
|
Constructor Summary | |
AccountAttributeType()
Be sure to use setParent() to set the parent of this account attribute type, so it can use the parent to resolve the object reference to the Attribute Definition object. |
|
AccountAttributeType(PersistentObject parent)
|
|
AccountAttributeType(PersistentObject parent,
ObjectRef attrDefRef,
java.lang.String mapName,
java.lang.String mapType,
boolean required)
|
Method Summary | |
int |
compareTo(java.lang.Object what)
Implement compareTo for comparable. |
java.lang.Object[] |
getAllValues()
Returns an array of the the attribute's values. |
AttributeDefinition |
getAttributeDefinition()
|
ObjectRef |
getAttributeDefinitionRef()
Method for callers that cannot resolve references but still need to know whether this is a global attribute definition. |
java.lang.String |
getAttrType()
Deprecated. since 2.5. Use getSyntax() instead. |
AttributeValues |
getAttrValues()
|
int |
getId()
|
boolean |
getIsOrdered()
|
java.lang.String |
getMapName()
|
java.lang.String |
getMapType()
|
java.lang.String |
getName()
|
PersistentObject |
getParent()
|
boolean |
getRequired()
|
Syntax |
getSyntax()
|
java.lang.Object |
getValue()
Returns one of the attribute's values. |
java.util.List |
getViews()
|
boolean |
isAuditable()
|
boolean |
isMulti()
Return true if the attribute supports multiple values. |
boolean |
isOrdered()
|
boolean |
isReadOnly()
|
boolean |
isRequired()
|
boolean |
isWriteOnly()
|
void |
parseXml(org.w3c.dom.Element e)
|
void |
parseXml(java.lang.String xml)
|
void |
prepareForSerialization()
Override PersistentObject to resolve any reference to an instance of AttributeDefinition this object may need in order to serialize itself as XML. |
void |
setAttributeDefinition(AttributeDefinition attrDef)
|
void |
setAttributeDefinitionRef(ObjectRef ref)
|
void |
setAttrType(java.lang.String attrType)
Deprecated. since 2.5. Use setSyntax() instead. |
void |
setIsAuditable(boolean auditable)
|
void |
setMapName(java.lang.String mapName)
|
void |
setMapType(java.lang.String mapType)
|
void |
setMulti(boolean b)
|
void |
setName(java.lang.String name)
Sets the _name value. |
void |
setOrdered(boolean b)
|
void |
setParent(PersistentObject parent)
|
void |
setReadOnly(boolean b)
|
void |
setRequired(boolean required)
|
void |
setSyntax(java.lang.String syntaxName)
|
void |
setSyntax(Syntax syntax)
Sets the _syntax value. |
void |
setValue(java.lang.Object value)
Adds the value to the attribute's values. |
void |
setValue(java.lang.Object value,
java.lang.String type)
Method that should only be used for testing |
void |
setViews(java.util.List views)
|
void |
setVisualize(boolean b)
|
void |
setWriteOnly(boolean b)
|
java.lang.String |
toString()
|
java.lang.String |
toXml()
|
void |
toXml(java.lang.StringBuffer buf)
|
boolean |
visualize()
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final java.lang.String code_id
protected static final Trace trace
public static final java.lang.String EL_VIEWS
public static final java.lang.String ATT_ID
public static final java.lang.String ATT_MULTI
public static final java.lang.String ATT_ORDERED
public static final java.lang.String ATT_READONLY
public static final java.lang.String ATT_WRITEONLY
public static final java.lang.String ATT_VISUALIZE
Constructor Detail |
public AccountAttributeType(PersistentObject parent)
public AccountAttributeType()
public AccountAttributeType(PersistentObject parent, ObjectRef attrDefRef, java.lang.String mapName, java.lang.String mapType, boolean required)
Method Detail |
public int getId()
public void setMulti(boolean b)
public void setOrdered(boolean b)
public void setReadOnly(boolean b)
public void setWriteOnly(boolean b)
public void setVisualize(boolean b)
public void setViews(java.util.List views)
public PersistentObject getParent()
public void setParent(PersistentObject parent)
public java.lang.String toString()
public java.lang.String getName()
public Syntax getSyntax()
public java.lang.String getAttrType()
public boolean isOrdered()
true
if the order of attribute values is significant;
otherwise false
.
Normally this will be specified with the _ordered field though we also allow it to be defined in an external AttributeDefinition object.
public boolean isMulti()
public java.lang.Object getValue()
public java.lang.Object[] getAllValues()
public AttributeValues getAttrValues()
public java.lang.String getMapName()
public java.lang.String getMapType()
public boolean getRequired()
public boolean isRequired()
public boolean isAuditable()
public boolean isReadOnly()
public boolean isWriteOnly()
public boolean visualize()
public java.util.List getViews()
public boolean getIsOrdered()
public AttributeDefinition getAttributeDefinition() throws WavesetException
WavesetException
- if no AttributeDefinition can be found.public ObjectRef getAttributeDefinitionRef()
public void setName(java.lang.String name)
public void setSyntax(Syntax syntax)
public void setSyntax(java.lang.String syntaxName)
public void setAttrType(java.lang.String attrType)
public void setValue(java.lang.Object value) throws WavesetException
WavesetException
public void setValue(java.lang.Object value, java.lang.String type) throws WavesetException
WavesetException
public void setMapName(java.lang.String mapName)
public void setMapType(java.lang.String mapType)
public void setRequired(boolean required)
public void setIsAuditable(boolean auditable)
public void setAttributeDefinition(AttributeDefinition attrDef)
public void setAttributeDefinitionRef(ObjectRef ref)
public int compareTo(java.lang.Object what)
compareTo
in interface java.lang.Comparable
public void prepareForSerialization() throws WavesetException
WavesetException
public java.lang.String toXml()
public void toXml(java.lang.StringBuffer buf)
public void parseXml(java.lang.String xml) throws WavesetException
WavesetException
public void parseXml(org.w3c.dom.Element e) throws WavesetException
WavesetException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |