org.kuali.rice.krad.bo

Interface GlobalBusinessObject

public interface GlobalBusinessObject

This is a marker interface used to determine whether we are dealing with a GlobalBusinessObject or something else If implementations of this class implement PersistableBusinessObject as well, then it is strongly recommended that classes override PersistableBusinessObject.buildListOfDeletionAwareLists() as well. If this is not done correctly, then deleted collection elements will not be persisted, and upon reload from the DB, the deleted items will appear in the collection.

Method Summary

Modifier and Type	Method and Description
List<PersistableBusinessObject>	generateDeactivationsToPersist() This method generates a list of BusinessObjects that need to be deleted as part of the final processing for a global maintenance document.
List<PersistableBusinessObject>	generateGlobalChangesToPersist() This method applies the global changed fields to the list of BOs contained within, and returns the list, with all the relevant values updated.
List<? extends GlobalBusinessObjectDetail>	getAllDetailObjects() Returns a list of all global detail objects on this document.
String	getDocumentNumber() Gets the documentNumber attribute.
boolean	isPersistable() This method examines the underlying document and determines whether it can be persisted as part of the enclosing MaintenanceDocument.
void	setDocumentNumber(String documentNumber) Sets the documentNumber attribute.

Method Detail

getDocumentNumber

String getDocumentNumber()

Gets the documentNumber attribute.

Returns:

Returns the documentNumber

setDocumentNumber

void setDocumentNumber(String documentNumber)

Sets the documentNumber attribute.

Parameters:

documentNumber - The documentNumber to set.

generateGlobalChangesToPersist

List<PersistableBusinessObject> generateGlobalChangesToPersist()

This method applies the global changed fields to the list of BOs contained within, and returns the list, with all the relevant values updated.

Returns:

Returns a List of BusinessObjects that are ready for persisting, with any relevant values changed

generateDeactivationsToPersist

List<PersistableBusinessObject> generateDeactivationsToPersist()

This method generates a list of BusinessObjects that need to be deleted as part of the final processing for a global maintenance document. These records should be deleted before the records from getGlobalChangesToPersist() are persisted.

Returns:

A List of BusinessObjects that should be deleted as part of this global maint doc's final processing.

isPersistable

boolean isPersistable()

This method examines the underlying document and determines whether it can be persisted as part of the enclosing MaintenanceDocument. If it returns false, then the Maintenance Document it is part of should not be saved, as a SQL Exception is likely to result.

Returns:

True if the document can be safely persisted, False if not.

getAllDetailObjects

List<? extends GlobalBusinessObjectDetail> getAllDetailObjects()

Returns a list of all global detail objects on this document. This method needs to return all detail objects, even if they are of different types.

Returns: