org.kuali.rice.kew.api.preferences

Class Preferences.Builder

java.lang.Object

org.kuali.rice.kew.api.preferences.Preferences.Builder

All Implemented Interfaces:

Serializable, ModelBuilder, PreferencesContract

Enclosing class:

Preferences

public static final class Preferences.Builder
extends Object
implements Serializable, ModelBuilder, PreferencesContract

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	addDocumentTypeNotificationPreference(String documentType, String preference)
Preferences	build() Returns an instance of the object being built by this builder based on the current state of the builder.
static Preferences.Builder	create()
static Preferences.Builder	create(Map<String,String> map, Map<String,String> documentTypeNotificationPreferences, boolean requiresSave)
static Preferences.Builder	create(PreferencesContract contract)
static Preferences.Builder	create(String emailNotification, String notifyPrimaryDelegation, String notifySecondaryDelegation, String openNewWindow, String showActionRequested, String showDateCreated, String showDocumentStatus, String showAppDocStatus, String showDocType, String showInitiator, String showDocTitle, String showWorkgroupRequest, String showDelegator, String showClearFyi, String pageSize, String refreshRate, String colorSaved, String colorInitiated, String colorDisapproved, String colorEnroute, String colorApproved, String colorFinal, String colorDissapproveCancel, String colorProcessed, String colorException, String colorCanceled, String delegatorFilter, String useOutbox, String showDateApproved, String showCurrentNode, String primaryDelegateFilter, String notifyAcknowledge, String notifyApprove, String notifyComplete, String notifyFYI, Map<String,String> documentTypeNotificationPreferences, boolean requiresSave)
String	getColorApproved()
String	getColorCanceled()
String	getColorDisapproveCancel()
String	getColorDisapproved()
String	getColorEnroute()
String	getColorException()
String	getColorFinal()
String	getColorInitiated()
String	getColorProcessed()
String	getColorSaved()
String	getDelegatorFilter()
String	getDocumentTypeNotificationPreference(String documentType)
Map<String,String>	getDocumentTypeNotificationPreferences()
String	getEmailNotification()
String	getNotifyAcknowledge()
String	getNotifyApprove()
String	getNotifyComplete()
String	getNotifyFYI()
String	getNotifyPrimaryDelegation()
String	getNotifySecondaryDelegation()
String	getOpenNewWindow()
String	getPageSize()
String	getPrimaryDelegateFilter()
String	getRefreshRate()
String	getShowActionRequested()
String	getShowAppDocStatus()
String	getShowClearFyi()
String	getShowCurrentNode()
String	getShowDateApproved()
String	getShowDateCreated()
String	getShowDelegator()
String	getShowDocTitle()
String	getShowDocType()
String	getShowDocumentStatus()
String	getShowInitiator()
String	getShowWorkgroupRequest()
String	getUseOutbox()
boolean	isRequiresSave()
void	removeDocumentTypeNotificationPreference(String documentType)
void	setColorApproved(String colorApproved)
void	setColorCanceled(String colorCanceled)
void	setColorDisapproved(String colorDisapproved)
void	setColorDissapproveCancel(String colorDissapproveCancel)
void	setColorEnroute(String colorEnroute)
void	setColorException(String colorException)
void	setColorFinal(String colorFinal)
void	setColorInitiated(String colorInitiated)
void	setColorProcessed(String colorProcessed)
void	setColorSaved(String colorSaved)
void	setDelegatorFilter(String delegatorFilter)
void	setDocumentTypeNotificationPreference(String documentType, String preference)
void	setDocumentTypeNotificationPreferences(Map<String,String> documentTypeNotificationPreferences)
void	setEmailNotification(String emailNotification)
void	setNotifyAcknowledge(String notifyAcknowledge)
void	setNotifyApprove(String notifyApprove)
void	setNotifyComplete(String notifyComplete)
void	setNotifyFYI(String notifyFYI)
void	setNotifyPrimaryDelegation(String notifyPrimaryDelegation)
void	setNotifySecondaryDelegation(String notifySecondaryDelegation)
void	setOpenNewWindow(String openNewWindow)
void	setPageSize(String pageSize)
void	setPrimaryDelegateFilter(String primaryDelegateFilter)
void	setRefreshRate(String refreshRate)
void	setRequiresSave(boolean requiresSave)
void	setShowActionRequested(String showActionRequested)
void	setShowAppDocStatus(String showAppDocStatus)
void	setShowClearFyi(String showClearFyi)
void	setShowCurrentNode(String showCurrentNode)
void	setShowDateApproved(String showDateApproved)
void	setShowDateCreated(String showDateCreated)
void	setShowDelegator(String showDelegator)
void	setShowDocTitle(String showDocTitle)
void	setShowDocType(String showDocType)
void	setShowDocumentStatus(String showDocumentStatus)
void	setShowInitiator(String showInitiator)
void	setShowWorkgroupRequest(String showWorkgroupRequest)
void	setUseOutbox(String useOutbox)

Methods inherited from class java.lang.Object

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

Method Detail

build

public Preferences build()

Description copied from interface: ModelBuilder

Returns an instance of the object being built by this builder based on the current state of the builder. It should be possible to invoke this method more than once on the same builder. It should never return null;

Specified by:

build in interface ModelBuilder

Returns:

an instance of the object being built by this builder, should never return null

create

public static Preferences.Builder create()

create

public static Preferences.Builder create(String emailNotification,
                                         String notifyPrimaryDelegation,
                                         String notifySecondaryDelegation,
                                         String openNewWindow,
                                         String showActionRequested,
                                         String showDateCreated,
                                         String showDocumentStatus,
                                         String showAppDocStatus,
                                         String showDocType,
                                         String showInitiator,
                                         String showDocTitle,
                                         String showWorkgroupRequest,
                                         String showDelegator,
                                         String showClearFyi,
                                         String pageSize,
                                         String refreshRate,
                                         String colorSaved,
                                         String colorInitiated,
                                         String colorDisapproved,
                                         String colorEnroute,
                                         String colorApproved,
                                         String colorFinal,
                                         String colorDissapproveCancel,
                                         String colorProcessed,
                                         String colorException,
                                         String colorCanceled,
                                         String delegatorFilter,
                                         String useOutbox,
                                         String showDateApproved,
                                         String showCurrentNode,
                                         String primaryDelegateFilter,
                                         String notifyAcknowledge,
                                         String notifyApprove,
                                         String notifyComplete,
                                         String notifyFYI,
                                         Map<String,String> documentTypeNotificationPreferences,
                                         boolean requiresSave)

create

public static Preferences.Builder create(PreferencesContract contract)

create

public static Preferences.Builder create(Map<String,String> map,
                                         Map<String,String> documentTypeNotificationPreferences,
                                         boolean requiresSave)

isRequiresSave

public boolean isRequiresSave()

Specified by:

isRequiresSave in interface PreferencesContract

setRequiresSave

public void setRequiresSave(boolean requiresSave)

getEmailNotification

public String getEmailNotification()

Specified by:

getEmailNotification in interface PreferencesContract

setEmailNotification

public void setEmailNotification(String emailNotification)

getNotifyPrimaryDelegation

public String getNotifyPrimaryDelegation()

Specified by:

getNotifyPrimaryDelegation in interface PreferencesContract

setNotifyPrimaryDelegation

public void setNotifyPrimaryDelegation(String notifyPrimaryDelegation)

getNotifySecondaryDelegation

public String getNotifySecondaryDelegation()

Specified by:

getNotifySecondaryDelegation in interface PreferencesContract

setNotifySecondaryDelegation

public void setNotifySecondaryDelegation(String notifySecondaryDelegation)

getOpenNewWindow

public String getOpenNewWindow()

Specified by:

getOpenNewWindow in interface PreferencesContract

setOpenNewWindow

public void setOpenNewWindow(String openNewWindow)

getShowActionRequested

public String getShowActionRequested()

Specified by:

getShowActionRequested in interface PreferencesContract

setShowActionRequested

public void setShowActionRequested(String showActionRequested)

getShowDateCreated

public String getShowDateCreated()

Specified by:

getShowDateCreated in interface PreferencesContract

setShowDateCreated

public void setShowDateCreated(String showDateCreated)

getShowDocumentStatus

public String getShowDocumentStatus()

Specified by:

getShowDocumentStatus in interface PreferencesContract

setShowDocumentStatus

public void setShowDocumentStatus(String showDocumentStatus)

getShowAppDocStatus

public String getShowAppDocStatus()

Specified by:

getShowAppDocStatus in interface PreferencesContract

setShowAppDocStatus

public void setShowAppDocStatus(String showAppDocStatus)

getShowDocType

public String getShowDocType()

Specified by:

getShowDocType in interface PreferencesContract

setShowDocType

public void setShowDocType(String showDocType)

getShowInitiator

public String getShowInitiator()

Specified by:

getShowInitiator in interface PreferencesContract

setShowInitiator

public void setShowInitiator(String showInitiator)

getShowDocTitle

public String getShowDocTitle()

Specified by:

getShowDocTitle in interface PreferencesContract

setShowDocTitle

public void setShowDocTitle(String showDocTitle)

getShowWorkgroupRequest

public String getShowWorkgroupRequest()

Specified by:

getShowWorkgroupRequest in interface PreferencesContract

setShowWorkgroupRequest

public void setShowWorkgroupRequest(String showWorkgroupRequest)

getShowDelegator

public String getShowDelegator()

Specified by:

getShowDelegator in interface PreferencesContract

setShowDelegator

public void setShowDelegator(String showDelegator)

getShowClearFyi

