Package com.avoka.fc.core.dao

Class DocumentTypeDao

java.lang.Object

com.avoka.core.dao.BaseDao

com.avoka.fc.core.dao.AbstractDao

com.avoka.fc.core.dao.DocumentTypeDao

public class DocumentTypeDao
extends AbstractDao

Provides a DAO for the DocumentType entity.

See Also:

DocumentType

Field Summary

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

FETCH_LIMIT, STATEMENT_MAX_NO_PARAMETERS

Constructor Summary

Constructors

Constructor	Description
DocumentTypeDao()

Method Summary

Modifier and Type	Method	Description
List<DocumentType>	getDocumentTypeByCode(String code)	Return a list of document types with the specified document code
DocumentType	getDocumentTypeByName(String name, String clientId)	Return a document type with the specified name
DocumentType	getDocumentTypeForPK(Object id)	Return the document type with the specified OID
List<DocumentType>	getDocumentTypeList(String clientId, String keyword)	Return the list of document types matching the specified search criteria
List<DocumentType>	getDocumentTypesByClient(String clientId)	Return the list of document types for the specified client, sorted by name and code
List<DocumentType>	getGlobalDocumentTypes()	Return the list of global document types (those that are not associated with a particular client), sorted by name and code

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

DocumentTypeDao

public DocumentTypeDao()

Method Detail

getDocumentTypeForPK

public DocumentType getDocumentTypeForPK(Object id)

Return the document type with the specified OID

Parameters:

id - the OID

Returns:

the matching document type, or null if not found

getDocumentTypeList

public List<DocumentType> getDocumentTypeList(String clientId,
                                              String keyword)

Return the list of document types matching the specified search criteria

Parameters:

clientId - the client OID (optional); note that global document types are always returned even if a client OID is specified

keyword - the search keyword

Returns:

the list of matching document types

getGlobalDocumentTypes

public List<DocumentType> getGlobalDocumentTypes()

Return the list of global document types (those that are not associated with a particular client), sorted by name and code

Returns:

the list of global document types

getDocumentTypeByCode

public List<DocumentType> getDocumentTypeByCode(String code)

Return a list of document types with the specified document code

Parameters:

code - the code

Returns:

the list of matching document types

getDocumentTypesByClient

public List<DocumentType> getDocumentTypesByClient(String clientId)

Return the list of document types for the specified client, sorted by name and code

Parameters:

clientId - a valid client OID

Returns:

the list of document types for the client

getDocumentTypeByName

public DocumentType getDocumentTypeByName(String name,
                                          String clientId)

Return a document type with the specified name

Parameters:

name - the name

clientId - the OID of the client the document type belongs to (optional)

Returns:

the matching document type, if one exists