org.osid.resourcing.rules

Interface AvailabilityEnablerSmartFoundrySession

All Superinterfaces:

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

public interface AvailabilityEnablerSmartFoundrySession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic foundries. an AvailabilityEnablerQuery can be retrieved from this session and mapped to this Foundry to create a virtual collection of availability enablers. The availability enabler may be sequenced using the AvailabilityEnablerSearchOrder from this session.

This Foundry has a default query that matches any availability enabler and a default search order that specifies no sequencing. The queries may be examined using an AvailabilityEnablerQueryInspector. The query may be modified by converting the inspector back to an AvailabilityEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyAvailabilityEnablerQuery(AvailabilityEnablerQuery availabilityEnablerQuery) Applies an availability enabler query to this foundry.
void	applyAvailabilityEnablerSequencing(AvailabilityEnablerSearchOrder availabilityEnablerSearchOrder) Applies an availability enabler search order to this foundry.
boolean	canManageSmartFoundries() Tests if this user can manage smart foundries.
AvailabilityEnablerQuery	getAvailabilityEnablerQuery() Gets an availability enabler query.
AvailabilityEnablerQuery	getAvailabilityEnablerQueryFromInspector(AvailabilityEnablerQueryInspector availabilityEnablerQueryInspector) Gets an availability enabler query from an inspector.
AvailabilityEnablerSearchOrder	getAvailabilityEnablerSearchOrder() Gets an availability enabler search order.
Foundry	getFoundry() Gets the Foundry associated with this session.
Id	getFoundryId() Gets the Foundry Id associated with this session.
AvailabilityEnablerQueryInspector	inspectAvailabilityEnablerQuery() Gets an availability enabler query inspector for this foundry.

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

getFoundryId

Id getFoundryId()

Gets the Foundry Id associated with this session.

Returns:

the Foundry Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFoundry

Foundry getFoundry()
                   throws OperationFailedException,
                          PermissionDeniedException

Gets the Foundry associated with this session.

Returns:

the foundry

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartFoundries

boolean canManageSmartFoundries()

Tests if this user can manage smart foundries. A return of true does not guarantee successful authorization. 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 foundry management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getAvailabilityEnablerQuery

AvailabilityEnablerQuery getAvailabilityEnablerQuery()

Gets an availability enabler query.

Returns:

the availability enabler query

Compliance:

mandatory - This method must be implemented.

getAvailabilityEnablerSearchOrder

AvailabilityEnablerSearchOrder getAvailabilityEnablerSearchOrder()

Gets an availability enabler search order.

Returns:

the availability enabler search order

Compliance:

mandatory - This method must be implemented.

applyAvailabilityEnablerQuery

void applyAvailabilityEnablerQuery(AvailabilityEnablerQuery availabilityEnablerQuery)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Applies an availability enabler query to this foundry.

Parameters:

availabilityEnablerQuery - the availability enabler query

Throws:

NullArgumentException - availabilityEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - availabilityEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectAvailabilityEnablerQuery

AvailabilityEnablerQueryInspector inspectAvailabilityEnablerQuery()
                                                                  throws OperationFailedException,
                                                                         PermissionDeniedException

Gets an availability enabler query inspector for this foundry.

Returns:

the availability enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyAvailabilityEnablerSequencing

void applyAvailabilityEnablerSequencing(AvailabilityEnablerSearchOrder availabilityEnablerSearchOrder)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Applies an availability enabler search order to this foundry.

Parameters:

availabilityEnablerSearchOrder - the availability enabler search order

Throws:

NullArgumentException - availabilityEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - availabilityEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getAvailabilityEnablerQueryFromInspector

AvailabilityEnablerQuery getAvailabilityEnablerQueryFromInspector(AvailabilityEnablerQueryInspector availabilityEnablerQueryInspector)

Gets an availability enabler query from an inspector.

Parameters:

availabilityEnablerQueryInspector - an availability enabler query inspector

Returns:

the availability enabler query

Throws:

NullArgumentException - availabilityEnablerQueryInspector is null

UnsupportedException - availabilityEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.