org.osid.billing

Interface CategorySmartBusinessSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface CategorySmartBusinessSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A CategoryQuery can be retrieved from this session and mapped to this CoursOfferingeCatalog to create a virtual collection of Categories. The categories may be sequenced using the CategorySearchOrder from this session.

This Business has a default query that matches any category and a default search order that specifies no sequencing. The queries may be examined using a CategoryQueryInspector. The query may be modified by converting the inspector back to a CategoryQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyCategoryQuery(CategoryQuery categoryQuery) Applies a category query to this business.
void	applyCategorySequencing(CategorySearchOrder categorySearchOrder) Applies a category search order to this business.
boolean	canManageSmartBusinesses() Tests if this user can manage smart businesses.
Business	getBusiness() Gets the Business associated with this session.
Id	getBusinessId() Gets the Business Id associated with this session.
CategoryQuery	getCategoryQuery() Gets a category query.
CategoryQuery	getCategoryQueryFromInspector(CategoryQueryInspector categoryQueryInspector) Gets a category query from an inspector.
CategorySearchOrder	getCategorySearchOrder() Gets a category search order.
CategoryQueryInspector	inspectCategoryQuery() Gets a category query inspector for this business.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getBusinessId

Id getBusinessId()

Gets the Business Id associated with this session.

Returns:

the Business Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBusiness

Business getBusiness()
                     throws OperationFailedException,
                            PermissionDeniedException

Gets the Business associated with this session.

Returns:

the business

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartBusinesses

boolean canManageSmartBusinesses()

Tests if this user can manage smart businesses. A return of true does not guarantee successful assessment. A return of false indicates that it is known methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer operations to unauthorized users.

Returns:

false if smart business management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getCategoryQuery

CategoryQuery getCategoryQuery()

Gets a category query.

Returns:

the category query

Compliance:

mandatory - This method must be implemented.

getCategorySearchOrder

CategorySearchOrder getCategorySearchOrder()

Gets a category search order.

Returns:

the category search order

Compliance:

mandatory - This method must be implemented.

applyCategoryQuery

void applyCategoryQuery(CategoryQuery categoryQuery)
                        throws OperationFailedException,
                               PermissionDeniedException

Applies a category query to this business.

Parameters:

categoryQuery - the category query

Throws:

NullArgumentException - categoryQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - categoryQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectCategoryQuery

CategoryQueryInspector inspectCategoryQuery()
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Gets a category query inspector for this business.

Returns:

the category query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyCategorySequencing

void applyCategorySequencing(CategorySearchOrder categorySearchOrder)
                             throws OperationFailedException,
                                    PermissionDeniedException

Applies a category search order to this business.

Parameters:

categorySearchOrder - the category search order

Throws:

NullArgumentException - categorySearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - categorySearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getCategoryQueryFromInspector

CategoryQuery getCategoryQueryFromInspector(CategoryQueryInspector categoryQueryInspector)

Gets a category query from an inspector.

Parameters:

categoryQueryInspector - a query inspector

Returns:

the category query

Throws:

NullArgumentException - categoryQueryInspector is null

UnsupportedException - categoryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.