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(String documentId) Removes all SearchableAttributeValues associated with the RouteHeader.
void	deleteRouteHeader(DocumentRouteHeaderValue routeHeader)
Collection	findByDocTypeAndAppId(String documentTypeName, String appId)
Collection	findPendingByResponsibilityIds(Set responsibilityIds)
String	getAppDocId(String documentId)
String	getAppDocStatus(String documentId) This method Returns the application document status for the given document id
String	getApplicationIdByDocumentId(String documentId) Returns the application id of the DocumentType for the Document with the given ID.
DocumentRouteHeaderValueContent	getContent(String documentId)
String	getDocumentStatus(String documentId)
String	getNextDocumentId()
DocumentRouteHeaderValue	getRouteHeader(String documentId)
DocumentRouteHeaderValue	getRouteHeader(String documentId, boolean clearCache)
Collection<DocumentRouteHeaderValue>	getRouteHeaders(Collection<String> documentIds)
Collection<DocumentRouteHeaderValue>	getRouteHeaders(Collection<String> documentIds, boolean clearCache)
Map<String,DocumentRouteHeaderValue>	getRouteHeadersForActionItems(Collection<ActionItem> actionItems)
List<Timestamp>	getSearchableAttributeDateTimeValuesByKey(String documentId, String key) This method is a more direct way to get the searchable attribute values
List<BigDecimal>	getSearchableAttributeFloatValuesByKey(String documentId, String key) This method is a more direct way to get the searchable attribute values
List<Long>	getSearchableAttributeLongValuesByKey(String documentId, String key) This method is a more direct way to get the searchable attribute values
List<String>	getSearchableAttributeStringValuesByKey(String documentId, String key) This method is a more direct way to get the searchable attribute values
boolean	hasSearchableAttributeValue(String documentId, String searchableAttributeKey, String searchableAttributeValue)
void	lockRouteHeader(String documentId, boolean wait)
void	saveRouteHeader(DocumentRouteHeaderValue routeHeader)
void	updateRouteHeaderSearchValues(String documentId, 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(String documentId)

getRouteHeader

DocumentRouteHeaderValue getRouteHeader(String documentId,
                                        boolean clearCache)

getRouteHeaders

Collection<DocumentRouteHeaderValue> getRouteHeaders(Collection<String> documentIds)

getRouteHeaders

Collection<DocumentRouteHeaderValue> getRouteHeaders(Collection<String> documentIds,
                                                     boolean clearCache)

getRouteHeadersForActionItems

Map<String,DocumentRouteHeaderValue> getRouteHeadersForActionItems(Collection<ActionItem> actionItems)

lockRouteHeader

void lockRouteHeader(String documentId,
                     boolean wait)

saveRouteHeader

void saveRouteHeader(DocumentRouteHeaderValue routeHeader)

deleteRouteHeader

void deleteRouteHeader(DocumentRouteHeaderValue routeHeader)

getNextDocumentId

String getNextDocumentId()

validateRouteHeader

void validateRouteHeader(DocumentRouteHeaderValue routeHeader)

findPendingByResponsibilityIds

Collection findPendingByResponsibilityIds(Set responsibilityIds)

findByDocTypeAndAppId

Collection findByDocTypeAndAppId(String documentTypeName,
                                 String appId)

clearRouteHeaderSearchValues

void clearRouteHeaderSearchValues(String documentId)

Removes all SearchableAttributeValues associated with the RouteHeader.

Parameters:

routeHeader -

updateRouteHeaderSearchValues

void updateRouteHeaderSearchValues(String documentId,
                                   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.

getApplicationIdByDocumentId

String getApplicationIdByDocumentId(String documentId)

Returns the application id of the DocumentType for the Document with the given ID.

getContent

DocumentRouteHeaderValueContent getContent(String documentId)

hasSearchableAttributeValue

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

getDocumentStatus

String getDocumentStatus(String documentId)

getAppDocId

String getAppDocId(String documentId)

getAppDocStatus

String getAppDocStatus(String documentId)

This method Returns the application document status for the given document id

Parameters:

documentId -

Returns:

String

getSearchableAttributeStringValuesByKey

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

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

Parameters:

documentId -

key -

Returns:

getSearchableAttributeDateTimeValuesByKey

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

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

Parameters:

documentId -

key -

Returns:

getSearchableAttributeFloatValuesByKey

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

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

Parameters:

documentId -

key -

Returns:

getSearchableAttributeLongValuesByKey

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

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

Parameters:

documentId -

key -

Returns: