public final class AttributeInfo
extends java.lang.Object
Attribute
. It can be programmatically determined at runtime or
statically constructed. The class determines if an Attribute
is
required, readable, writable, or nullable. In also includes the native type
and name. It is recommended that date fields be represented as a long with
time zone UTC. It should be up to the display or separate attributes if the
time zone is necessary.Modifier and Type | Class and Description |
---|---|
static class |
AttributeInfo.Flags
Enum of modifier flags to use for attributes.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.util.Set<AttributeInfo.Flags> |
getFlags()
Returns the set of flags associated with the attribute.
|
java.lang.String |
getName()
The native name of the attribute.
|
java.lang.String |
getObjectClassName()
For attributes that hold an embedded object, returns the name of
the object class representing that object.
|
java.lang.Class<?> |
getType()
The basic type associated with this attribute.
|
int |
hashCode() |
boolean |
is(java.lang.String name)
Determines if the name parameter matches this
AttributeInfo . |
boolean |
isCreateable()
Determines if the attribute is writable on create.
|
boolean |
isGenerated()
Indicates whether the target-application generates or modifies value(s) for
Attribute during CreateApiOp or UpdateApiOp operations. |
boolean |
isMultiValued()
Determines if this attribute can handle multiple values.
|
boolean |
isReadable()
Determines if the attribute is readable.
|
boolean |
isRequired()
Determines whether this attribute is required for creates.
|
boolean |
isReturnedByDefault()
Determines if the attribute is returned by default.
|
boolean |
isUpdateable()
Determines if the attribute is writable on update.
|
java.lang.String |
toString() |
public java.lang.String getName()
public java.lang.Class<?> getType()
public java.lang.String getObjectClassName()
public java.util.Set<AttributeInfo.Flags> getFlags()
public boolean isReadable()
public boolean isCreateable()
public boolean isUpdateable()
public boolean isRequired()
public boolean isMultiValued()
public boolean isReturnedByDefault()
Attribute
will be returned during SearchApiOp
, SyncApiOp
or GetApiOp
inside a ConnectorObject
by default. The default
value is true
.public boolean is(java.lang.String name)
AttributeInfo
.public boolean isGenerated()
Attribute
during CreateApiOp
or UpdateApiOp
operations. If so, then the caller using ICF
may want to re-read the values of this attribute after CreateApiOp
or UpdateApiOp
operation.public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object