Interface FinancialsProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
FinancialsManager, FinancialsProxyManager
public interface FinancialsProfile extends OsidProfile

The financials profile describes the interoperability of financial services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if visible federation is supported.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAccountLookup

      boolean supportsAccountLookup()
      Tests if looking up accounts is supported.
      Returns:
      true if account lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAccountQuery

      boolean supportsAccountQuery()
      Tests if querying accounts is supported.
      Returns:
      true if account query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAccountSearch

      boolean supportsAccountSearch()
      Tests if searching accounts is supported.
      Returns:
      true if account search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAccountAdmin

      boolean supportsAccountAdmin()
      Tests if an account administrative service is supported.
      Returns:
      true if account administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAccountNotification

      boolean supportsAccountNotification()
      Tests if an account notification service is supported.
      Returns:
      true if account notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAccountHierarchy

      boolean supportsAccountHierarchy()
      Tests if an account hierarchy traversal is supported.
      Returns:
      true if an account hierarchy traversal is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAccountHierarchyDesign

      boolean supportsAccountHierarchyDesign()
      Tests if account hierarchy design is supported.
      Returns:
      true if an account hierarchy design is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAccountBusiness

      boolean supportsAccountBusiness()
      Tests if an account cataloging service is supported.
      Returns:
      true if account catalog is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAccountBusinessAssignment

      boolean supportsAccountBusinessAssignment()
      Tests if an account cataloging service is supported. A cataloging service maps accounts to catalogs.
      Returns:
      true if account cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsAccountSmartBusiness

      boolean supportsAccountSmartBusiness()
      Tests if an account smart business session is available.
      Returns:
      true if an account smart business session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityLookup

      boolean supportsActivityLookup()
      Tests if looking up activities is supported.
      Returns:
      true if activity lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityQuery

      boolean supportsActivityQuery()
      Tests if querying activities is supported.
      Returns:
      true if activity query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivitySearch

      boolean supportsActivitySearch()
      Tests if searching activities is supported.
      Returns:
      true if activity search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityAdmin

      boolean supportsActivityAdmin()
      Tests if activity administrative service is supported.
      Returns:
      true if activity administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityNotification

      boolean supportsActivityNotification()
      Tests if an activity notification service is supported.
      Returns:
      true if activity notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityHierarchy

      boolean supportsActivityHierarchy()
      Tests if an activity hierarchy traversal is supported.
      Returns:
      true if an activity hierarchy traversal is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityHierarchyDesign

      boolean supportsActivityHierarchyDesign()
      Tests if activity hierarchy design is supported.
      Returns:
      true if an activity hierarchy design is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityBusiness

      boolean supportsActivityBusiness()
      Tests if an activity cataloging service is supported.
      Returns:
      true if activity catalog is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityBusinessAssignment

      boolean supportsActivityBusinessAssignment()
      Tests if an activity cataloging service is supported. A cataloging service maps activities to catalogs.
      Returns:
      true if activity cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivitySmartBusiness

      boolean supportsActivitySmartBusiness()
      Tests if an activity smart business session is available.
      Returns:
      true if an activity smart business session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFiscalPeriodLookup

      boolean supportsFiscalPeriodLookup()
      Tests if looking up fiscal periods is supported.
      Returns:
      true if fiscal period lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFiscalPeriodQuery

      boolean supportsFiscalPeriodQuery()
      Tests if querying fiscal periods is supported.
      Returns:
      true if fiscal period query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFiscalPeriodSearch

      boolean supportsFiscalPeriodSearch()
      Tests if searching fiscal periods is supported.
      Returns:
      true if fiscal period search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFiscalPeriodAdmin

      boolean supportsFiscalPeriodAdmin()
      Tests if fiscal period administrative service is supported.
      Returns:
      true if fiscal period administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFiscalPeriodNotification

      boolean supportsFiscalPeriodNotification()
      Tests if a fiscal period notification service is supported.
      Returns:
      true if fiscal period notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFiscalPeriodBusiness

      boolean supportsFiscalPeriodBusiness()
      Tests if a fiscal period cataloging service is supported.
      Returns:
      true if fiscal period catalog is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFiscalPeriodBusinessAssignment

      boolean supportsFiscalPeriodBusinessAssignment()
      Tests if a fiscal period cataloging service is supported. A cataloging service maps fiscal periods to catalogs.
      Returns:
      true if fiscal period cataloging is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFiscalPeriodSmartBusiness

      boolean supportsFiscalPeriodSmartBusiness()
      Tests if a fiscal period smart business session is available.
      Returns:
      true if a fiscal period smart business session is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBusinessLookup

      boolean supportsBusinessLookup()
      Tests if looking up businesses is supported.
      Returns:
      true if business lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBusinessSearch

      boolean supportsBusinessSearch()
      Tests if searching businesses is supported.
      Returns:
      true if business search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBusinessQuery

      boolean supportsBusinessQuery()
      Tests if querying businesses is supported.
      Returns:
      true if business query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBusinessAdmin

      boolean supportsBusinessAdmin()
      Tests if business administrative service is supported.
      Returns:
      true if business administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBusinessNotification

      boolean supportsBusinessNotification()
      Tests if a business notification service is supported.
      Returns:
      true if business notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsBusinessHierarchy

      boolean supportsBusinessHierarchy()
      Tests for the availability of a business hierarchy traversal service.
      Returns:
      true if business hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsBusinessHierarchyDesign

      boolean supportsBusinessHierarchyDesign()
      Tests for the availability of a business hierarchy design service.
      Returns:
      true if business hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFinancialsBatch

      boolean supportsFinancialsBatch()
      Tests for the availability of a financials batch service.
      Returns:
      true if a financials batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFinancialsBudgeting

      boolean supportsFinancialsBudgeting()
      Tests for the availability of a financials budgeting service.
      Returns:
      true if a financials budgeting service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsFinancialsPosting

      boolean supportsFinancialsPosting()
      Tests for the availability of a financials postng service.
      Returns:
      true if a financials posting service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAccountRecordTypes

      TypeList getAccountRecordTypes()
      Gets the supported Account record types.
      Returns:
      a list containing the supported Account record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsAccountRecordType

      boolean supportsAccountRecordType(Type accountRecordType)
      Tests if the given Account record type is supported.
      Parameters:
      accountRecordType - a Type indicating an Account record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - accountRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getAccountSearchRecordTypes

      TypeList getAccountSearchRecordTypes()
      Gets the supported Account search record types.
      Returns:
      a list containing the supported Account search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsAccountSearchRecordType

      boolean supportsAccountSearchRecordType(Type accountSearchRecordType)
      Tests if the given Account search record type is supported.
      Parameters:
      accountSearchRecordType - a Type indicating an Account search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - accountSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getActivityRecordTypes

      TypeList getActivityRecordTypes()
      Gets the supported Activity record types.
      Returns:
      a list containing the supported Activity record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivityRecordType

      boolean supportsActivityRecordType(Type activityRecordType)
      Tests if the given Activity record type is supported.
      Parameters:
      activityRecordType - a Type indicating an Activity record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - activityRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getActivitySearchRecordTypes

      TypeList getActivitySearchRecordTypes()
      Gets the supported Activity search record types.
      Returns:
      a list containing the supported Activity search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsActivitySearchRecordType

      boolean supportsActivitySearchRecordType(Type activitySearchRecordType)
      Tests if the given Activity search record type is supported.
      Parameters:
      activitySearchRecordType - a Type indicating an Activity search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - activitySearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getFiscalPeriodRecordTypes

      TypeList getFiscalPeriodRecordTypes()
      Gets the supported FiscalPeriod record types.
      Returns:
      a list containing the supported FiscalPeriod record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsFiscalPeriodRecordType

      boolean supportsFiscalPeriodRecordType(Type fiscalPeriodRecordType)
      Tests if the given FiscalPeriod record type is supported.
      Parameters:
      fiscalPeriodRecordType - a Type indicating an FiscalPeriod record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - fiscalPeriodRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getFiscalPeriodSearchRecordTypes

      TypeList getFiscalPeriodSearchRecordTypes()
      Gets the supported FiscalPeriod search record types.
      Returns:
      a list containing the supported FiscalPeriod search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsFiscalPeriodSearchRecordType

      boolean supportsFiscalPeriodSearchRecordType(Type fiscalPeriodSearchRecordType)
      Tests if the given FiscalPeriod search record type is supported.
      Parameters:
      fiscalPeriodSearchRecordType - a Type indicating a FiscalPeriod search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - fiscalPeriodSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getSummaryRecordTypes

      TypeList getSummaryRecordTypes()
      Gets the supported Summary record types.
      Returns:
      a list containing the supported Summary record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsSummaryRecordType

      boolean supportsSummaryRecordType(Type summaryRecordType)
      Tests if the given Summary record type is supported.
      Parameters:
      summaryRecordType - a Type indicating a Summary record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - summaryRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getBusinessRecordTypes

      TypeList getBusinessRecordTypes()
      Gets the supported Business record types.
      Returns:
      a list containing the supported Business types
      Compliance:
      mandatory - This method must be implemented.

    • supportsBusinessRecordType

      boolean supportsBusinessRecordType(Type businessRecordType)
      Tests if the given Business record type is supported.
      Parameters:
      businessRecordType - a Type indicating an Business record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - businessRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getBusinessSearchRecordTypes

      TypeList getBusinessSearchRecordTypes()
      Gets the supported Business search record types.
      Returns:
      a list containing the supported Business search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsBusinessSearchRecordType

      boolean supportsBusinessSearchRecordType(Type businessSearchRecordType)
      Tests if the given Business search record type is supported.
      Parameters:
      businessSearchRecordType - a Type indicating an Business search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - businessSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.