thunderbird-dev 11.0.1+build1-0ubuntu2 / usr / include / thunderbird-11.0.1 / nsIAbLDAPAttributeMap.h

/*
 * DO NOT EDIT.  THIS FILE IS GENERATED FROM /build/buildd/thunderbird-11.0.1+build1/build-tree/mozilla/mailnews/addrbook/public/nsIAbLDAPAttributeMap.idl
 */

#ifndef __gen_nsIAbLDAPAttributeMap_h__
#define __gen_nsIAbLDAPAttributeMap_h__


#ifndef __gen_nsISupports_h__
#include "nsISupports.h"
#endif

/* For IDL files that don't want to include root IDL files. */
#ifndef NS_NO_VTABLE
#define NS_NO_VTABLE
#endif
class nsISimpleEnumerator; /* forward declaration */

class nsILDAPMessage; /* forward declaration */

class nsIAbCard; /* forward declaration */


/* starting interface:    nsIAbLDAPAttributeMap */
#define NS_IABLDAPATTRIBUTEMAP_IID_STR "fa019fd1-7f3d-417a-8957-154cca0240be"

#define NS_IABLDAPATTRIBUTEMAP_IID \
  {0xfa019fd1, 0x7f3d, 0x417a, \
    { 0x89, 0x57, 0x15, 0x4c, 0xca, 0x02, 0x40, 0xbe }}

class NS_NO_VTABLE NS_SCRIPTABLE nsIAbLDAPAttributeMap : public nsISupports {
 public: 

  NS_DECLARE_STATIC_IID_ACCESSOR(NS_IABLDAPATTRIBUTEMAP_IID)

  /* ACString getAttributeList (in ACString aProperty); */
  NS_SCRIPTABLE NS_IMETHOD GetAttributeList(const nsACString & aProperty, nsACString & _retval NS_OUTPARAM) = 0;

  /* void getAttributes (in ACString aProperty, out unsigned long aCount, [array, size_is (aCount), retval] out string aAttrs); */
  NS_SCRIPTABLE NS_IMETHOD GetAttributes(const nsACString & aProperty, PRUint32 *aCount NS_OUTPARAM, char * **aAttrs NS_OUTPARAM) = 0;

  /* ACString getFirstAttribute (in ACString aProperty); */
  NS_SCRIPTABLE NS_IMETHOD GetFirstAttribute(const nsACString & aProperty, nsACString & _retval NS_OUTPARAM) = 0;

  /* void setAttributeList (in ACString aProperty, in ACString aAttributeList, in boolean allowInconsistencies); */
  NS_SCRIPTABLE NS_IMETHOD SetAttributeList(const nsACString & aProperty, const nsACString & aAttributeList, bool allowInconsistencies) = 0;

  /* ACString getProperty (in ACString aAttribute); */
  NS_SCRIPTABLE NS_IMETHOD GetProperty(const nsACString & aAttribute, nsACString & _retval NS_OUTPARAM) = 0;

  /* ACString getAllCardAttributes (); */
  NS_SCRIPTABLE NS_IMETHOD GetAllCardAttributes(nsACString & _retval NS_OUTPARAM) = 0;

  /* void getAllCardProperties (out unsigned long aCount, [array, size_is (aCount), retval] out string aProps); */
  NS_SCRIPTABLE NS_IMETHOD GetAllCardProperties(PRUint32 *aCount NS_OUTPARAM, char * **aProps NS_OUTPARAM) = 0;

  /* void checkState (); */
  NS_SCRIPTABLE NS_IMETHOD CheckState(void) = 0;

  /* void setFromPrefs (in ACString aPrefBranchName); */
  NS_SCRIPTABLE NS_IMETHOD SetFromPrefs(const nsACString & aPrefBranchName) = 0;

  /* void setCardPropertiesFromLDAPMessage (in nsILDAPMessage aMessage, in nsIAbCard aCard); */
  NS_SCRIPTABLE NS_IMETHOD SetCardPropertiesFromLDAPMessage(nsILDAPMessage *aMessage, nsIAbCard *aCard) = 0;

};

  NS_DEFINE_STATIC_IID_ACCESSOR(nsIAbLDAPAttributeMap, NS_IABLDAPATTRIBUTEMAP_IID)

/* Use this macro when declaring classes that implement this interface. */
#define NS_DECL_NSIABLDAPATTRIBUTEMAP \
  NS_SCRIPTABLE NS_IMETHOD GetAttributeList(const nsACString & aProperty, nsACString & _retval NS_OUTPARAM); \
  NS_SCRIPTABLE NS_IMETHOD GetAttributes(const nsACString & aProperty, PRUint32 *aCount NS_OUTPARAM, char * **aAttrs NS_OUTPARAM); \
  NS_SCRIPTABLE NS_IMETHOD GetFirstAttribute(const nsACString & aProperty, nsACString & _retval NS_OUTPARAM); \
  NS_SCRIPTABLE NS_IMETHOD SetAttributeList(const nsACString & aProperty, const nsACString & aAttributeList, bool allowInconsistencies); \
  NS_SCRIPTABLE NS_IMETHOD GetProperty(const nsACString & aAttribute, nsACString & _retval NS_OUTPARAM); \
  NS_SCRIPTABLE NS_IMETHOD GetAllCardAttributes(nsACString & _retval NS_OUTPARAM); \
  NS_SCRIPTABLE NS_IMETHOD GetAllCardProperties(PRUint32 *aCount NS_OUTPARAM, char * **aProps NS_OUTPARAM); \
  NS_SCRIPTABLE NS_IMETHOD CheckState(void); \
  NS_SCRIPTABLE NS_IMETHOD SetFromPrefs(const nsACString & aPrefBranchName); \
  NS_SCRIPTABLE NS_IMETHOD SetCardPropertiesFromLDAPMessage(nsILDAPMessage *aMessage, nsIAbCard *aCard); 

/* Use this macro to declare functions that forward the behavior of this interface to another object. */
#define NS_FORWARD_NSIABLDAPATTRIBUTEMAP(_to) \
  NS_SCRIPTABLE NS_IMETHOD GetAttributeList(const nsACString & aProperty, nsACString & _retval NS_OUTPARAM) { return _to GetAttributeList(aProperty, _retval); } \
  NS_SCRIPTABLE NS_IMETHOD GetAttributes(const nsACString & aProperty, PRUint32 *aCount NS_OUTPARAM, char * **aAttrs NS_OUTPARAM) { return _to GetAttributes(aProperty, aCount, aAttrs); } \
  NS_SCRIPTABLE NS_IMETHOD GetFirstAttribute(const nsACString & aProperty, nsACString & _retval NS_OUTPARAM) { return _to GetFirstAttribute(aProperty, _retval); } \
  NS_SCRIPTABLE NS_IMETHOD SetAttributeList(const nsACString & aProperty, const nsACString & aAttributeList, bool allowInconsistencies) { return _to SetAttributeList(aProperty, aAttributeList, allowInconsistencies); } \
  NS_SCRIPTABLE NS_IMETHOD GetProperty(const nsACString & aAttribute, nsACString & _retval NS_OUTPARAM) { return _to GetProperty(aAttribute, _retval); } \
  NS_SCRIPTABLE NS_IMETHOD GetAllCardAttributes(nsACString & _retval NS_OUTPARAM) { return _to GetAllCardAttributes(_retval); } \
  NS_SCRIPTABLE NS_IMETHOD GetAllCardProperties(PRUint32 *aCount NS_OUTPARAM, char * **aProps NS_OUTPARAM) { return _to GetAllCardProperties(aCount, aProps); } \
  NS_SCRIPTABLE NS_IMETHOD CheckState(void) { return _to CheckState(); } \
  NS_SCRIPTABLE NS_IMETHOD SetFromPrefs(const nsACString & aPrefBranchName) { return _to SetFromPrefs(aPrefBranchName); } \
  NS_SCRIPTABLE NS_IMETHOD SetCardPropertiesFromLDAPMessage(nsILDAPMessage *aMessage, nsIAbCard *aCard) { return _to SetCardPropertiesFromLDAPMessage(aMessage, aCard); } 

