org.kuali.kfs.coa.businessobject
Class AccountingPeriod

java.lang.Object
  extended by org.kuali.rice.kns.bo.BusinessObjectBase
      extended by org.kuali.rice.kns.bo.PersistableBusinessObjectBase
          extended by org.kuali.kfs.coa.businessobject.AccountingPeriod
All Implemented Interfaces:
Serializable, org.apache.ojb.broker.PersistenceBrokerAware, org.kuali.rice.kns.bo.BusinessObject, org.kuali.rice.kns.bo.Inactivateable, org.kuali.rice.kns.bo.PersistableBusinessObject

public class AccountingPeriod
extends org.kuali.rice.kns.bo.PersistableBusinessObjectBase
implements org.kuali.rice.kns.bo.Inactivateable

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase
extension, versionNumber
 
Constructor Summary
AccountingPeriod()
          Default constructor.
 
Method Summary
 boolean equals(Object obj)
          determines if two accounting periods are equal, based on the primary keys of the AccountingPeriod BusinesObject: university fiscal year and university fiscal period code
 int getMonth()
          This method returns the month that this period represents
 SystemOptions getOptions()
           
 String getUniversityFiscalPeriodCode()
          Gets the universityFiscalPeriodCode attribute.
 Date getUniversityFiscalPeriodEndDate()
          Gets the universityFiscalPeriodEndDate attribute.
 String getUniversityFiscalPeriodName()
          Gets the universityFiscalPeriodName attribute.
 Integer getUniversityFiscalYear()
          Gets the universityFiscalYear attribute.
 int hashCode()
          generates a hash code for this accounting period, based on the primary keys of the AccountingPeriod BusinesObject: university fiscal year and university fiscal period code
 boolean isActive()
          Gets the active attribute.
 boolean isBudgetRolloverIndicator()
          Gets the budgetRolloverIndicator attribute.
 boolean isOpen()
          Determine if the current account period is open
 void setActive(boolean active)
          Sets the active attribute.
 void setBudgetRolloverIndicator(boolean budgetRolloverIndicator)
          Sets the budgetRolloverIndicator attribute.
 void setOptions(SystemOptions options)
          Deprecated.  
 void setUniversityFiscalPeriodCode(String universityFiscalPeriodCode)
          Sets the universityFiscalPeriodCode attribute.
 void setUniversityFiscalPeriodEndDate(Date universityFiscalPeriodEndDate)
          Sets the universityFiscalPeriodEndDate attribute.
 void setUniversityFiscalPeriodName(String universityFiscalPeriodName)
          Sets the universityFiscalPeriodName attribute.
 void setUniversityFiscalYear(Integer universityFiscalYear)
          Sets the universityFiscalYear attribute.
protected  LinkedHashMap toStringMapper()
           
 
Methods inherited from class org.kuali.rice.kns.bo.PersistableBusinessObjectBase
addNote, afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeInsert, beforeUpdate, beforeUpdate, buildListOfDeletionAwareLists, deleteNote, getAttachmentService, getBoNote, getBoNotes, getExtension, getNoteService, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isAutoIncrementSet, isBoNotesSupport, isNewCollectionRecord, linkEditableUserFields, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setAutoIncrementSet, setBoNotes, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber, supportsBoNotes
 
Methods inherited from class org.kuali.rice.kns.bo.BusinessObjectBase
prepareForWorkflow, toString, toStringBuilder
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.kuali.rice.kns.bo.BusinessObject
prepareForWorkflow
 

Constructor Detail

AccountingPeriod

public AccountingPeriod()
Default constructor.

Method Detail

getUniversityFiscalYear

public Integer getUniversityFiscalYear()
Gets the universityFiscalYear attribute.

Returns:
Returns the universityFiscalYear

setUniversityFiscalYear

public void setUniversityFiscalYear(Integer universityFiscalYear)
Sets the universityFiscalYear attribute.

Parameters:
universityFiscalYear - The universityFiscalYear to set.

getUniversityFiscalPeriodCode

public String getUniversityFiscalPeriodCode()
Gets the universityFiscalPeriodCode attribute.

Returns:
Returns the universityFiscalPeriodCode

setUniversityFiscalPeriodCode

public void setUniversityFiscalPeriodCode(String universityFiscalPeriodCode)
Sets the universityFiscalPeriodCode attribute.

Parameters:
universityFiscalPeriodCode - The universityFiscalPeriodCode to set.

getUniversityFiscalPeriodName

public String getUniversityFiscalPeriodName()
Gets the universityFiscalPeriodName attribute.

Returns:
Returns the universityFiscalPeriodName

setUniversityFiscalPeriodName

public void setUniversityFiscalPeriodName(String universityFiscalPeriodName)
Sets the universityFiscalPeriodName attribute.

Parameters:
universityFiscalPeriodName - The universityFiscalPeriodName to set.

isActive

public boolean isActive()
Gets the active attribute.

Specified by:
isActive in interface org.kuali.rice.kns.bo.Inactivateable
Returns:
Returns the active

setActive

public void setActive(boolean active)
Sets the active attribute.

Specified by:
setActive in interface org.kuali.rice.kns.bo.Inactivateable
Parameters:
active - The active to set.

isBudgetRolloverIndicator

public boolean isBudgetRolloverIndicator()
Gets the budgetRolloverIndicator attribute.

Returns:
Returns the budgetRolloverIndicator

setBudgetRolloverIndicator

public void setBudgetRolloverIndicator(boolean budgetRolloverIndicator)
Sets the budgetRolloverIndicator attribute.

Parameters:
budgetRolloverIndicator - The budgetRolloverIndicator to set.

getUniversityFiscalPeriodEndDate

public Date getUniversityFiscalPeriodEndDate()
Gets the universityFiscalPeriodEndDate attribute.

Returns:
Returns the universityFiscalPeriodEndDate

setUniversityFiscalPeriodEndDate

public void setUniversityFiscalPeriodEndDate(Date universityFiscalPeriodEndDate)
Sets the universityFiscalPeriodEndDate attribute.

Parameters:
universityFiscalPeriodEndDate - The universityFiscalPeriodEndDate to set.

isOpen

public boolean isOpen()
Determine if the current account period is open

Returns:
true if the accounting period is open; otherwise, false

getOptions

public SystemOptions getOptions()
Returns:
Returns the options.

setOptions

public void setOptions(SystemOptions options)
Deprecated. 

Parameters:
options - The options to set.

getMonth

public int getMonth()
This method returns the month that this period represents

Returns:
the actual month (1 - 12) that this period represents

toStringMapper

protected LinkedHashMap toStringMapper()
Specified by:
toStringMapper in class org.kuali.rice.kns.bo.BusinessObjectBase
See Also:
BusinessObjectBase.toStringMapper()

hashCode

public int hashCode()
generates a hash code for this accounting period, based on the primary keys of the AccountingPeriod BusinesObject: university fiscal year and university fiscal period code

Overrides:
hashCode in class Object
See Also:
Object.hashCode()

equals

public boolean equals(Object obj)
determines if two accounting periods are equal, based on the primary keys of the AccountingPeriod BusinesObject: university fiscal year and university fiscal period code

Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)


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