org.kuali.rice.kew.routeheader.service
Interface RouteHeaderService

All Known Implementing Classes:

RouteHeaderServiceImpl

public interface RouteHeaderService

A service providing data access for documents (a.k.a route headers).

Author:

Kuali Rice Team (rice.collab@kuali.org)

See Also:

DocumentRouteHeaderValue

Method Summary

void	clearRouteHeaderSearchValues(Long routeHeaderId) Removes all SearchableAttributeValues associated with the RouteHeader.
void	deleteRouteHeader(DocumentRouteHeaderValue routeHeader)
Collection	findByDocTypeAndAppId(String documentTypeName, String appId)
Collection	findPendingByResponsibilityIds(Set responsibilityIds)
String	getAppDocId(Long documentId)
DocumentRouteHeaderValueContent	getContent(Long routeHeaderId)
String	getDocumentStatus(Long documentId)
Long	getNextRouteHeaderId()
DocumentRouteHeaderValue	getRouteHeader(Long routeHeaderId)
DocumentRouteHeaderValue	getRouteHeader(Long routeHeaderId, boolean clearCache)
List<Timestamp>	getSearchableAttributeDateTimeValuesByKey(Long documentId, String key) This method is a more direct way to get the searchable attribute values
List<BigDecimal>	getSearchableAttributeFloatValuesByKey(Long documentId, String key) This method is a more direct way to get the searchable attribute values
List<Long>	getSearchableAttributeLongValuesByKey(Long documentId, String key) This method is a more direct way to get the searchable attribute values
List<String>	getSearchableAttributeStringValuesByKey(Long documentId, String key) This method is a more direct way to get the searchable attribute values
String	getServiceNamespaceByDocumentId(Long documentId) Returns the Service Namespace of the DocumentType for the Document with the given ID.
boolean	hasSearchableAttributeValue(Long documentId, String searchableAttributeKey, String searchableAttributeValue)
void	lockRouteHeader(Long routeHeaderId, boolean wait)
void	saveRouteHeader(DocumentRouteHeaderValue routeHeader)
void	updateRouteHeaderSearchValues(Long routeHeaderId, List<SearchableAttributeValue> searchAttributes) Updates the searchable attribute values for the document with the given id to the given values.
void	validateRouteHeader(DocumentRouteHeaderValue routeHeader)

Method Detail

getRouteHeader

DocumentRouteHeaderValue getRouteHeader(Long routeHeaderId)

getRouteHeader

DocumentRouteHeaderValue getRouteHeader(Long routeHeaderId,
                                        boolean clearCache)

lockRouteHeader

void lockRouteHeader(Long routeHeaderId,
                     boolean wait)

saveRouteHeader

void saveRouteHeader(DocumentRouteHeaderValue routeHeader)

deleteRouteHeader

void deleteRouteHeader(DocumentRouteHeaderValue routeHeader)

getNextRouteHeaderId

Long getNextRouteHeaderId()

validateRouteHeader

void validateRouteHeader(DocumentRouteHeaderValue routeHeader)

findPendingByResponsibilityIds

Collection findPendingByResponsibilityIds(Set responsibilityIds)

findByDocTypeAndAppId

Collection findByDocTypeAndAppId(String documentTypeName,
                                 String appId)

clearRouteHeaderSearchValues

void clearRouteHeaderSearchValues(Long routeHeaderId)

Removes all SearchableAttributeValues associated with the RouteHeader.

Parameters:

routeHeader -

updateRouteHeaderSearchValues

void updateRouteHeaderSearchValues(Long routeHeaderId,
                                   List<SearchableAttributeValue> searchAttributes)

Updates the searchable attribute values for the document with the given id to the given values. This method will clear existing search attribute values and replace with the ones given.

getServiceNamespaceByDocumentId

String getServiceNamespaceByDocumentId(Long documentId)

Returns the Service Namespace of the DocumentType for the Document with the given ID.

getContent

DocumentRouteHeaderValueContent getContent(Long routeHeaderId)

hasSearchableAttributeValue

boolean hasSearchableAttributeValue(Long documentId,
                                    String searchableAttributeKey,
                                    String searchableAttributeValue)

getDocumentStatus

String getDocumentStatus(Long documentId)

getAppDocId

String getAppDocId(Long documentId)

getSearchableAttributeStringValuesByKey

List<String> getSearchableAttributeStringValuesByKey(Long documentId,
                                                     String key)

This method is a more direct way to get the searchable attribute values

Parameters:

documentId -

key -

Returns:

getSearchableAttributeDateTimeValuesByKey

List<Timestamp> getSearchableAttributeDateTimeValuesByKey(Long documentId,
                                                          String key)

This method is a more direct way to get the searchable attribute values

Parameters:

documentId -

key -

Returns:

getSearchableAttributeFloatValuesByKey

List<BigDecimal> getSearchableAttributeFloatValuesByKey(Long documentId,
                                                        String key)

This method is a more direct way to get the searchable attribute values

Parameters:

documentId -

key -

Returns:

getSearchableAttributeLongValuesByKey

List<Long> getSearchableAttributeLongValuesByKey(Long documentId,
                                                 String key)

This method is a more direct way to get the searchable attribute values

Parameters:

documentId -

key -

Returns: