org.osid.financials.posting

Interface FinancialsPostingProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

FinancialsPostingManager, FinancialsPostingProxyManager

public interface FinancialsPostingProfile
extends OsidProfile

The financials profile describes the interoperability among financials management services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getPostEntryRecordTypes() Gets the supported PostEntry record types.
TypeList	getPostEntrySearchRecordTypes() Gets the supported PostEntry search record types.
TypeList	getPostRecordTypes() Gets the supported Post record types.
TypeList	getPostSearchRecordTypes() Gets the supported Post search record types.
boolean	supportsFinancialsPostingBatch() Tests if a posting batch service is available.
boolean	supportsPostAdmin() Tests if post administrative service is supported.
boolean	supportsPostBusiness() Tests if a post cataloging service is supported.
boolean	supportsPostBusinessAssignment() Tests if a post cataloging service is supported.
boolean	supportsPostEntryAdmin() Tests if post entry administrative service is supported.
boolean	supportsPostEntryBusiness() Tests if an post entry cataloging service is supported.
boolean	supportsPostEntryBusinessAssignment() Tests if an post entry cataloging service is supported.
boolean	supportsPostEntryLookup() Tests if looking up post entries is supported.
boolean	supportsPostEntryNotification() Tests if an entry notification service is supported.
boolean	supportsPostEntryQuery() Tests if querying post entries is supported.
boolean	supportsPostEntryRecordType(Type postEntryRecordType) Tests if the given PostEntry record type is supported.
boolean	supportsPostEntrySearch() Tests if searching post entries is supported.
boolean	supportsPostEntrySearchRecordType(Type postEntrySearchRecordType) Tests if the given PostEntry search record type is supported.
boolean	supportsPostEntrySmartBusiness() Tests if an post entry smart business session is available.
boolean	supportsPostLookup() Tests if looking up posts is supported.
boolean	supportsPostNotification() Tests if a post notification service is supported.
boolean	supportsPostQuery() Tests if querying posts is supported.
boolean	supportsPostRecordType(Type postRecordType) Tests if the given Post record type is supported.
boolean	supportsPostSearch() Tests if searching posts is supported.
boolean	supportsPostSearchRecordType(Type postSearchRecordType) Tests if the given Post search record type is supported.
boolean	supportsPostSmartBusiness() Tests if a post smart business session is available.
boolean	supportsVisibleFederation() Tests if any business federation is exposed.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

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:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPostLookup

boolean supportsPostLookup()

Tests if looking up posts is supported.

Returns:

true if post lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPostQuery

boolean supportsPostQuery()

Tests if querying posts is supported.

Returns:

true if post query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPostSearch

boolean supportsPostSearch()

Tests if searching posts is supported.

Returns:

true if post search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPostAdmin

boolean supportsPostAdmin()

Tests if post administrative service is supported.

Returns:

true if post administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPostNotification

boolean supportsPostNotification()

Tests if a post notification service is supported.

Returns:

true if post notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPostBusiness

boolean supportsPostBusiness()

Tests if a post cataloging service is supported.

Returns:

true if post catalog is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPostBusinessAssignment

boolean supportsPostBusinessAssignment()

Tests if a post cataloging service is supported. A cataloging service maps posts to catalogs.

Returns:

true if post cataloging is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPostSmartBusiness

boolean supportsPostSmartBusiness()

Tests if a post smart business session is available.

Returns:

true if a post smart business session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPostEntryLookup

boolean supportsPostEntryLookup()

Tests if looking up post entries is supported.

Returns:

true if post entry lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPostEntryQuery

boolean supportsPostEntryQuery()

Tests if querying post entries is supported.

Returns:

true if post entry query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPostEntrySearch

boolean supportsPostEntrySearch()

Tests if searching post entries is supported.

Returns:

true if post entry search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPostEntryAdmin

boolean supportsPostEntryAdmin()

Tests if post entry administrative service is supported.

Returns:

true if post entry administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPostEntryNotification

boolean supportsPostEntryNotification()

Tests if an entry notification service is supported.

Returns:

true if post entry notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPostEntryBusiness

boolean supportsPostEntryBusiness()

Tests if an post entry cataloging service is supported.

Returns:

true if post entry catalog is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPostEntryBusinessAssignment

boolean supportsPostEntryBusinessAssignment()

Tests if an post entry cataloging service is supported. A cataloging service maps post entries to catalogs.

Returns:

true if post entry cataloging is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsPostEntrySmartBusiness

boolean supportsPostEntrySmartBusiness()

Tests if an post entry smart business session is available.

Returns:

true if an post entry smart business session is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsFinancialsPostingBatch

boolean supportsFinancialsPostingBatch()

Tests if a posting batch service is available.

Returns:

true if a posting batch service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getPostRecordTypes

TypeList getPostRecordTypes()

Gets the supported Post record types.

Returns:

a list containing the supported Post record types

Compliance:

mandatory - This method must be implemented.

supportsPostRecordType

boolean supportsPostRecordType(Type postRecordType)

Tests if the given Post record type is supported.

Parameters:

postRecordType - a Type indicating an Post record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - postRecordType is null

Compliance:

mandatory - This method must be implemented.

getPostSearchRecordTypes

TypeList getPostSearchRecordTypes()

Gets the supported Post search record types.

Returns:

a list containing the supported Post search record types

Compliance:

mandatory - This method must be implemented.

supportsPostSearchRecordType

boolean supportsPostSearchRecordType(Type postSearchRecordType)

Tests if the given Post search record type is supported.

Parameters:

postSearchRecordType - a Type indicating an Post search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - postSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getPostEntryRecordTypes

TypeList getPostEntryRecordTypes()

Gets the supported PostEntry record types.

Returns:

a list containing the supported PostEntry record types

Compliance:

mandatory - This method must be implemented.

supportsPostEntryRecordType

boolean supportsPostEntryRecordType(Type postEntryRecordType)

Tests if the given PostEntry record type is supported.

Parameters:

postEntryRecordType - a Type indicating an PostEntry record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - postEntryRecordType is null

Compliance:

mandatory - This method must be implemented.

getPostEntrySearchRecordTypes

TypeList getPostEntrySearchRecordTypes()

Gets the supported PostEntry search record types.

Returns:

a list containing the supported PostEntry search record types

Compliance:

mandatory - This method must be implemented.

supportsPostEntrySearchRecordType

boolean supportsPostEntrySearchRecordType(Type postEntrySearchRecordType)

Tests if the given PostEntry search record type is supported.

Parameters:

postEntrySearchRecordType - a Type indicating an PostEntry search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - postEntrySearchRecordType is null

Compliance:

mandatory - This method must be implemented.