public String getShowClearFyi()

Specified by:

getShowClearFyi in interface PreferencesContract

setShowClearFyi

public void setShowClearFyi(String showClearFyi)

getPageSize

public String getPageSize()

Specified by:

getPageSize in interface PreferencesContract

setPageSize

public void setPageSize(String pageSize)

getRefreshRate

public String getRefreshRate()

Specified by:

getRefreshRate in interface PreferencesContract

setRefreshRate

public void setRefreshRate(String refreshRate)

getColorSaved

public String getColorSaved()

Specified by:

getColorSaved in interface PreferencesContract

setColorSaved

public void setColorSaved(String colorSaved)

getColorInitiated

public String getColorInitiated()

Specified by:

getColorInitiated in interface PreferencesContract

setColorInitiated

public void setColorInitiated(String colorInitiated)

getColorDisapproved

public String getColorDisapproved()

Specified by:

getColorDisapproved in interface PreferencesContract

setColorDisapproved

public void setColorDisapproved(String colorDisapproved)

getColorEnroute

public String getColorEnroute()

Specified by:

getColorEnroute in interface PreferencesContract

setColorEnroute

public void setColorEnroute(String colorEnroute)

getColorApproved

public String getColorApproved()

Specified by:

getColorApproved in interface PreferencesContract

setColorApproved

public void setColorApproved(String colorApproved)

getColorFinal

public String getColorFinal()

Specified by:

getColorFinal in interface PreferencesContract

setColorFinal

public void setColorFinal(String colorFinal)

getColorDisapproveCancel

public String getColorDisapproveCancel()

Specified by:

getColorDisapproveCancel in interface PreferencesContract

setColorDissapproveCancel

public void setColorDissapproveCancel(String colorDissapproveCancel)

getColorProcessed

public String getColorProcessed()

Specified by:

getColorProcessed in interface PreferencesContract

setColorProcessed

public void setColorProcessed(String colorProcessed)

getColorException

public String getColorException()

Specified by:

getColorException in interface PreferencesContract

setColorException

public void setColorException(String colorException)

getColorCanceled

public String getColorCanceled()

Specified by:

getColorCanceled in interface PreferencesContract

setColorCanceled

public void setColorCanceled(String colorCanceled)

getDelegatorFilter

public String getDelegatorFilter()

Specified by:

getDelegatorFilter in interface PreferencesContract

setDelegatorFilter

public void setDelegatorFilter(String delegatorFilter)

getUseOutbox

public String getUseOutbox()

Specified by:

getUseOutbox in interface PreferencesContract

setUseOutbox

public void setUseOutbox(String useOutbox)

getShowDateApproved

public String getShowDateApproved()

Specified by:

getShowDateApproved in interface PreferencesContract

setShowDateApproved

public void setShowDateApproved(String showDateApproved)

getShowCurrentNode

public String getShowCurrentNode()

Specified by:

getShowCurrentNode in interface PreferencesContract

setShowCurrentNode

public void setShowCurrentNode(String showCurrentNode)

getPrimaryDelegateFilter

public String getPrimaryDelegateFilter()

Specified by:

getPrimaryDelegateFilter in interface PreferencesContract

setPrimaryDelegateFilter

public void setPrimaryDelegateFilter(String primaryDelegateFilter)

getNotifyAcknowledge

public String getNotifyAcknowledge()

Specified by:

getNotifyAcknowledge in interface PreferencesContract

setNotifyAcknowledge

public void setNotifyAcknowledge(String notifyAcknowledge)

getNotifyApprove

public String getNotifyApprove()

Specified by:

getNotifyApprove in interface PreferencesContract

setNotifyApprove

public void setNotifyApprove(String notifyApprove)

getNotifyComplete

public String getNotifyComplete()

Specified by:

getNotifyComplete in interface PreferencesContract

setNotifyComplete

public void setNotifyComplete(String notifyComplete)

getNotifyFYI

public String getNotifyFYI()

Specified by:

getNotifyFYI in interface PreferencesContract

setNotifyFYI

public void setNotifyFYI(String notifyFYI)

getDocumentTypeNotificationPreference

public String getDocumentTypeNotificationPreference(String documentType)

setDocumentTypeNotificationPreference

public void setDocumentTypeNotificationPreference(String documentType,
                                                  String preference)

getDocumentTypeNotificationPreferences

public Map<String,String> getDocumentTypeNotificationPreferences()

Specified by:

getDocumentTypeNotificationPreferences in interface PreferencesContract

setDocumentTypeNotificationPreferences

public void setDocumentTypeNotificationPreferences(Map<String,String> documentTypeNotificationPreferences)

addDocumentTypeNotificationPreference

public void addDocumentTypeNotificationPreference(String documentType,
                                                  String preference)

removeDocumentTypeNotificationPreference

public void removeDocumentTypeNotificationPreference(String documentType)