/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
#define NS_FORWARD_SAFE_NSIABLDAPATTRIBUTEMAP(_to) \
  NS_SCRIPTABLE NS_IMETHOD GetAttributeList(const nsACString & aProperty, nsACString & _retval NS_OUTPARAM) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAttributeList(aProperty, _retval); } \
  NS_SCRIPTABLE NS_IMETHOD GetAttributes(const nsACString & aProperty, PRUint32 *aCount NS_OUTPARAM, char * **aAttrs NS_OUTPARAM) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAttributes(aProperty, aCount, aAttrs); } \
  NS_SCRIPTABLE NS_IMETHOD GetFirstAttribute(const nsACString & aProperty, nsACString & _retval NS_OUTPARAM) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetFirstAttribute(aProperty, _retval); } \
  NS_SCRIPTABLE NS_IMETHOD SetAttributeList(const nsACString & aProperty, const nsACString & aAttributeList, bool allowInconsistencies) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetAttributeList(aProperty, aAttributeList, allowInconsistencies); } \
  NS_SCRIPTABLE NS_IMETHOD GetProperty(const nsACString & aAttribute, nsACString & _retval NS_OUTPARAM) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetProperty(aAttribute, _retval); } \
  NS_SCRIPTABLE NS_IMETHOD GetAllCardAttributes(nsACString & _retval NS_OUTPARAM) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAllCardAttributes(_retval); } \
  NS_SCRIPTABLE NS_IMETHOD GetAllCardProperties(PRUint32 *aCount NS_OUTPARAM, char * **aProps NS_OUTPARAM) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetAllCardProperties(aCount, aProps); } \
  NS_SCRIPTABLE NS_IMETHOD CheckState(void) { return !_to ? NS_ERROR_NULL_POINTER : _to->CheckState(); } \
  NS_SCRIPTABLE NS_IMETHOD SetFromPrefs(const nsACString & aPrefBranchName) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetFromPrefs(aPrefBranchName); } \
  NS_SCRIPTABLE NS_IMETHOD SetCardPropertiesFromLDAPMessage(nsILDAPMessage *aMessage, nsIAbCard *aCard) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetCardPropertiesFromLDAPMessage(aMessage, aCard); } 

#if 0
/* Use the code below as a template for the implementation class for this interface. */

/* Header file */
class nsAbLDAPAttributeMap : public nsIAbLDAPAttributeMap
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSIABLDAPATTRIBUTEMAP

  nsAbLDAPAttributeMap();

private:
  ~nsAbLDAPAttributeMap();

protected:
  /* additional members */
};

/* Implementation file */
NS_IMPL_ISUPPORTS1(nsAbLDAPAttributeMap, nsIAbLDAPAttributeMap)

nsAbLDAPAttributeMap::nsAbLDAPAttributeMap()
{
  /* member initializers and constructor code */
}

nsAbLDAPAttributeMap::~nsAbLDAPAttributeMap()
{
  /* destructor code */
}

/* ACString getAttributeList (in ACString aProperty); */
NS_IMETHODIMP nsAbLDAPAttributeMap::GetAttributeList(const nsACString & aProperty, nsACString & _retval NS_OUTPARAM)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* void getAttributes (in ACString aProperty, out unsigned long aCount, [array, size_is (aCount), retval] out string aAttrs); */
NS_IMETHODIMP nsAbLDAPAttributeMap::GetAttributes(const nsACString & aProperty, PRUint32 *aCount NS_OUTPARAM, char * **aAttrs NS_OUTPARAM)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* ACString getFirstAttribute (in ACString aProperty); */
NS_IMETHODIMP nsAbLDAPAttributeMap::GetFirstAttribute(const nsACString & aProperty, nsACString & _retval NS_OUTPARAM)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* void setAttributeList (in ACString aProperty, in ACString aAttributeList, in boolean allowInconsistencies); */
NS_IMETHODIMP nsAbLDAPAttributeMap::SetAttributeList(const nsACString & aProperty, const nsACString & aAttributeList, bool allowInconsistencies)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* ACString getProperty (in ACString aAttribute); */
NS_IMETHODIMP nsAbLDAPAttributeMap::GetProperty(const nsACString & aAttribute, nsACString & _retval NS_OUTPARAM)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* ACString getAllCardAttributes (); */
NS_IMETHODIMP nsAbLDAPAttributeMap::GetAllCardAttributes(nsACString & _retval NS_OUTPARAM)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* void getAllCardProperties (out unsigned long aCount, [array, size_is (aCount), retval] out string aProps); */
NS_IMETHODIMP nsAbLDAPAttributeMap::GetAllCardProperties(PRUint32 *aCount NS_OUTPARAM, char * **aProps NS_OUTPARAM)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* void checkState (); */
NS_IMETHODIMP nsAbLDAPAttributeMap::CheckState()
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* void setFromPrefs (in ACString aPrefBranchName); */
NS_IMETHODIMP nsAbLDAPAttributeMap::SetFromPrefs(const nsACString & aPrefBranchName)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* void setCardPropertiesFromLDAPMessage (in nsILDAPMessage aMessage, in nsIAbCard aCard); */
NS_IMETHODIMP nsAbLDAPAttributeMap::SetCardPropertiesFromLDAPMessage(nsILDAPMessage *aMessage, nsIAbCard *aCard)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* End of implementation class template. */
#endif


