Package de.xima.fc.api.entity

Class LDAPAbfrageAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.entity.AEntityAPI<LDAPAbfrage>

de.xima.fc.api.entity.LDAPAbfrageAPI

public class LDAPAbfrageAPI
extends AEntityAPI<LDAPAbfrage>

API class for manipulation of LDAPAbfrage entities.

Author:

XIMA MEDIA GmbH

Field Summary

Fields inherited from class de.xima.fc.api.entity.AEntityAPI

entityClass

Constructor Summary

Constructors

Constructor	Description
LDAPAbfrageAPI()

Method Summary

Modifier and Type	Method	Description
com.alibaba.fastjson.JSONArray	executePublicQuery(UserContext uc, Mandant man, String queryName, Serializable[] parameters)
com.alibaba.fastjson.JSONArray	executePublicQuery(UserContext uc, Mandant man, String queryName, Serializable[] parameters, IReplacerParams replacerParams)
com.alibaba.fastjson.JSONArray	executeQuery(UserContext uc, Mandant man, String abfrageName, Serializable[] parameters)	Method for executing a query by query name.

Methods inherited from class de.xima.fc.api.entity.AEntityAPI

create, create, delete, delete, deleteAllBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getEntityRefs, getSingleAttributes, getSingleAttributes, resultTotalCount, resultTotalCount, update, update

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LDAPAbfrageAPI

public LDAPAbfrageAPI()

Method Detail

executeQuery

public com.alibaba.fastjson.JSONArray executeQuery(UserContext uc,
                                                   Mandant man,
                                                   String abfrageName,
                                                   Serializable[] parameters)
                                            throws com.unboundid.ldap.sdk.LDAPException,
                                                   GeneralSecurityException,
                                                   IllegalArgumentException

Method for executing a query by query name.

Parameters:

uc - UserContext the user context in which the action is to be performed.

man - Mandant the client which will execute the query.

abfrageName - String the name of the query.

parameters - Serializable array of parameters for the query.

Returns:

JSONArray a JSON format.

Throws:

com.unboundid.ldap.sdk.LDAPException - occurs if LDAP exception is thrown. An LDAPException can result from physical problems (such as network errors) as well as problems with LDAP operations detected by the server.

GeneralSecurityException - occurs if a generic security exception is thrown.

IllegalArgumentException - thrown to indicate that a method has been passed an illegal or inappropriate argument.

executePublicQuery

public com.alibaba.fastjson.JSONArray executePublicQuery(UserContext uc,
                                                         Mandant man,
                                                         String queryName,
                                                         Serializable[] parameters)
                                                  throws com.unboundid.ldap.sdk.LDAPException,
                                                         GeneralSecurityException,
                                                         IllegalArgumentException

Throws:

com.unboundid.ldap.sdk.LDAPException

GeneralSecurityException

IllegalArgumentException

executePublicQuery

public com.alibaba.fastjson.JSONArray executePublicQuery(UserContext uc,
                                                         Mandant man,
                                                         String queryName,
                                                         Serializable[] parameters,
                                                         IReplacerParams replacerParams)
                                                  throws com.unboundid.ldap.sdk.LDAPException,
                                                         GeneralSecurityException,
                                                         IllegalArgumentException

Throws:

com.unboundid.ldap.sdk.LDAPException

GeneralSecurityException

IllegalArgumentException