|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
org.identityconnectors.framework.common.objects.AttributeInfo
public final class AttributeInfo
AttributeInfo is meta data responsible for describing an 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.
Nested Class Summary | |
---|---|
static class |
AttributeInfo.Flags Enum of modifier flags to use for attributes. |
Method Summary | |
---|---|
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 |
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() |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
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 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
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |