com.sage.accpac.sm
Class Company

java.lang.Object
  extended by com.sage.accpac.sm.Company

@Immutable
@ThreadSafe
public final class Company
extends java.lang.Object

Provides details of the company set up in Common Services Company Profile.
An object of this class can be obtained from Program object's getCompany() method. The object is immutable and reflects the state of the data when getCompany() was called.

Thread safety
Immutable and hence thread-safe

Nested Class Summary
static class Company.HandleSituation
          Indicates how certain error situations should be handled.
 
Constructor Summary
Company(DBLink parent)
           
 
Method Summary
 java.lang.String getAddress1()
          Gets the first line of the address.
 java.lang.String getAddress2()
          Gets the second line of the address.
 java.lang.String getAddress3()
          Gets the third line of the address.
 java.lang.String getAddress4()
          Gets the fourth line of the address.
 java.lang.String getBranchCode()
          Gets the branch code of the company
 java.lang.String getCity()
          Gets the city of the address.
 java.lang.String getContact()
          Gets the name of the contact person
 java.lang.String getCountry()
          Gets the country of the company.
 java.lang.String getCountryCode()
          Gets the country code of the company
 java.lang.String getFax()
          Gets the fax number
 int getFiscalPeriods()
          Gets the number of fiscal periods in a fiscal year.
 int getFourPeriodQuarter()
          Gets the quarter number with 4 periods, if the company uses 13 periods in a fiscal year.
 Company.HandleSituation getHandleInactiveGLAccounts()
          Gets a value indicating how inactive GL accounts should be handled.
 Company.HandleSituation getHandleLockedFiscalPeriods()
          Gets a value indicating how locked fiscal periods should be handled.
 Company.HandleSituation getHandleNonexistentGLAccounts()
          Gets a value indicating how nonexistent GL accounts should be handled.
 java.lang.String getHomeCurrency()
          Gets the home currency code of the company
 java.lang.String getLocationCode()
          Gets the location code
 java.lang.String getLocationType()
          Gets the location type
 java.lang.String getName()
          Gets the company name.
 java.lang.String getOrgID()
          Gets the organization ID of the company.
 java.lang.String getPhone()
          Gets the phone number
 java.lang.String getPhoneMask()
          Gets the display mask for the phone or fax number.
 java.lang.String getPostcode()
          Gets the zip code/postal code.
 java.lang.String getRateType()
          Gets the default rate type code
 java.lang.String getReportingCurrency()
          Gets the currency to include in financial reports, if the home currency is Euro.
 int getSessionWarnDays()
          Gets the maximum number of days a transaction date can deviate from the session date before the system should issue a warning.
 java.lang.String getState()
          Gets the state of the address.
 boolean isEuroCurrency()
          Gets a value indicating whether or not the home currency is a Euro currency.
 boolean isMulticurrency()
          Gets a value indicating whether or not the company is set up to use multicurrency.
 boolean isPhoneFormatted()
          Gets a value indicating whether or not the phone numbers should be formatted.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Company

public Company(DBLink parent)
Method Detail

getAddress1

public java.lang.String getAddress1()
Gets the first line of the address.


getAddress2

public java.lang.String getAddress2()
Gets the second line of the address.


getAddress3

public java.lang.String getAddress3()
Gets the third line of the address.


getAddress4

public java.lang.String getAddress4()
Gets the fourth line of the address.


getBranchCode

public java.lang.String getBranchCode()
Gets the branch code of the company


getCity

public java.lang.String getCity()
Gets the city of the address.


getContact

public java.lang.String getContact()
Gets the name of the contact person


getCountry

public java.lang.String getCountry()
Gets the country of the company.


getCountryCode

public java.lang.String getCountryCode()
Gets the country code of the company


getFax

public java.lang.String getFax()
Gets the fax number


getFiscalPeriods

public int getFiscalPeriods()
Gets the number of fiscal periods in a fiscal year.


getFourPeriodQuarter

public int getFourPeriodQuarter()
Gets the quarter number with 4 periods, if the company uses 13 periods in a fiscal year.


getHandleInactiveGLAccounts

public Company.HandleSituation getHandleInactiveGLAccounts()
Gets a value indicating how inactive GL accounts should be handled.


getHandleLockedFiscalPeriods

public Company.HandleSituation getHandleLockedFiscalPeriods()
Gets a value indicating how locked fiscal periods should be handled.


getHandleNonexistentGLAccounts

public Company.HandleSituation getHandleNonexistentGLAccounts()
Gets a value indicating how nonexistent GL accounts should be handled.


getHomeCurrency

public java.lang.String getHomeCurrency()
Gets the home currency code of the company


getLocationCode

public java.lang.String getLocationCode()
Gets the location code


getLocationType

public java.lang.String getLocationType()
Gets the location type


getName

public java.lang.String getName()
Gets the company name.


getOrgID

public java.lang.String getOrgID()
Gets the organization ID of the company.


getPhone

public java.lang.String getPhone()
Gets the phone number


getPhoneMask

public java.lang.String getPhoneMask()
Gets the display mask for the phone or fax number. This value is applicable only if getPhoneFormat() is true.


getPostcode

public java.lang.String getPostcode()
Gets the zip code/postal code.


getRateType

public java.lang.String getRateType()
Gets the default rate type code


getReportingCurrency

public java.lang.String getReportingCurrency()
Gets the currency to include in financial reports, if the home currency is Euro.
This is not applicable if the home currency is not Euro.


getSessionWarnDays

public int getSessionWarnDays()
Gets the maximum number of days a transaction date can deviate from the session date before the system should issue a warning.


getState

public java.lang.String getState()
Gets the state of the address.


isEuroCurrency

public boolean isEuroCurrency()
Gets a value indicating whether or not the home currency is a Euro currency.


isMulticurrency

public boolean isMulticurrency()
Gets a value indicating whether or not the company is set up to use multicurrency.


isPhoneFormatted

public boolean isPhoneFormatted()
Gets a value indicating whether or not the phone numbers should be formatted.
If this returns true, phone numbers should be formatted according to the mask returned by getPhoneMask().



Copyright © 2010 Sage Software, Inc. All rights reserved.