/* starting interface:    nsIAbLDAPAttributeMapService */
#define NS_IABLDAPATTRIBUTEMAPSERVICE_IID_STR "12e2d589-3c2a-48e4-8c82-b1e6464a0dfd"

#define NS_IABLDAPATTRIBUTEMAPSERVICE_IID \
  {0x12e2d589, 0x3c2a, 0x48e4, \
    { 0x8c, 0x82, 0xb1, 0xe6, 0x46, 0x4a, 0x0d, 0xfd }}

class NS_NO_VTABLE NS_SCRIPTABLE nsIAbLDAPAttributeMapService : public nsISupports {
 public: 

  NS_DECLARE_STATIC_IID_ACCESSOR(NS_IABLDAPATTRIBUTEMAPSERVICE_IID)

  /* nsIAbLDAPAttributeMap getMapForPrefBranch (in ACString aPrefBranchName); */
  NS_SCRIPTABLE NS_IMETHOD GetMapForPrefBranch(const nsACString & aPrefBranchName, nsIAbLDAPAttributeMap * *_retval NS_OUTPARAM) = 0;

};

  NS_DEFINE_STATIC_IID_ACCESSOR(nsIAbLDAPAttributeMapService, NS_IABLDAPATTRIBUTEMAPSERVICE_IID)

/* Use this macro when declaring classes that implement this interface. */
#define NS_DECL_NSIABLDAPATTRIBUTEMAPSERVICE \
  NS_SCRIPTABLE NS_IMETHOD GetMapForPrefBranch(const nsACString & aPrefBranchName, nsIAbLDAPAttributeMap * *_retval NS_OUTPARAM); 

/* Use this macro to declare functions that forward the behavior of this interface to another object. */
#define NS_FORWARD_NSIABLDAPATTRIBUTEMAPSERVICE(_to) \
  NS_SCRIPTABLE NS_IMETHOD GetMapForPrefBranch(const nsACString & aPrefBranchName, nsIAbLDAPAttributeMap * *_retval NS_OUTPARAM) { return _to GetMapForPrefBranch(aPrefBranchName, _retval); } 

/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */
#define NS_FORWARD_SAFE_NSIABLDAPATTRIBUTEMAPSERVICE(_to) \
  NS_SCRIPTABLE NS_IMETHOD GetMapForPrefBranch(const nsACString & aPrefBranchName, nsIAbLDAPAttributeMap * *_retval NS_OUTPARAM) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetMapForPrefBranch(aPrefBranchName, _retval); } 

#if 0
/* Use the code below as a template for the implementation class for this interface. */

/* Header file */
class nsAbLDAPAttributeMapService : public nsIAbLDAPAttributeMapService
{
public:
  NS_DECL_ISUPPORTS
  NS_DECL_NSIABLDAPATTRIBUTEMAPSERVICE

  nsAbLDAPAttributeMapService();

private:
  ~nsAbLDAPAttributeMapService();

protected:
  /* additional members */
};

/* Implementation file */
NS_IMPL_ISUPPORTS1(nsAbLDAPAttributeMapService, nsIAbLDAPAttributeMapService)

nsAbLDAPAttributeMapService::nsAbLDAPAttributeMapService()
{
  /* member initializers and constructor code */
}

nsAbLDAPAttributeMapService::~nsAbLDAPAttributeMapService()
{
  /* destructor code */
}

/* nsIAbLDAPAttributeMap getMapForPrefBranch (in ACString aPrefBranchName); */
NS_IMETHODIMP nsAbLDAPAttributeMapService::GetMapForPrefBranch(const nsACString & aPrefBranchName, nsIAbLDAPAttributeMap * *_retval NS_OUTPARAM)
{
    return NS_ERROR_NOT_IMPLEMENTED;
}

/* End of implementation class template. */
#endif

// test whether one of the getters has actually found an attribute
#define ATTRMAP_FOUND_ATTR(rv, str) (NS_SUCCEEDED(rv) && !(str).IsEmpty())

#endif /* __gen_nsIAbLDAPAttributeMap_h__ */