Package com.avoka.fc.core.dao

Class LibraryDao

java.lang.Object

com.avoka.core.dao.BaseDao

com.avoka.fc.core.dao.AbstractDao

com.avoka.fc.core.dao.LibraryDao

public class LibraryDao
extends AbstractDao

Provides a DAO for the Library entity.

Since:

4.0.0

Field Summary

Fields inherited from class com.avoka.core.dao.BaseDao

FETCH_LIMIT, STATEMENT_MAX_NO_PARAMETERS

Constructor Summary

Constructors

Constructor	Description
LibraryDao()

Method Summary

Modifier and Type	Method	Description
Library	getLibraryForClient(Long clientId, String libraryName)	Deprecated. This method does not deterministically return a library because libraries are now also distinguished by version number.
Library	getLibraryForClient(Long clientId, String libraryNormalizedName, String version)	Return the library for the specified normalized name and version.
Library	getLibraryForClientByNormalizedName(Long clientId, String libraryNormalizedName)	Deprecated. This method does not deterministically return a library because libraries are now also distinguished by version number.
Library	getLibraryForPK(Object libraryId)	Return the library with the specified ID
Library	getLibraryForProject(Long projectId, String libraryName)	Deprecated. This method does not deterministically return a library because libraries are now also distinguished by version number.
Library	getLibraryForProject(Long projectId, String libraryNameNorm, String version)	Return the library for the specified project, name normalized and version.
Library	getLibraryForReleaseVersion(Long releaseVersionId, String libraryName)	Return the library for the specified name.
List<Library>	getLibraryList(String libraryType, String parentId)	Return a list of libraries for the given type and of the specified parent if defined.
Library	getReleaseLibraryForVersionNumber(String versionNumber, String libraryName)	Return the release library for the specified library name and version number.
Library	getReleaseLibraryForVersionNumberByNormalizedName(String versionNumber, String libraryNormalizedName)	Return the release library for the specified library normalized name and version number.
Library	getVersionLibraryForName(String libraryName)	Return the library for the specified name.

Methods inherited from class com.avoka.fc.core.dao.AbstractDao

andFilterClientExcludeNull, andFilterClientIncludeNull, andFilterClientOnly, isClientAccessAllowed, performQueryConfigCached

Methods inherited from class com.avoka.core.dao.BaseDao

addOrdering, addOrderingCaseInsensitive, addOrderingCaseSensitive, andQueryBetween, andQueryInExp, andQueryInExp, andQueryLikeIgnoreCaseExp, andQueryMatchDbExp, andQueryMatchExp, andQueryMatchIsNotNull, andQueryMatchIsNull, andQueryNoMatchExp, andQueryNotTrue, deleteObject, deleteObjects, findObject, getDataContext, getFetchLimit, getLogger, getObjectForPK, newObject, orQueryLikeIgnoreCaseExp, orQueryMatchExp, performNamedQuery, performNamedQuery, performNamedQuery, performNamedQuery, performNonSelectingQuery, performNonSelectingQuery, performNonSelectingQuery, performNonSelectingQuery, performQuery, performQuery, performQuery, registerNewObject, setCacheStrategy, setFetchLimit, setLocalCacheStrategy, setLocalCacheStrategy, setSharedCacheStrategy, toMap, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

LibraryDao

public LibraryDao()

Method Detail

getLibraryForPK

public Library getLibraryForPK(Object libraryId)

Return the library with the specified ID

Parameters:

libraryId - the OID of the library (required)

Returns:

the matching library, or null if not found

getLibraryForReleaseVersion

public Library getLibraryForReleaseVersion(Long releaseVersionId,
                                           String libraryName)

Return the library for the specified name. The library must be of type Library.TYPE_RELEASE and belong to the specified release version.

Parameters:

releaseVersionId - the release version ID (required)

libraryName - the name of the library (required)

Returns:

the library for the specified release version and name

getReleaseLibraryForVersionNumber

