Package de.xima.fc.dao.interfaces

Interface ISystemAuthenticatorDao

All Superinterfaces:

de.xima.cmn.dao.interfaces.IAbstractDao<SystemAuthenticator,Long,IEntityContext>, IGenericDao<SystemAuthenticator>, IMandantDependentBaseDao<SystemAuthenticator>

All Known Implementing Classes:

SystemAuthenticatorDao

public interface ISystemAuthenticatorDao
extends IMandantDependentBaseDao<SystemAuthenticator>

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
String	findUniqueName(IEntityContext ec, String candidate, SystemAuthenticator exclude)	Returns a name that is not taken by another SystemAuthenticator within the system.
SystemAuthenticator	getByCallback(IEntityContext ec, UUID callbackUuid)	Finds the system authenticator by its callback UUID.
SystemAuthenticator	getByUuid(IEntityContext ec, UUID uuid)
boolean	isNameExisiting(IEntityContext ec, String name)	Returns whether or not the given system authenticator name exists within system

Methods inherited from interface de.xima.cmn.dao.interfaces.IAbstractDao

all, bulkDelete, bulkUpdate, checkLockingVersion, create, create, delete, delete, deleteAll, executePagedDaoAction, getAttributes, getAttributes, getSingleAttributes, getSingleAttributes, getTransactionHandler, read, registerListener, registerListener, registerListener, resultTotalCount, setTransactionHandler, singleElement, unregisterListener, unregisterListener, unregisterListener, update, update

Methods inherited from interface de.xima.fc.dao.interfaces.IGenericDao

count, findAll, findSingle, getEntityRefs, read

Method Detail

getByUuid

@Nullable
SystemAuthenticator getByUuid(IEntityContext ec,
                              UUID uuid)

Parameters:

ec - Current entity context for accessing the database.

uuid - UUID of the authenticator to retrieve.

Returns:

The authenticator with the given UUID, or null when no such authenticator exist.

getByCallback

@Nullable
SystemAuthenticator getByCallback(IEntityContext ec,
                                  UUID callbackUuid)

Finds the system authenticator by its callback UUID.

Parameters:

ec - Current entity context for accessing the database.

callbackUuid - Callback UUID of the authenticator to retrieve.

Returns:

The authenticator with the given callback UUID, or null when no such authenticator exist.

findUniqueName

String findUniqueName(IEntityContext ec,
                      String candidate,
                      SystemAuthenticator exclude)

Returns a name that is not taken by another SystemAuthenticator within the system. An index will be added to the candidate if necessary.

Parameters:

ec - IEntityContext to be used

candidate - String authenticator name candidate to be made unique

exclude - SystemAuthenticator client resource to be excluded from the search. May be null.

Returns:

unique system authenticator name within the system

Since:

8.0.0

isNameExisiting

boolean isNameExisiting(IEntityContext ec,
                        String name)

Returns whether or not the given system authenticator name exists within system

Parameters:

ec - IEntityContext to be used

name - String authenticator name to check

Returns:

whether or not the given name is unique

Since:

8.0.0