edu.sampleu.travel.approval
Class TravelAuthorizationDocument

java.lang.Object
  extended by org.kuali.rice.krad.bo.BusinessObjectBase
      extended by org.kuali.rice.krad.bo.PersistableBusinessObjectBase
          extended by org.kuali.rice.krad.document.DocumentBase
              extended by org.kuali.rice.krad.document.TransactionalDocumentBase
                  extended by edu.sampleu.travel.approval.TravelAuthorizationDocument
All Implemented Interfaces:
Serializable, org.apache.ojb.broker.PersistenceBrokerAware, GloballyUnique, Versioned, ModelObjectBasic, BusinessObject, PersistableBusinessObject, Document, SessionDocument, TransactionalDocument

@Entity
public class TravelAuthorizationDocument
extends TransactionalDocumentBase

Travel authorization transactional document.

This is a sample KRAD transactional document that demonstrates how to implement transactional documents within the KRAD UIF.

Author:
Kuali Rice Team (rice.collab@kuali.org)
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.kuali.rice.krad.document.DocumentBase
documentHeader, documentNumber
 
Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase
extension, versionNumber
 
Constructor Summary
TravelAuthorizationDocument()
           
 
Method Summary
 String getCellPhoneNumber()
          Returns the cell phone number.
 String getCitizenshipCountryCode()
          Returns the citizenship country code.
 KualiDecimal getExpenseLimit()
          Returns the expense limit.
 PrimaryDestination getPrimaryDestination()
          Returns primary destination.
 Integer getPrimaryDestinationId()
          Returns the destination id.
 String getQuestionForTa()
          Returns the questions for TA.
 String getQuestionForTaDoc()
          Returns the questions for TA document.
 Boolean getQuestionForTaDocWhy()
          Returns the questions for TA document why.
 Boolean getQuestionForTaWhy()
          Returns the questions for TA why.
 String getRegionFamiliarity()
          Returns the region familiarity.
 String getTransportationModeCode()
          Returns the transportation mode code.
 List<TravelAdvance> getTravelAdvanceList()
          Returns travel advance collection.
 String getTravelDocumentIdentifier()
          Returns the travel document identifier.
 TravelerDetail getTravelerDetail()
          Returns the nested traveler detail.
 Integer getTravelerDetailId()
          Returns the traveler detail id.
 Date getTripBegin()
          Returns the trip begin date.
 String getTripDescription()
          Returns the trip description.
 Date getTripEnd()
          Returns the trip end date.
 String getTripTypeCode()
          Returns the trip type.
 void setCitizenshipCountryCode(String citizenshipCountryCode)
          Initializes the citizenship country code.
 void setExpenseLimit(KualiDecimal expenseLimit)
          Initializes the expense limit.
 void setPrimaryDestination(PrimaryDestination primaryDestination)
          Initializes the primary destination.
 void setPrimaryDestinationId(Integer primaryDestinationId)
          Initializes the primary destination id.
 void setQuestionForTa(String questionForTa)
          Initializes the questions for TA.
 void setQuestionForTaDoc(String questionForTaDoc)
          Initializes the questions for TA document.
 void setQuestionForTaDocWhy(Boolean questionForTaDocWhy)
          Initializes the questions for TA document why.
 void setQuestionForTaWhy(Boolean questionForTaWhy)
          Initializes the questions for TA why.
 void setRegionFamiliarity(String regionFamiliarity)
          Initializes the region familiarity.
 void setTransportationModeCode(String transportationModeCode)
          Initializes the transportation mode code.
 void setTravelAdvanceList(List<TravelAdvance> travelAdvanceList)
          Initializes travel advance collection.
 void setTravelDocumentIdentifier(String travelDocumentIdentifier)
          Initializes the document identifier.
 void setTravelerDetail(TravelerDetail travelerDetail)
          Initializes the nested traveler detail object.
 void setTravelerDetailId(Integer travelerDetailId)
          Initializes the traveler detail id.
 void setTravelerDetailId(String cellPhoneNumber)
          Initializes the cell phone number.
 void setTripBegin(Date tripBegin)
          Initializes the trip starting date.
 void setTripDescription(String tripDescription)
          Initializes the trip description.
 void setTripEnd(Date tripEnd)
          Initializes the trip ending date.
 void setTripTypeCode(String tripTypeCode)
          Initializes the trip type.
 
Methods inherited from class org.kuali.rice.krad.document.TransactionalDocumentBase
getAllowsCopy, isSessionDocument
 
