org.osid.personnel

Interface OrganizationSmartRealmSession

All Superinterfaces:

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

public interface OrganizationSmartRealmSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. An OrganizationQuery can be retrieved from this session and mapped to this Realm to create a virtual collection of Organizations. The organizations may be sequenced using the OrganizationSearchOrder from this session.

This Realm has a default query that matches any organization and a default search order that specifies no sequencing. The queries may be examined using an OrganizationQueryInspector. The query may be modified by converting the inspector back to a n OrganizationQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyOrganizationQuery(OrganizationQuery organizationQuery) Applies an organization query to this realm.
void	applyOrganizationSequencing(OrganizationSearchOrder organizationSearchOrder) Applies an organization search order to this realm.
boolean	canManageSmartRealms() Tests if this user can manage smart realms.
OrganizationQuery	getOrganizationQuery() Gets an organization query.
OrganizationQuery	getOrganizationQueryFromInspector(OrganizationQueryInspector organizationQueryInspector) Gets an organization query from an inspector.
OrganizationSearchOrder	getOrganizationSearchOrder() Gets an organization search order.
Realm	getRealm() Gets the Realm associated with this session.
Id	getRealmId() Gets the Realm Id associated with this session.
OrganizationQueryInspector	inspectOrganizationQuery() Gets an organization query inspector for this realm.

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

getRealmId

Id getRealmId()

Gets the Realm Id associated with this session.

Returns:

the Realm Id associated with this session

Compliance:

mandatory - This method must be implemented.

getRealm

Realm getRealm()
               throws OperationFailedException,
                      PermissionDeniedException

Gets the Realm associated with this session.

Returns:

the Realm associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartRealms

boolean canManageSmartRealms()

Tests if this user can manage smart realms. 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 realm management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getOrganizationQuery

OrganizationQuery getOrganizationQuery()

Gets an organization query.

Returns:

the organization query

Compliance:

mandatory - This method must be implemented.

getOrganizationSearchOrder

OrganizationSearchOrder getOrganizationSearchOrder()

Gets an organization search order.

Returns:

the organization search order

Compliance:

mandatory - This method must be implemented.

applyOrganizationQuery

void applyOrganizationQuery(OrganizationQuery organizationQuery)
                            throws OperationFailedException,
                                   PermissionDeniedException

Applies an organization query to this realm.

Parameters:

organizationQuery - the organization query

Throws:

NullArgumentException - organizationQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - organizationQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectOrganizationQuery

OrganizationQueryInspector inspectOrganizationQuery()
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets an organization query inspector for this realm.

Returns:

the organization query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyOrganizationSequencing

void applyOrganizationSequencing(OrganizationSearchOrder organizationSearchOrder)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Applies an organization search order to this realm.

Parameters:

organizationSearchOrder - the organization search order

Throws:

NullArgumentException - organizationSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - organizationSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getOrganizationQueryFromInspector

OrganizationQuery getOrganizationQueryFromInspector(OrganizationQueryInspector organizationQueryInspector)

Gets an organization query from an inspector.

Parameters:

organizationQueryInspector - a query inspector

Returns:

the organization query

Throws:

NullArgumentException - organizationQueryInspector is null

UnsupportedException - organizationQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.