KLDAPCore::LdapObject

Search for usage in LXR

KLDAPCore::LdapObject Class Reference

#include <ldapobject.h>

Public Member Functions

 LdapObject (const LdapObject &that)
 
 LdapObject (const QString &dn)
 
void addValue (const QString &attributeName, const QByteArray &value)
 
const LdapAttrMapattributes () const
 
void clear ()
 
LdapDN dn () const
 
bool hasAttribute (const QString &attributeName) const
 
LdapObjectoperator= (const LdapObject &that)
 
void setAttributes (const LdapAttrMap &attrs)
 
void setDn (const LdapDN &dn)
 
void setDn (const QString &dn)
 
void setValues (const QString &attributeName, const LdapAttrValue &values)
 
QString toString () const
 
QByteArray value (const QString &attributeName) const
 
LdapAttrValue values (const QString &attributeName) const
 

Detailed Description

This class represents an LDAP Object.

Definition at line 30 of file ldapobject.h.

Constructor & Destructor Documentation

◆ LdapObject() [1/2]

LdapObject::LdapObject ( )

Definition at line 31 of file ldapobject.cpp.

◆ LdapObject() [2/2]

LdapObject::LdapObject ( const QString & dn)
explicit

Definition at line 36 of file ldapobject.cpp.

Member Function Documentation

◆ addValue()

void LdapObject::addValue ( const QString & attributeName,
const QByteArray & value )

Adds the given value to the specified attribute.

If the given attribute not exists, then it's created.

Parameters
attributeNamethe attribute for which to add a value
valuethe attribute value to add

Definition at line 107 of file ldapobject.cpp.

◆ attributes()

const LdapAttrMap & LdapObject::attributes ( ) const
nodiscard

Returns the attributes and their values.

Definition at line 77 of file ldapobject.cpp.

◆ clear()

void LdapObject::clear ( )

Clears the name and attributes of the object.

Definition at line 96 of file ldapobject.cpp.

◆ dn()

LdapDN LdapObject::dn ( ) const
nodiscard

Return the Distinguished Name of the object.

Definition at line 72 of file ldapobject.cpp.

◆ hasAttribute()

bool LdapObject::hasAttribute ( const QString & attributeName) const
nodiscard

Returns true if the given attributethe exists, false otherwise.

Definition at line 130 of file ldapobject.cpp.

◆ operator=()

LdapObject & LdapObject::operator= ( const LdapObject & that)

Definition at line 48 of file ldapobject.cpp.

◆ setAttributes()

void LdapObject::setAttributes ( const LdapAttrMap & attrs)

Sets the attributes and attribute values of the object.

Definition at line 67 of file ldapobject.cpp.

◆ setDn() [1/2]

void LdapObject::setDn ( const LdapDN & dn)

Sets the Distinguished Name of the object.

Definition at line 57 of file ldapobject.cpp.

◆ setDn() [2/2]

void LdapObject::setDn ( const QString & dn)

Sets the Distinguished Name of the object.

Definition at line 62 of file ldapobject.cpp.

◆ setValues()

void LdapObject::setValues ( const QString & attributeName,
const LdapAttrValue & values )

Sets the given attribute values.

If the given attribute not exists, then it's created, if exists, it's overwritten.

Parameters
attributeNamethe attribute name for which to set values
valuesthe values of attribute to set

Definition at line 102 of file ldapobject.cpp.

◆ toString()

QString LdapObject::toString ( ) const
nodiscard

Returns the text presentation (LDIF format) of the object.

Definition at line 82 of file ldapobject.cpp.

◆ value()

QByteArray LdapObject::value ( const QString & attributeName) const
nodiscard

Returns the first value of the attribute with the given name or an empty byte array if the attribute does not exists.

Definition at line 121 of file ldapobject.cpp.

◆ values()

LdapAttrValue LdapObject::values ( const QString & attributeName) const
nodiscard

Returns all values of the attribute with the given name.

Definition at line 112 of file ldapobject.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 19 2024 11:59:34 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.