Interface FinancialsBudgetingProfile
- All Superinterfaces:
OsidProfile, Sourceable
- All Known Subinterfaces:
FinancialsBudgetingManager, FinancialsBudgetingProxyManager
The financials profile describes the interoperability among financials management services.
-
Method Summary
Modifier and TypeMethodDescriptionGets the supportedBudgetEntryrecord types.Gets the supportedBudgetEntrysearch record types.Gets the supportedBudgetrecord types.Gets the supportedBudgetsearch record types.booleanTests if budget administrative service is supported.booleanTests if a budget cataloging service is supported.booleanTests if a budget cataloging service is supported.booleanTests if budget entry administrative service is supported.booleanTests if a budget entry cataloging service is supported.booleanTests if a budget entry cataloging service is supported.booleanTests if looking up budget entries is supported.booleanTests if an entry notification service is supported.booleanTests if querying budget entries is supported.booleansupportsBudgetEntryRecordType(Type budgetEntryRecordType) Tests if the givenBudgetEntryrecord type is supported.booleanTests if searching budget entries is supported.booleansupportsBudgetEntrySearchRecordType(Type budgetEntrySearchRecordType) Tests if the givenBudgetEntrysearch record type is supported.booleanTests if a budget entry smart business session is available.booleanTests if looking up budgets is supported.booleanTests if a budget notification service is supported.booleanTests if querying budgets is supported.booleansupportsBudgetRecordType(Type budgetRecordType) Tests if the givenBudgetrecord type is supported.booleanTests if searching budgets is supported.booleansupportsBudgetSearchRecordType(Type budgetSearchRecordType) Tests if the givenBudgetsearch record type is supported.booleanTests if a budget smart business session is available.booleanTests for the availability of a financials budgeting batch service.booleanTests if any business federation is exposed.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
supportsVisibleFederation
boolean supportsVisibleFederation()Tests if any business federation is exposed. Federation is exposed when a specific business may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of catalogs appears as a single catalog.- Returns:
trueif visible federation is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBudgetLookup
boolean supportsBudgetLookup()Tests if looking up budgets is supported.- Returns:
trueif budget lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBudgetQuery
boolean supportsBudgetQuery()Tests if querying budgets is supported.- Returns:
trueif budget query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBudgetSearch
boolean supportsBudgetSearch()Tests if searching budgets is supported.- Returns:
trueif budget search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBudgetAdmin
boolean supportsBudgetAdmin()Tests if budget administrative service is supported.- Returns:
trueif budget administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBudgetNotification
boolean supportsBudgetNotification()Tests if a budget notification service is supported.- Returns:
trueif budget notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBudgetBusiness
boolean supportsBudgetBusiness()Tests if a budget cataloging service is supported.- Returns:
trueif budget catalog is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBudgetBusinessAssignment
boolean supportsBudgetBusinessAssignment()Tests if a budget cataloging service is supported. A cataloging service maps budgets to catalogs.- Returns:
trueif budget cataloging is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBudgetSmartBusiness
boolean supportsBudgetSmartBusiness()Tests if a budget smart business session is available.- Returns:
trueif a budget smart business session is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBudgetEntryLookup
boolean supportsBudgetEntryLookup()Tests if looking up budget entries is supported.- Returns:
trueif budget entry lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBudgetEntryQuery
boolean supportsBudgetEntryQuery()Tests if querying budget entries is supported.- Returns:
trueif budget entry query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBudgetEntrySearch
boolean supportsBudgetEntrySearch()Tests if searching budget entries is supported.- Returns:
trueif budget entry search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBudgetEntryAdmin
boolean supportsBudgetEntryAdmin()Tests if budget entry administrative service is supported.- Returns:
trueif budget entry administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBudgetEntryNotification
boolean supportsBudgetEntryNotification()Tests if an entry notification service is supported.- Returns:
trueif budget entry notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBudgetEntryBusiness
boolean supportsBudgetEntryBusiness()Tests if a budget entry cataloging service is supported.- Returns:
trueif budget entry catalog is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBudgetEntryBusinessAssignment
boolean supportsBudgetEntryBusinessAssignment()Tests if a budget entry cataloging service is supported.- Returns:
trueif budget entry cataloging is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBudgetEntrySmartBusiness
boolean supportsBudgetEntrySmartBusiness()Tests if a budget entry smart business session is available.- Returns:
trueif a budget entry smart business session is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsFinancialsBudgetingBatch
boolean supportsFinancialsBudgetingBatch()Tests for the availability of a financials budgeting batch service.- Returns:
trueif a financials budgeting batch service is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getBudgetRecordTypes
TypeList getBudgetRecordTypes()Gets the supportedBudgetrecord types.- Returns:
- a list containing the supported
Budgetrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsBudgetRecordType
Tests if the givenBudgetrecord type is supported.- Parameters:
budgetRecordType- aTypeindicating aBudgetrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-budgetRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getBudgetSearchRecordTypes
TypeList getBudgetSearchRecordTypes()Gets the supportedBudgetsearch record types.- Returns:
- a list containing the supported
Budgetsearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsBudgetSearchRecordType
Tests if the givenBudgetsearch record type is supported.- Parameters:
budgetSearchRecordType- aTypeindicating aBudgetsearch record type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-budgetSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getBudgetEntryRecordTypes
TypeList getBudgetEntryRecordTypes()Gets the supportedBudgetEntryrecord types.- Returns:
- a list containing the supported
BudgetEntryrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsBudgetEntryRecordType
Tests if the givenBudgetEntryrecord type is supported.- Parameters:
budgetEntryRecordType- aTypeindicating aBudgetEntryrecord type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-budgetEntryRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getBudgetEntrySearchRecordTypes
TypeList getBudgetEntrySearchRecordTypes()Gets the supportedBudgetEntrysearch record types.- Returns:
- a list containing the supported
BudgetEntrysearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsBudgetEntrySearchRecordType
Tests if the givenBudgetEntrysearch record type is supported.- Parameters:
budgetEntrySearchRecordType- aTypeindicating aBudgetEntrysearch record type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-budgetEntrySearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-