public class TemplateEntry extends Object
Constructor and Description |
---|
TemplateEntry(Branch branch)
Creates a new template entry that will be associated with the provided
branch.
|
TemplateEntry(Template template,
org.forgerock.opendj.ldap.Dn parentDN)
Creates a new template entry that will be associated with the provided
template.
|
Modifier and Type | Method and Description |
---|---|
void |
addValue(TemplateValue value)
Adds the provided template value to this entry.
|
Branch |
getBranch()
Retrieves the branch used to generate this entry.
|
org.forgerock.opendj.ldap.Dn |
getDN()
Retrieves the DN for this template entry, if it is known.
|
org.forgerock.opendj.ldap.Dn |
getParentDN()
Retrieves the DN of the parent entry for this template entry.
|
Template |
getTemplate()
Retrieves the template used to generate this entry.
|
TemplateValue |
getValue(org.forgerock.opendj.ldap.schema.AttributeType attributeType)
Retrieves the value for the specified attribute, if defined.
|
List<TemplateValue> |
getValues(org.forgerock.opendj.ldap.schema.AttributeType attributeType)
Retrieves the set of values for the specified attribute, if defined.
|
boolean |
toLDIF(LDIFExportConfig exportConfig)
Writes this entry in LDIF form.
|
public TemplateEntry(Branch branch)
branch
- The branch to use when creating this template entry.public TemplateEntry(Template template, org.forgerock.opendj.ldap.Dn parentDN)
template
- The template used to generate this entry.parentDN
- The DN of the parent entry for this template entry.public Branch getBranch()
null
if it
is associated with a template instead of a branch.public Template getTemplate()
null
if
it is associated with a branch instead of a template.public org.forgerock.opendj.ldap.Dn getParentDN()
null
if there is no parent DN.public org.forgerock.opendj.ldap.Dn getDN()
null
if it cannot yet be determined.public TemplateValue getValue(org.forgerock.opendj.ldap.schema.AttributeType attributeType)
attributeType
- The attribute type for which to retrieve the value.null
if
there are no values for that attribute type.public List<TemplateValue> getValues(org.forgerock.opendj.ldap.schema.AttributeType attributeType)
attributeType
- The attribute type for which to retrieve the set of
values.null
if there are no values for that attribute type.public void addValue(TemplateValue value)
value
- The value to add to this entry.public boolean toLDIF(LDIFExportConfig exportConfig) throws IOException, LDIFException
exportConfig
- The configuration that specifies how the
entry should be written.true
if the entry is actually written, or
false
if it is not for some reason.IOException
- If a problem occurs while writing the
information.LDIFException
- If a problem occurs while trying to
determine whether to write the entry.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.