org.osid.profile

Interface ProfileEntrySmartProfileSession

All Superinterfaces:

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

public interface ProfileEntrySmartProfileSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A ProfileEntryQuery can be retrieved from this session and mapped to this Profile to create a virtual collection of profile entries. The profile entries may be sequenced using the ProfileEntrySearchOrder from this session.

This Profile has a default query that matches any profile Item and a default search order that specifies no sequencing. The queries may be examined using a ProfileEntryQueryInspector. The query may be modified by converting the inspector back to a ProfileEntryQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyProfileEntryQuery(ProfileEntryQuery profileEntryQuery) Applies a profile entry query to this profile.
void	applyProfileEntrySequencing(ProfileEntrySearchOrder profileEntrySearchOrder) Applies a profile entry search order to this profile.
boolean	canManageSmartProfiles() Tests if this user can manage smart profiles.
Profile	getProfile() Gets the Profile associated with this session.
ProfileEntryQuery	getProfileEntryQuery() Gets a profile entry query.
ProfileItemQuery	getProfileEntryQueryFromInspector(ProfileEntryQueryInspector profileEntryQueryInspector) Gets a profile entry query from an inspector.
ProfileEntrySearchOrder	getProfileEntrySearchOrder() Gets a profile entry search order.
Id	getProfileId() Gets the Profile Id associated with this session.
ProfileEntryQueryInspector	inspectProfileEntryQuery() Gets a profile entry query inspector for this profile.

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

getProfileId

Id getProfileId()

Gets the Profile Id associated with this session.

Returns:

the Profile Id associated with this session

Compliance:

mandatory - This method must be implemented.

getProfile

Profile getProfile()
                   throws OperationFailedException,
                          PermissionDeniedException

Gets the Profile associated with this session.

Returns:

the Profile associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartProfiles

boolean canManageSmartProfiles()

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

Compliance:

mandatory - This method must be implemented.

getProfileEntryQuery

ProfileEntryQuery getProfileEntryQuery()

Gets a profile entry query.

Returns:

the profile entry query

Compliance:

mandatory - This method must be implemented.

getProfileEntrySearchOrder

ProfileEntrySearchOrder getProfileEntrySearchOrder()

Gets a profile entry search order.

Returns:

the profile entry search order

Compliance:

mandatory - This method must be implemented.

applyProfileEntryQuery

void applyProfileEntryQuery(ProfileEntryQuery profileEntryQuery)
                            throws OperationFailedException,
                                   PermissionDeniedException

Applies a profile entry query to this profile.

Parameters:

profileEntryQuery - the profile entry query

Throws:

NullArgumentException - profileEntryQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - profileEntryQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectProfileEntryQuery

ProfileEntryQueryInspector inspectProfileEntryQuery()
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets a profile entry query inspector for this profile.

Returns:

the profile entry query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyProfileEntrySequencing

void applyProfileEntrySequencing(ProfileEntrySearchOrder profileEntrySearchOrder)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Applies a profile entry search order to this profile.

Parameters:

profileEntrySearchOrder - the profile entry search order

Throws:

NullArgumentException - profileEntrySearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - profileEntrySearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getProfileEntryQueryFromInspector

ProfileItemQuery getProfileEntryQueryFromInspector(ProfileEntryQueryInspector profileEntryQueryInspector)

Gets a profile entry query from an inspector.

Parameters:

profileEntryQueryInspector - a profile entry query inspector

Returns:

the profile entry query

Throws:

NullArgumentException - profileEntryQueryInspector is null

UnsupportedException - profileEntryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.