org.osid.relationship.rules

Interface RelationshipEnablerSmartFamilySession

All Superinterfaces:

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

public interface RelationshipEnablerSmartFamilySession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic families. A RelationshipEnablerQuery can be retrieved from this session and mapped to this Family to create a virtual collection of relationship enablers. The relationship enablers may be sequenced using the RelationshipEnablerSearchOrder from this session.

This Family has a default query that matches any relationship enabler and a default search order that specifies no sequencing. The queries may be examined using a RelationshipEnablerQueryInspector. The query may be modified by converting the inspector back to a RelationshipEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyRelationshipEnablerQuery(RelationshipEnablerQuery relationshipEnablerQuery) Applies a relationship enabler query to this family.
void	applyRelationshipEnablerSequencing(RelationshipEnablerSearchOrder relationshipEnablerSearchOrder) Applies a relationship enabler search order to this family.
boolean	canManageSmartFamilies() Tests if this user can manage smart families.
Family	getFamily() Gets the Family associated with this session.
Id	getFamilyId() Gets the Family Id associated with this session.
RelationshipEnablerQuery	getRelationshipEnablerQuery() Gets a relationship enabler query.
RelationshipEnablerQuery	getRelationshipEnablerQueryFromInspector(RelationshipEnablerQueryInspector relationshipEnablerQueryInspector) Gets a relationship enabler query from an inspector.
RelationshipEnablerSearchOrder	getRelationshipEnablerSearchOrder() Gets a relationship enabler search order.
RelationshipEnablerQueryInspector	inspectRelationshipEnablerQuery() Gets a relationship enabler query inspector for this family.

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

getFamilyId

Id getFamilyId()

Gets the Family Id associated with this session.

Returns:

the Family Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFamily

Family getFamily()
                 throws OperationFailedException,
                        PermissionDeniedException

Gets the Family associated with this session.

Returns:

the family

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartFamilies

boolean canManageSmartFamilies()

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

Compliance:

mandatory - This method must be implemented.

getRelationshipEnablerQuery

RelationshipEnablerQuery getRelationshipEnablerQuery()

Gets a relationship enabler query.

Returns:

the relationship enabler query

Compliance:

mandatory - This method must be implemented.

getRelationshipEnablerSearchOrder

RelationshipEnablerSearchOrder getRelationshipEnablerSearchOrder()

Gets a relationship enabler search order.

Returns:

the relationship enabler search order

Compliance:

mandatory - This method must be implemented.

applyRelationshipEnablerQuery

void applyRelationshipEnablerQuery(RelationshipEnablerQuery relationshipEnablerQuery)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Applies a relationship enabler query to this family.

Parameters:

relationshipEnablerQuery - the relationship enabler query

Throws:

NullArgumentException - relationshipEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - relationshipEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectRelationshipEnablerQuery

RelationshipEnablerQueryInspector inspectRelationshipEnablerQuery()
                                                                  throws OperationFailedException,
                                                                         PermissionDeniedException

Gets a relationship enabler query inspector for this family.

Returns:

the relationship enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyRelationshipEnablerSequencing

void applyRelationshipEnablerSequencing(RelationshipEnablerSearchOrder relationshipEnablerSearchOrder)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Applies a relationship enabler search order to this family.

Parameters:

relationshipEnablerSearchOrder - the relationship enabler search order

Throws:

NullArgumentException - relationshipEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - relationshipEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getRelationshipEnablerQueryFromInspector

RelationshipEnablerQuery getRelationshipEnablerQueryFromInspector(RelationshipEnablerQueryInspector relationshipEnablerQueryInspector)

Gets a relationship enabler query from an inspector.

Parameters:

relationshipEnablerQueryInspector - a relationship enabler query inspector

Returns:

the relationship enabler query

Throws:

NullArgumentException - relationshipEnablerQueryInspector is null

UnsupportedException - relationshipEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.