public interface AdminAccountExtension
Modifier and Type | Method and Description |
---|---|
boolean |
addExtension(DirectoryService ds,
java.lang.String node,
java.io.Serializable ext)
Adds custom account extension data to the newly created account
directory node.
|
boolean |
cloneExtension(DirectoryService ds,
java.lang.String fromNode,
java.lang.String toNode)
Clones existing custom account extension data to the newly cloned
account directory node.
|
boolean |
deleteExtension(DirectoryService ds,
java.lang.String node)
Deletes custom account extension data associated with the account
directory node being deleted.
|
AccountReportsExtension |
getAccountReportsExtension()
Account reports extension point.
|
boolean |
isExtended(DirectoryService ds,
java.lang.String node)
Inspects the given account directory node and tells whether this account
has custom extension data associated with it.
|
boolean |
setExtension(DirectoryService ds,
java.lang.String node,
java.io.Serializable ext)
Changes custom account extension data associated with the exsiting
account directory node.
|
boolean isExtended(DirectoryService ds, java.lang.String node)
An instance of DirectoryService
is provided for the method,
which may be used to access the directory, should there be a need. The
calling thread is bound to the service already and should not unbind
itself. Typically, an editing batch would be open at the time of
the method call, so the implementation should not try opening a batch
internally.
ds
- instance of DirectoryService
that may be used
for all directory access needsnode
- full account directory node path and IDtrue
if this account possesses any extension databoolean addExtension(DirectoryService ds, java.lang.String node, java.io.Serializable ext) throws AccountExtValidationException
An instance of DirectoryService
is provided for the method,
which may be used to access the directory, should there be a need. The
calling thread is bound to the service already and should not unbind
itself. A directory editing batch is open at the time of
the method call, so the implementation should not try opening a batch
internally.
ds
- instance of DirectoryService
that may be used
for all directory access needsnode
- full account directory node path and IDext
- a container with extension data as received from the admin
client extension plugintrue
if operation was successful; otherwise
false
, which will cause the batch rollbackAccountExtValidationException
- if any exception is encountered while validating fields or
computing default field values, an exception will be thrown.boolean setExtension(DirectoryService ds, java.lang.String node, java.io.Serializable ext) throws AccountExtValidationException
An instance of DirectoryService
is provided for the method,
which may be used to access the directory, should there be a need. The
calling thread is bound to the service already and should not unbind
itself. A directory editing batch is open at the time of
the method call, so the implementation should not try opening a batch
internally.
ds
- instance of DirectoryService
that may be used
for all directory access needsnode
- full account directory node path and IDext
- a container with extension data as received from the admin
client extension plugintrue
if operation was successful; otherwise
false
, which will cause the batch rollbackAccountExtValidationException
- if any exception is encountered while validating fields or
computing default field values, an exception will be thrown.boolean cloneExtension(DirectoryService ds, java.lang.String fromNode, java.lang.String toNode) throws AccountExtValidationException
An instance of DirectoryService
is provided for the method,
which may be used to access the directory, should there be a need. The
calling thread is bound to the service already and should not unbind
itself. A directory editing batch is open at the time of
the method call, so the implementation should not try opening a batch
internally.
ds
- instance of DirectoryService
that may be used
for all directory access needsfromNode
- full account directory node path and ID of the source accounttoNode
- full account directory node path and ID of the target accounttrue
if operation was successful; otherwise
false
, which will cause the batch rollbackAccountExtValidationException
- if any exception is encountered while validating fields or
computing default field values, an exception will be thrown.boolean deleteExtension(DirectoryService ds, java.lang.String node)
An instance of DirectoryService
is provided for the method,
which may be used to access the directory, should there be a need. The
calling thread is bound to the service already and should not unbind
itself. A directory editing batch is open at the time of
the method call, so the implementation should not try opening a batch
internally.
ds
- instance of DirectoryService
that may be used
for all directory access needsnode
- full account directory node path and IDtrue
if operation was successful; otherwise
false
, which will cause the batch rollbackAccountReportsExtension getAccountReportsExtension()
AccountReportsExtension
or null
if no
extension is present.