com.sage.accpac.sm
Interface Company

All Known Implementing Classes:

CompanyImpl

public interface Company

The Company interface 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.

Nested Class Summary

static class

Company.HandleSituation The HandleSituation enumeration indicates how certain error situations should be handled.

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.

Method Detail

getAddress1

java.lang.String getAddress1()

Gets the first line of the address.

Returns:

the first line of the address.

getAddress2

java.lang.String getAddress2()

Gets the second line of the address.

Returns:

the second line of the address.

getAddress3

java.lang.String getAddress3()

Gets the third line of the address.

Returns:

the third line of the address.

getAddress4

java.lang.String getAddress4()

Gets the fourth line of the address.

Returns:

the fourth line of the address.

getBranchCode

java.lang.String getBranchCode()

Gets the branch code of the company

Returns:

the branch code of the company

getCity

java.lang.String getCity()

Gets the city of the address.

Returns:

the city of the address.

getContact

java.lang.String getContact()

Gets the name of the contact person

Returns:

the name of the contact person

getCountry

java.lang.String getCountry()

Gets the country of the company.

Returns:

the country of the company.

getCountryCode

java.lang.String getCountryCode()

Gets the country code of the company

Returns:

the country code of the company

getFax

java.lang.String getFax()

Gets the fax number

Returns:

the fax number

getFiscalPeriods

int getFiscalPeriods()

Gets the number of fiscal periods in a fiscal year.

Returns:

the number of fiscal periods in a fiscal year.

getFourPeriodQuarter

int getFourPeriodQuarter()

Gets the quarter number with 4 periods, if the company uses 13 periods in a fiscal year.

If getFiscalPeriods() returns 12 then a value will still be returned but will be meaningless.

Returns:

the quarter number with 4 periods

getHandleInactiveGLAccounts

Company.HandleSituation getHandleInactiveGLAccounts()

Gets a value indicating how inactive GL accounts should be handled.

Returns:

how to handle inactive GL accounts

getHandleLockedFiscalPeriods

Company.HandleSituation getHandleLockedFiscalPeriods()

Gets a value indicating how locked fiscal periods should be handled.

Returns:

how to handle locked fiscal periods

getHandleNonexistentGLAccounts

Company.HandleSituation getHandleNonexistentGLAccounts()

Gets a value indicating how nonexistent GL accounts should be handled.

Returns:

how to handle nonexistant GL accounts

getHomeCurrency

java.lang.String getHomeCurrency()

Gets the home currency code of the company

Returns:

the home currency code of the company

getLocationCode

java.lang.String getLocationCode()

Gets the location code

Returns:

the location code

getLocationType

java.lang.String getLocationType()

Gets the location type

Returns:

the location type

getName

java.lang.String getName()

Gets the company name.

Returns:

the company name.

getOrgID

java.lang.String getOrgID()

Gets the organization ID of the company.

Returns:

the organization ID of the company.

getPhone

java.lang.String getPhone()

Gets the phone number

Returns:

the phone number

getPhoneMask

java.lang.String getPhoneMask()

Gets the display mask for the phone or fax number. This value is applicable only if isPhoneFormated() is true.

If isPhoneFormatted() returns false a value will still be returned.

Returns:

the display mask for the phone or fax number

getPostcode

java.lang.String getPostcode()

Gets the zip code/postal code.

Returns:

the zip code/postal code.

getRateType

java.lang.String getRateType()

Gets the default rate type code

Returns:

the default rate type code

getReportingCurrency

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.

If isEuroCurrency() returns false a value is still returned, but should not be used.

Returns:

the currency to include in financial reports

getSessionWarnDays

int getSessionWarnDays()

Gets the maximum number of days a transaction date can deviate from the session date before the system should issue a warning.

Returns:

the maximum number of days a transaction date can deviate

getState

java.lang.String getState()

Gets the state of the address.

Returns:

the state of the address.

isEuroCurrency

boolean isEuroCurrency()

Gets a value indicating whether or not the home currency is a Euro currency.

Returns:

true if, and only if, the home currency is a Euro currency.

isMulticurrency

boolean isMulticurrency()

Gets a value indicating whether or not the company is set up to use multicurrency.

Returns:

true if, and only if, the company is set up to use multicurrency.

isPhoneFormatted

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().

Returns:

true if, and only if, phone numbers should be formatted