Methods inherited from class org.kuali.rice.krad.document.DocumentBase
addCopyErrorDocumentNote, addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, createPropertySerializabilityEvaluator, doActionTaken, doRouteLevelChange, doRouteStatusChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getAttachmentService, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNonLockingActionTakenCodes, getNote, getNotes, getNoteService, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, logErrors, populateDocumentForRouting, postLoad, postProcessSave, prepareForSave, prepareForSave, processAfterRetrieve, refresh, refreshIfEmpty, refreshPessimisticLocks, refreshReferenceObject, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNewDocumentHeader, setNotes, setPessimisticLocks, toCopy, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization
 
Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase
afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postPersist, postRemove, postUpdate, prePersist, preRemove, preUpdate, refreshNonUpdateableReferences, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber
 
Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase
toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.kuali.rice.krad.document.Document
addNote, addPessimisticLock, afterActionTaken, afterWorkflowEngineProcess, beforeWorkflowEngineProcess, doActionTaken, doRouteLevelChange, doRouteStatusChange, generateSaveEvents, getAdHocRoutePersons, getAdHocRouteWorkgroups, getBasePathToDocumentDuringSerialization, getCustomLockDescriptor, getDocumentHeader, getDocumentNumber, getDocumentPropertySerizabilityEvaluator, getDocumentTitle, getLockClearningMethodNames, getNote, getNotes, getNoteTarget, getNoteType, getPessimisticLocks, getWorkflowEngineDocumentIdsToLock, getXmlForRouteReport, populateDocumentForRouting, postProcessSave, prepareForSave, prepareForSave, processAfterRetrieve, refreshPessimisticLocks, removeNote, serializeDocumentToXml, setAdHocRoutePersons, setAdHocRouteWorkgroups, setDocumentHeader, setDocumentNumber, setNotes, useCustomLockDescriptors, validateBusinessRules, wrapDocumentWithMetadataForXmlSerialization
 
Methods inherited from interface org.kuali.rice.krad.bo.PersistableBusinessObject
buildListOfDeletionAwareLists, getExtension, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber
 
Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject
refresh
 
Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic
toString
 
Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned
getVersionNumber
 
Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique
getObjectId
 

Constructor Detail

TravelAuthorizationDocument

public TravelAuthorizationDocument()
Method Detail

getTravelDocumentIdentifier

public String getTravelDocumentIdentifier()
Returns the travel document identifier.

Gets the travel document identifier.

Returns:
String - document service

setTravelDocumentIdentifier

public void setTravelDocumentIdentifier(String travelDocumentIdentifier)
Initializes the document identifier.

Sets the document identifier.

Parameters:
travelDocumentIdentifier - - document identifier

getTripBegin

public Date getTripBegin()
Returns the trip begin date.

Gets the trip begin date.

Returns:
Date - trip begin date

setTripBegin

public void setTripBegin(Date tripBegin)
Initializes the trip starting date.

Sets the trip begin date.

Parameters:
tripBegin - - trip starting date

getTripEnd

public Date getTripEnd()
Returns the trip end date.

Gets the trip end date.

Returns:
Date - trip end date

setTripEnd

public void setTripEnd(Date tripEnd)
Initializes the trip ending date.

Sets the trip end date.

Parameters:
tripEnd - - trip ending date

getTripDescription

public String getTripDescription()
Returns the trip description.

Gets the trip description.

Returns:
Strin - trip description

setTripDescription

public void setTripDescription(String tripDescription)
Initializes the trip description.

Sets the trip description.

Parameters:
tripDescription- - trip description

setTripTypeCode

public void setTripTypeCode(String tripTypeCode)
Initializes the trip type.

Sets the trip type.

Parameters:
tripTypeCode - - trip type

getTripTypeCode

public String getTripTypeCode()
Returns the trip type.

Gets the trip type.

Returns:
String - trip type

getPrimaryDestinationId

public Integer getPrimaryDestinationId()
Returns the destination id.

Gets the primary key for the destination.

Returns:
Integer - destination id

setPrimaryDestinationId

public void setPrimaryDestinationId(Integer primaryDestinationId)
Initializes the primary destination id.

Sets the primary destination id.

Parameters:
primaryDestinationId - - integer of primary destination id

getTravelerDetailId

public Integer getTravelerDetailId()
Returns the traveler detail id.

Gets the primary key for the traveler.

Returns:
Integer - traveler detail id

setTravelerDetailId

public void setTravelerDetailId(Integer travelerDetailId)
Initializes the traveler detail id.

Sets the traveler detail id.

Parameters:
travelerDetailId - - integer of primary destination id

getTravelerDetail

public TravelerDetail getTravelerDetail()
Returns the nested traveler detail.

Gets the traveler detail object.

Returns:
TravelerDetail - traveler detail

setTravelerDetail

