org.osid.relationship.rules

Interface RelationshipEnablerLookupSession

All Superinterfaces:

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

public interface RelationshipEnablerLookupSession
extends OsidSession

This session provides methods for retrieving RelationshipEnablers.

This session defines views that offer differing behaviors when retrieving multiple objects.

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete set or is an error condition
• isolated family view: All relationship enabler methods in this session operate, retrieve and pertain to relationship enablers defined explicitly in the current family. Using an isolated view is useful for managing RelationshipEnablers with the RelationshipEnablerAdminSession.
• federated family view: All relationship enabler methods in this session operate, retrieve and pertain to all relationship enablers defined in this family and any other relationship enablers implicitly available in this family through family inheritence.
• active relationship enabler view: All relationship enabler lookup methods return active relationship enablers.
• any status relationship enabler view: Relationship enablers of any active or inactive status are returned from methods.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupRelationshipEnablers() Tests if this user can perform RelationshipEnablers lookups.
Family	getFamily() Gets the Family associated with this session.
Id	getFamilyId() Gets the Family Id associated with this session.
RelationshipEnabler	getRelationshipEnabler(Id relationshipEnablerId) Gets the RelationshipEnabler specified by its Id.
RelationshipEnablerList	getRelationshipEnablers() Gets all RelationshipEnablers.
RelationshipEnablerList	getRelationshipEnablersByGenusType(Type relationshipEnablerGenusType) Gets a RelationshipEnablerList corresponding to the given relationship enabler genus Type which does not include relationship enablers of genus types derived from the specified Type.
RelationshipEnablerList	getRelationshipEnablersByIds(IdList relationshipEnablerIds) Gets a RelationshipEnablerList corresponding to the given IdList.
RelationshipEnablerList	getRelationshipEnablersByParentGenusType(Type relationshipEnablerGenusType) Gets a RelationshipEnablerList corresponding to the given relationship enabler genus Type and include any additional relationship enablers with genus types derived from the specified Type.
RelationshipEnablerList	getRelationshipEnablersByRecordType(Type relationshipEnablerRecordType) Gets a RelationshipEnablerList containing the given relationship enabler record Type.
RelationshipEnablerList	getRelationshipEnablersOnDate(DateTime from, DateTime to) Gets a RelationshipEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent.
RelationshipEnablerList	getRelationshipEnablersOnDateWithAgent(Id agentId, DateTime from, DateTime to) Gets a RelationshipEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent.
void	useActiveRelationshipEnablerView() Only active relationship enablers are returned by methods in this session.
void	useAnyStatusRelationshipEnablerView() All active and insactive relationship enablers are returned by methods in this session.
void	useComparativeRelationshipEnablerView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	useFederatedFamilyView() Federates the view for methods in this session.
void	useIsolatedFamilyView() Isolates the view for methods in this session.
void	usePlenaryRelationshipEnablerView() A complete view of the RelationshipEnabler returns is desired.

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.

canLookupRelationshipEnablers

boolean canLookupRelationshipEnablers()

Tests if this user can perform RelationshipEnablers lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeRelationshipEnablerView

void useComparativeRelationshipEnablerView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryRelationshipEnablerView

void usePlenaryRelationshipEnablerView()

A complete view of the RelationshipEnabler returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

useFederatedFamilyView

void useFederatedFamilyView()

Federates the view for methods in this session. A federated view will include relationship enablers in families which are children of this family in the family hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedFamilyView

void useIsolatedFamilyView()

Isolates the view for methods in this session. An isolated view restricts lookups to this family only.

Compliance:

mandatory - This method is must be implemented.

useActiveRelationshipEnablerView

void useActiveRelationshipEnablerView()

Only active relationship enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyStatusRelationshipEnablerView

void useAnyStatusRelationshipEnablerView()

All active and insactive relationship enablers are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getRelationshipEnabler

RelationshipEnabler getRelationshipEnabler(Id relationshipEnablerId)
                                           throws NotFoundException,
                                                  OperationFailedException,
                                                  PermissionDeniedException

Gets the RelationshipEnabler specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned RelationshipEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a RelationshipEnabler and retained for compatibility. In active mode, relationship enablers are returned that are currently active in addition to being effective ib the given date range for the given agent. In any status mode, active and inactive relationship enablers are returned.

Parameters:

relationshipEnablerId - Id of the RelationshipEnabler

Returns:

the relationship enabler

Throws:

NotFoundException - relationshipEnablerId not found

NullArgumentException - relationshipEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method is must be implemented.

getRelationshipEnablersByIds