public Library getReleaseLibraryForVersionNumber(String versionNumber,
                                                 String libraryName)

Return the release library for the specified library name and version number. The library must be of type Library.TYPE_RELEASE and belong to the specified release version.

Parameters:

versionNumber - the version number of the release version (required)

libraryName - the name of the library (required)

Returns:

the library for the specified release version number and library name

Since:

5.0.0

getReleaseLibraryForVersionNumberByNormalizedName

public Library getReleaseLibraryForVersionNumberByNormalizedName(String versionNumber,
                                                                 String libraryNormalizedName)

Return the release library for the specified library normalized name and version number. The library must be of type Library.TYPE_RELEASE and belong to the specified release version.

Parameters:

versionNumber - the version number of the release version (required)

libraryNormalizedName - the normalized name of the library (required)

Returns:

the library for the specified release version number and library normalized name

Since:

17.10.0

getLibraryForClient

public Library getLibraryForClient(Long clientId,
                                   String libraryName)

Deprecated.

This method does not deterministically return a library because libraries are now also distinguished by version number. Please use getLibraryForClient(Long clientId, String libraryNormalizedName, String version) instead.

Return the library for the specified name. The library must be of type Library.TYPE_ORGANIZATION and belong to the specified client.

Parameters:

clientId - the client ID (required)

libraryName - the name of the library (required)

Returns:

the library for the specified client and name

getLibraryForClientByNormalizedName

public Library getLibraryForClientByNormalizedName(Long clientId,
                                                   String libraryNormalizedName)

Deprecated.

This method does not deterministically return a library because libraries are now also distinguished by version number. Please use getLibraryForClient(Long clientId, String libraryNormalizedName, String version) instead.

Return the library for the specified normalized name. The library must be of type Library.TYPE_ORGANIZATION and belong to the specified client.

Parameters:

clientId - the client ID (required)

libraryNormalizedName - the name of the library (required)

Returns:

the library for the specified client and normalized name

Since:

17.10.0

getLibraryForClient

public Library getLibraryForClient(Long clientId,
                                   String libraryNormalizedName,
                                   String version)

Return the library for the specified normalized name and version. The library must be of type Library.TYPE_ORGANIZATION and belong to the specified client.

Parameters:

clientId - the client ID (required)

libraryNormalizedName - the name of the library (required)

version - the version of the library (required)

Returns:

the library for the specified client and normalized name

Since:

17.10.0

getLibraryForProject

public Library getLibraryForProject(Long projectId,
                                    String libraryName)

Deprecated.

This method does not deterministically return a library because libraries are now also distinguished by version number. Please use getLibraryForProject(Long projectId, String libraryNormalizedName, String version) instead.

Return the library for the specified name. The library must be of type Library.TYPE_PROJECT and belong to the specified project.

Parameters:

projectId - the project ID (required)

libraryName - the name of the library (required)

Returns:

the library for the specified project and name

getLibraryForProject

public Library getLibraryForProject(Long projectId,
                                    String libraryNameNorm,
                                    String version)

Return the library for the specified project, name normalized and version. The library must be of type Library.TYPE_PROJECT and belong to the specified project.

Parameters:

projectId - the project ID (required)

libraryNameNorm - the name normalized of the library (required)

version - library version

Returns:

the library for the specified project, name normalized and version

Since:

17.10.0

getVersionLibraryForName

public Library getVersionLibraryForName(String libraryName)

Return the library for the specified name. The library must be of type Library.TYPE_FORM_DESIGN_VERSION.

Parameters:

libraryName - the name of the library (required)

Returns:

the form design version library for the specified name

getLibraryList

public List<Library> getLibraryList(String libraryType,
                                    String parentId)

Return a list of libraries for the given type and of the specified parent if defined.

Parameters:

libraryType - the type of library (required)

parentId - the parent entity id, which owns the library when a Organization, Project or Form Design Version library (optional)

Returns:

the list of libraries for the given type and of the specified parent if defined