public void setTravelerDetail(TravelerDetail travelerDetail)
Initializes the nested traveler detail object.

Sets the traveler detail.

Parameters:
travelerDetail - - traveler detail object

getPrimaryDestination

public PrimaryDestination getPrimaryDestination()
Returns primary destination.

Gets the primary destination

Returns:
PrimaryDestination - primary destination

setPrimaryDestination

public void setPrimaryDestination(PrimaryDestination primaryDestination)
Initializes the primary destination.

Sets the primary destination.

Parameters:
primaryDestination - - primary destination

getTravelAdvanceList

public List<TravelAdvance> getTravelAdvanceList()
Returns travel advance collection.

Gets the travel advance collection.

Returns:
List - travel advance collection

setTravelAdvanceList

public void setTravelAdvanceList(List<TravelAdvance> travelAdvanceList)
Initializes travel advance collection.

Sets the travel advance collection.

Parameters:
travelAdvanceList - - travel advance collection

getCellPhoneNumber

public String getCellPhoneNumber()
Returns the cell phone number.

Gets the emergency contact cell phone number.

Returns:
String - cell phone number

setTravelerDetailId

public void setTravelerDetailId(String cellPhoneNumber)
Initializes the cell phone number.

Sets the emergency contact cell phone number.

Parameters:
cellPhoneNumber - - string of the cell phone number

getRegionFamiliarity

public String getRegionFamiliarity()
Returns the region familiarity.

Gets the emergency contact region familiarity.

Returns:
String - region familiarity

setRegionFamiliarity

public void setRegionFamiliarity(String regionFamiliarity)
Initializes the region familiarity.

Sets the emergency contact region familiarity.

Parameters:
regionFamiliarity - - string of the region familiarity

getCitizenshipCountryCode

public String getCitizenshipCountryCode()
Returns the citizenship country code.

Gets the emergency contact citizenship country code.

Returns:
String - citizenship country code

setCitizenshipCountryCode

public void setCitizenshipCountryCode(String citizenshipCountryCode)
Initializes the citizenship country code.

Sets the emergency contact citizenship country code.

Parameters:
citizenshipCountryCode - - string of the citizenship country code

getTransportationModeCode

public String getTransportationModeCode()
Returns the transportation mode code.

Gets the emergency contact transportation mode cpde.

Returns:
String - transportation mode code

setTransportationModeCode

public void setTransportationModeCode(String transportationModeCode)
Initializes the transportation mode code.

Sets the emergency contact transportation mode code.

Parameters:
transportationModeCode - - string of the transportation mode code

getExpenseLimit

public KualiDecimal getExpenseLimit()
Returns the expense limit.

Gets the special circumstance expense limit.

Returns:
KualiDecimal - expense limit

setExpenseLimit

public void setExpenseLimit(KualiDecimal expenseLimit)
Initializes the expense limit.

Sets the special circumstance expense limit.

Parameters:
expenseLimit - - kuali decimal of the expense limit

getQuestionForTaWhy

public Boolean getQuestionForTaWhy()
Returns the questions for TA why.

Gets the special circumstance questions for TA why.

Returns:
Boolean - questionForTaWhy

setQuestionForTaWhy

public void setQuestionForTaWhy(Boolean questionForTaWhy)
Initializes the questions for TA why.

Sets the special circumstance questions for TA why.

Parameters:
questionForTaWhy - - boolean of the questions for TA why

getQuestionForTa

public String getQuestionForTa()
Returns the questions for TA.

Gets the special circumstance questions for TA.

Returns:
String - questions for TA

setQuestionForTa

public void setQuestionForTa(String questionForTa)
Initializes the questions for TA.

Sets the special circumstance questions for TA.

Parameters:
questionForTa - - string of the questions for TA

getQuestionForTaDocWhy

public Boolean getQuestionForTaDocWhy()
Returns the questions for TA document why.

Gets the special circumstance questions for TA document why.

Returns:
Boolean - questionForTaDocWhy

setQuestionForTaDocWhy

public void setQuestionForTaDocWhy(Boolean questionForTaDocWhy)
Initializes the questions for TA document why.

Sets the special circumstance questions for TA document why.

Parameters:
questionForTaDocWhy - - boolean of the questions for TA document why

getQuestionForTaDoc

public String getQuestionForTaDoc()
Returns the questions for TA document.

Gets the special circumstance questions for TA document.

Returns:
String - questions for TA document

setQuestionForTaDoc

public void setQuestionForTaDoc(String questionForTaDoc)
Initializes the questions for TA document.

Sets the special circumstance questions for TA document.

Parameters:
questionForTaDoc - - string of the questions for TA document


Copyright © 2005-2014 The Kuali Foundation. All Rights Reserved.