RelationshipEnablerList getRelationshipEnablersByIds(IdList relationshipEnablerIds)
                                                     throws NotFoundException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Gets a RelationshipEnablerList corresponding to the given IdList. In plenary mode, the returned list contains all of the relationship enablers specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible RelationshipEnablers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, relationship enablers are returned that are currently active in addition to being effective ib the given date range for the given agent. In any status mode, active and inactive relationship enablers are returned.

Parameters:

relationshipEnablerIds - the list of Ids to retrieve

Returns:

the returned RelationshipEnabler list

Throws:

NotFoundException - an Id was not found

NullArgumentException - relationshipEnablerIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelationshipEnablersByGenusType

RelationshipEnablerList getRelationshipEnablersByGenusType(Type relationshipEnablerGenusType)
                                                           throws OperationFailedException,
                                                                  PermissionDeniedException

Gets a RelationshipEnablerList corresponding to the given relationship enabler genus Type which does not include relationship enablers of genus types derived from the specified Type. In plenary mode, the returned list contains all known relationship enablers or an error results. Otherwise, the returned list may contain only those relationship enablers that are accessible through this session. In active mode, relationship enablers are returned that are currently active in addition to being effective ib the given date range for the given agent. In any status mode, active and inactive relationship enablers are returned.

Parameters:

relationshipEnablerGenusType - a relationship enabler genus type

Returns:

the returned RelationshipEnabler list

Throws:

NullArgumentException - relationshipEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelationshipEnablersByParentGenusType

RelationshipEnablerList getRelationshipEnablersByParentGenusType(Type relationshipEnablerGenusType)
                                                                 throws OperationFailedException,
                                                                        PermissionDeniedException

Gets a RelationshipEnablerList corresponding to the given relationship enabler genus Type and include any additional relationship enablers with genus types derived from the specified Type. In plenary mode, the returned list contains all known relationship enablers or an error results. Otherwise, the returned list may contain only those relationship enablers that are accessible through this session. In active mode, relationship enablers are returned that are currently active in addition to being effective ib the given date range for the given agent. In any status mode, active and inactive relationship enablers are returned.

Parameters:

relationshipEnablerGenusType - a relationship enabler genus type

Returns:

the returned RelationshipEnabler list

Throws:

NullArgumentException - relationshipEnablerGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelationshipEnablersByRecordType

RelationshipEnablerList getRelationshipEnablersByRecordType(Type relationshipEnablerRecordType)
                                                            throws OperationFailedException,
                                                                   PermissionDeniedException

Gets a RelationshipEnablerList containing the given relationship enabler record Type. In plenary mode, the returned list contains all known relationship enablers or an error results. Otherwise, the returned list may contain only those relationship enablers that are accessible through this session. In active mode, relationship enablers are returned that are currently active in addition to being effective ib the given date range for the given agent. In any status mode, active and inactive relationship enablers are returned.

Parameters:

relationshipEnablerRecordType - a relationship enabler record type

Returns:

the returned RelationshipEnabler list

Throws:

NullArgumentException - relationshipEnablerRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelationshipEnablersOnDate

RelationshipEnablerList getRelationshipEnablersOnDate(DateTime from,
                                                    DateTime to)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets a RelationshipEnablerList that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known relationship enablers or an error results. Otherwise, the returned list may contain only those relationship enablers that are accessible through this session. In active mode, relationship enablers are returned that are currently active in addition to being effective ib the given date range for the given agent. In any status mode, active and inactive relationship enablers are returned.

Parameters:

from - a start date

to - an end date

Returns:

the returned RelationshipEnabler list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelationshipEnablersOnDateWithAgent

RelationshipEnablerList getRelationshipEnablersOnDateWithAgent(Id agentId,
                                                             DateTime from,
                                                             DateTime to)
                                                               throws OperationFailedException,
                                                                      PermissionDeniedException

Gets a RelationshipEnablerList that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known relationship enablers or an error results. Otherwise, the returned list may contain only those relationship enablers that are accessible through this session. In active mode, relationship enablers are returned that are currently active in addition to being effective ib the given date range for the given agent. In any status mode, active and inactive relationship enablers are returned.

Parameters:

agentId - an agent Id

from - a start date

to - an end date

Returns:

the returned RelationshipEnabler list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - agentId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRelationshipEnablers

RelationshipEnablerList getRelationshipEnablers()
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets all RelationshipEnablers. In plenary mode, the returned list contains all known relationship enablers or an error results. Otherwise, the returned list may contain only those relationship enablers that are accessible through this session. In active mode, relationship enablers are returned that are currently active in addition to being effective ib the given date range for the given agent. In any status mode, active and inactive relationship enablers are returned.

Returns:

the returned RelationshipEnabler list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.